Channel
The Channel API handles methods to create and manage each CHannel of a Virtual Agent.
Pagination and Listings
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
This parameter is a condition to return the channel All. Parameter that filters the channel all, when its value is 'channels' the channel all will not be returned
It is an identifier provided by the API client that will be used to identify distributed logs.
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{pageName} HTTP/1.1
Host:
Accept: */*
{
"data": [
{
"uuid": "text",
"name": "text",
"description": "text",
"channelType": {
"id": 1,
"name": "text",
"image": "text",
"channelClassification": {
"id": 1,
"name": "text"
}
},
"createdAt": "2025-07-01T01:45:40.984Z",
"deletable": true
}
]
}Retrieves all existing channel types of bot, and aggregated within them each instance of channel using it in the same bot.
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
It is an identifier provided by the API client that will be used to identify distributed logs.
GET /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/dashboard HTTP/1.1
Host:
Accept: */*
[
{
"id": 1,
"name": "text",
"image": "text",
"channelClassification": {
"id": 1,
"name": "text"
},
"channelsFromType": [
{
"uuid": "text",
"name": "text"
}
]
}
]CRUD Operations
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
It is an identifier provided by the API client that will be used to identify distributed logs.
A body containing a List of ChannelInsertRequestDTO. Refer to the model for instructions on how to build them.
Name of the channel
Description of the channel
Type of the channel. Types: 1 - Amazon Echo, 2 - Google Home, 4 - Jibo, 5 - Alexa, 6 - Cortana, 7 - Google Assistant, 8 - Siri, 9 - Facebook, 10 - RCS, 11 - SMS, 12 - Skype, 13 - ARCore, 14 - ARKit, 15 - Android, 16 - iOS, 17 - IVR, 18 - VR, 19 - Web, 20 - Web Mobile, 21 - App Mobile, 22 - WhatsApp, 24 - Skype for Business, 25 - Telegram, 26 - Twitter, 27 - WhatsApp (Infobip), 28 - HTC Vive, 29 - Oculus Rift, 30 - Oculus Go, 31 - Samsung Gear VR, 32 - Hololens, 33 - Apple Business Chat, 34 - Microsoft Teams
POST /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 47
{
"name": "text",
"description": "text",
"typeId": 1
}{
"uuid": "text",
"botUuid": "text",
"name": "text",
"description": "text",
"channelType": {
"id": 1,
"name": "text",
"image": "text",
"channelClassification": {
"id": 1,
"name": "text"
}
},
"createdAt": "2025-07-01T01:45:40.984Z",
"updatedAt": "2025-07-01T01:45:40.984Z"
}Update all channels associated with a object referenced within ChannelUpdatedDTO and channelUUID.
A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid channel uuid for update
It is an identifier provided by the API client that will be used to identify distributed logs.
A body containing a List of ChannelUpdatedDTO. Refer to the model for instructions on how to build them.
Name of the channel
Description of the channel
PUT /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"name": "text",
"description": "text"
}{
"code": "text",
"message": "text"
}A valid organization Uuid
A valid environment Uuid
A valid bot Uuid
A valid channel uuid for deleted
It is an identifier provided by the API client that will be used to identify distributed logs.
DELETE /org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID} HTTP/1.1
Host:
Accept: */*
No content
Auxiliary Methods
The following method lists all currently available channel types to be created on a Create method.
A valid organization Uuid
A valid environment Uuid
It is an identifier provided by the API client that will be used to identify distributed logs.
GET /org/{orgUUID}/env/{envUUID}/channels/type HTTP/1.1
Host:
Accept: */*
{
"groupChannel": [
{
"group": 1,
"groupName": "text",
"channels": [
{
"id": 1,
"classificationId": "text",
"name": "text",
"imageTitle": "text",
"imagePath": "text"
}
]
}
]
}Was this helpful?