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

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

pageNamestringrequired

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

x-request-idstringoptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{pageName}'

200

400

401

403

404

409

422

500

200

{
  "data": [
    {
      "uuid": "text",
      "name": "text",
      "description": "text",
      "channelType": {
        "id": 1,
        "name": "text",
        "image": "text",
        "channelClassification": {
          "id": 1,
          "name": "text"
        }
      },
      "createdAt": "2025-04-02T06:37:44.231Z",
      "deletable": true
    }
  ]
}

Ok

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

get

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Header parameters

x-request-idstringoptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/dashboard'

200

400

401

403

404

409

422

500

200

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

Ok

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

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

Header parameters

x-request-idstringoptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

namestringrequired

Name of the channel

descriptionstringoptional

Description of the channel

typeIdinteger · int64required

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

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "typeId": 1
  }'

201

400

401

403

404

409

422

500

201

{
  "uuid": "text",
  "botUuid": "text",
  "name": "text",
  "description": "text",
  "channelType": {
    "id": 1,
    "name": "text",
    "image": "text",
    "channelClassification": {
      "id": 1,
      "name": "text"
    }
  },
  "createdAt": "2025-04-02T06:37:44.231Z",
  "updatedAt": "2025-04-02T06:37:44.231Z"
}

Created

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

put

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

channelUUIDstringrequired

A valid channel uuid for update

Header parameters

x-request-idstringoptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Body

namestringrequired

Name of the channel

descriptionstringoptional

Description of the channel

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text"
  }'

200

400

401

403

404

409

422

500

200

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

Ok

Delete all channels associated with a channelUUID.

delete

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

botUUIDstringrequired

A valid bot Uuid

channelUUIDstringrequired

A valid channel uuid for deleted

Header parameters

x-request-idstringoptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/org/{orgUUID}/env/{envUUID}/bot/{botUUID}/channels/{channelUUID}'

204

400

401

403

404

409

422

500

204

No body

No Content

Auxiliary Methods

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

Retrieves all existing type channels.

get

Path parameters

orgUUIDstringrequired

A valid organization Uuid

envUUIDstringrequired

A valid environment Uuid

Header parameters

x-request-idstringoptional

It is an identifier provided by the API client that will be used to identify distributed logs.

Responses

*/*

*/*

*/*

*/*

*/*

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/org/{orgUUID}/env/{envUUID}/channels/type'

200

400

401

403

404

409

422

500

200

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

Ok