Channel

The Channel API handles methods to create and manage each CHannel of a Virtual Agent.

API SUBPATH: eva-channel

Pagination and Listings

Retrieves all existing channels of bot

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{pageName}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

pageName*string

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

Header parameters

Response

200400401403404409422500

Ok

Body

*/*

dataarray of ChannelListDataDTO (object)

List of bot's channel

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{pageName}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "data": [
    {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "channelType": {
        "name": "text",
        "image": "text",
        "channelClassification": {
          "name": "text"
        }
      },
      "createdAt": "2024-11-21T06:40:15.019Z",
      "deletable": false
    }
  ]
}

Retrieves all existing channel types of bot, and aggregated within them each instance of channel using it in the same bot.

GET/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/dashboard

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Header parameters

Response

200400401403404409422500

Ok

Body

*/*

idinteger (int64)

The channel type's id

namestring

The channel type's name

imagestring

The channel type's image name

channelClassificationChannelClassificationDTO (object)

Information about the channel's classification

channelsFromTypearray of ChannelDTO (object)

A list of all channels in this bot that belong to this channel type.

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/dashboard', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

[
  {
    "name": "text",
    "image": "text",
    "channelClassification": {
      "name": "text"
    },
    "channelsFromType": [
      {
        "uuid": "text",
        "name": "text"
      }
    ]
  }
]

CRUD Operations

Because both the listing at the flow tree and the pagination persist in the screen for a long period of time, the listing methods retrieve full information and should be locally stored to handle their data, rather than continuously requesting for each channel's data on a nominal GET info method.

Saves all channels associated with a object referenced within ChannelCreatedDTO.

POST/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

Header parameters

Body

application/json

name*string

Name of the channel

descriptionstring

Description of the channel

typeId*integer (int64)

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

Response

201400401403404409422500

Created

Body

*/*

uuidstring

Channel's uuid

botUuidstring

Channel's uuid of bot

namestring

Channel's name

descriptionstring

Channel's description

channelTypeChannelTypeDTO (object)

Information about the channel's type

createdAtstring (date-time)

Channel's date of creation

updatedAtstring (date-time)

Channel's date of update

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

201400401403404409422500

{
  "uuid": "text",
  "botUuid": "text",
  "name": "text",
  "description": "text",
  "channelType": {
    "name": "text",
    "image": "text",
    "channelClassification": {
      "name": "text"
    }
  },
  "createdAt": "2024-11-21T06:40:15.019Z",
  "updatedAt": "2024-11-21T06:40:15.019Z"
}

Update all channels associated with a object referenced within ChannelUpdatedDTO and channelUUID.

PUT/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

channelUUID*string

A valid channel uuid for update

Header parameters

Body

application/json

name*string

Name of the channel

descriptionstring

Description of the channel

Response

200400401403404409422500

Ok

Body

*/*

codestring

Return the text: 'resource.updated'

messagestring

Return the text: 'This resource is updated'

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200400401403404409422500

{
  "code": "text",
  "message": "text"
}

Delete all channels associated with a channelUUID.

DELETE/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

botUUID*string

A valid bot Uuid

channelUUID*string

A valid channel uuid for deleted

Header parameters

Response

204400401403404409422500

No Content

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409422500

{
  "errorCode": "text",
  "errorType": "API_ERROR",
  "message": "text",
  "path": "text"
}

Auxiliary Methods

The following method lists all currently available channel types to be created on a Create method.

Retrieves all existing type channels.

GET/org/{orgUUID}/env/{envUUID}/channels/type

Path parameters

orgUUID*string

A valid organization Uuid

envUUID*string

A valid environment Uuid

Header parameters

Response

200400401403404409422500

Ok

Body

*/*

groupChannelarray of GroupDTO (object)

Channel group type

Request

JavaScriptCurlPython

const response = await fetch('/org/{orgUUID}/env/{envUUID}/channels/type', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409422500

{
  "groupChannel": [
    {
      "groupName": "text",
      "channels": [
        {
          "classificationId": "text",
          "name": "text",
          "imageTitle": "text",
          "imagePath": "text"
        }
      ]
    }
  ]
}