Skip to content
Conversation APIs
/
Conversation Manager
/
/Channel

Channel

Use this API to register and define channel parameters which is used for chat messages.

Operations

Create Channel

Request

Overview

Use this API to register and define custom channel parameters in the Conversation Manager which is used for chat messages. New Account API process flow: Authenticiation > Client Application > Participant > Channel > Orchestration > Account

Note: You can configure your system to use third party Channels. The API instructions provided here assume you are using eGain's application setup.

Scope

Client application must have 'app.conversation.conversationmgr.manage' scope assigned.

Security
oAuthClient(Required scopes:
https://api.egain.cloud/auth/.de...
)
Bodyapplication/json

Register new custom channel

typestring, [ 1 .. 255 ] charactersrequired

Unique channel type. Do not prefix with 'custom.' for channels supported by eGain.

Example:"custom.teams"
displayNamestring, [ 1 .. 255 ] charactersrequired
Example:"Teams"
iconstring, [ 1 .. 512000 ] charactersrequired

base64 encoded image. This icon is used in eGain Chat Advisor desktop for activities of this channel. If eGain Chat is used for live agents then use icon file in ‘png’ format with pixel dimensions 32 X 32.

descriptionstring, [ 1 .. 1023 ] characters
activeboolean
Default:true
restrictionsobject(Restrictions)

Channel restriction on inbound(from customer) and outbound( to customer) messages.

l10nPropertiesArray of objects, [ 1 .. 25 ] items(L10nProperties)
POST
/channels
curl -i -X POST \
  https://api.egain.cloud/conversation/conversationmgr/v3/channels \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "custom_channel",
    "icon": "<base64>",
    "displayName": "Custom Channel",
    "description": "Custom Channel",
    "active": true,
    "restrictions": {
      "inbound": {
        "maxTextLength": 140,
        "features": [
          "typing_events",
          "attachments",
          "richText"
        ],
        "attachmentPolicy": {
          "enabled": true,
          "maxSize": 12345,
          "type": "block",
          "extensions": [
            "bat",
            "exe"
          ]
        }
      },
      "outbound": {
        "maxTextLength": 140,
        "systemMessages": true,
        "midChatAuth": true,
        "features": [
          "typing_events",
          "attachments",
          "richText"
        ],
        "richMessageTypes": [
          "listpicker",
          "quickreply",
          "timepicker",
          "richlink"
        ],
        "attachmentPolicy": {
          "enabled": true,
          "maxSize": 12345,
          "type": "allow",
          "extensions": [
            "jpeg",
            "txt"
          ]
        }
      }
    },
    "l10nProperties": [
      {
        "language": "en-US",
        "properties": [
          {
            "name": "msg_hub_retain_and_retry",
            "value": "Thank you for reaching out. We will respond to you at the earliest."
          },
          {
            "name": "msg_hub_off_hours",
            "value": "Thank you for your inquiry. Our service hours are 9am-5pm PST, Monday-Friday. If you are trying within the service hours and still getting this message, please try again after some time."
          },
          {
            "name": "msg_hub_invalid_content_type_to_customer",
            "value": "This content type is not currently supported."
          },
          {
            "name": "msg_hub_invalid_content_type_to_agent",
            "value": "This content type is not currently supported."
          },
          {
            "name": "msg_hub_channel_msg_failed",
            "value": "Message could not be delivered. Please try again after some time."
          },
          {
            "name": "msg_hub_blocked_file_extension",
            "value": "Attachment file type '\''{0}'\'' is not allowed."
          },
          {
            "name": "msg_hub_attachment_size_exceeds_limit",
            "value": "File could not be sent. It exceeded the maximum limit of {0}"
          }
        ]
      }
    ]
  }'

Responses

Created

Bodyapplication/json
idstring, = 36 characters

UUID generated for the object.

Response
{
  "id": "45a095f4-d0ee-4220-a689-22b541c58f67"
}