Channel API

Channel API is an API for channel management and bot deployment.

Authorization

Issue a unified token in the API access section. Specify it as a bearer token in your requests.

Methods

You can view all methods in the specifications:

• Bot channel API:

  • Manage inbound and phone channels: get, create, update, and delete.
  • Deploy the bot to any channel.

• Operator channel API. Manage channels for customer engagement platforms: get, create, update, and delete.

Deploy and check status

Bot deployment to a channel can take a long time. With Channel API, you can start the deployment and check its status:

1. Start a deployment to a channel using the POST /api/v1/async/bot-channels/deploy method. In the response, the method will return requestId: it is the identifier of your deployment request.

2. Check the deployment status using GET /api/v1/async/events. Specify requestId in the request.

3. If the deployment is completed successfully, the response contains isOk: true.

   {
     "response": [
       {
         "isOk": true,
         "requestId": "request-id-example",
         …
       }
     ]
   }