Accounts integrated to the channel apps i.e., multiple email accounts can be integrated to the Email channel.
Ticketing_ChannelAccount is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
appId |
string | Id of the channel app which the channel account belongs to. Allowed values are "Email","Facebook","Facebook","Twitter","WeChat","WeChat","WhatsApp" exc. |
originalAccountId |
string | Id of the channel account in original channel. |
name |
string | Name of the channel account. |
id |
guid | Id of channel account. |
isEnabled |
bool | Whether this channel account is enabled or not. |
avatarUrl |
string | Avatar URL of the channel account. |
screenName |
string | Display name. |
isBotEnabled |
bool | Whether this channel account supports bot or not. |
chatbotId |
guid | Id of chat bot. |
percentageToBotWhenOnline |
integer | Percentage of routing to bot when there are agents online. |
percentageToBotWhenOffline |
integer | Percentage of routing to bot when all agents are offline. |
isDefault |
bool | Whether the account is set as default email account or not. |
createdTime |
datetime | Time when the channel account is created. |
GET ticketing/channelAccounts
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "chatbot". |
An array of Ticketing_ChannelAccount
Sample Request:
Response:
HTTP/1.1 200 OK
GET ticketing/channelAccounts/{id}
Name | Type | In | Required | Description |
---|---|---|---|---|
include |
string | query | no | Allowed value is "chatbot". |
Sample Request:
Response:
HTTP/1.1 200 OK
POST ticketing/channelAccounts
Name | Type | In | Required | Description |
---|---|---|---|---|
appId |
string | body | yes | Id of the channel app which the channel account belongs to. Allowed values are "Email","Facebook","Facebook","Twitter","WeChat","WeChat","WhatsApp" exc. |
originalAccountId |
string | body | yes | Id of the channel account in original channel. |
name |
string | body | yes | Name of the channel account. |
isEnabled |
bool | body | yes | Whether this channel account is enabled or not. |
avatarUrl |
string | body | no | Avatar URL of the channel account. |
screenName |
string | body | yes | Display name. |
isBotEnabled |
bool | body | yes | Whether this channel account supports bot or not. |
chatbotId |
guid | body | no | Id of chat bot. |
percentageToBotWhenOnline |
integer | body | yes | Percentage of routing to bot when there are agents online. |
percentageToBotWhenOffline |
integer | body | yes | Percentage of routing to bot when all agents are offline. |
isDefault |
bool | body | yes | Whether the account is set as default email account or not. |
channelIdentity |
string | body | no | Identity metadata of channel account. |
accountExtInfo |
string | body | no | |
filter |
string | body | no | |
createdTime |
datetime | body | no | Time when the channel account is created. |
emailAccountInfo |
string | body | no | Email info. |
Sample Request:
Response:
HTTP/1.1 201 Created
POST ticketing/channelAccounts/{id}:disableBot
Sample Request:
Response:
HTTP/1.1 200 OK
POST ticketing/channelAccounts/{id}:enableBot
Sample Request:
Response:
HTTP/1.1 200 OK
PUT ticketing/channelAccounts/{id}
Name | Type | In | Required | Description |
---|---|---|---|---|
appId |
string | body | yes | Id of the channel app which the channel account belongs to. Allowed values are "Email","Facebook","Facebook","Twitter","WeChat","WeChat","WhatsApp" exc. |
originalAccountId |
string | body | yes | Id of the channel account in original channel. |
name |
string | body | yes | Name of the channel account. |
isEnabled |
bool | body | yes | Whether this channel account is enabled or not. |
avatarUrl |
string | body | no | Avatar URL of the channel account. |
screenName |
string | body | yes | Display name. |
isBotEnabled |
bool | body | yes | Whether this channel account supports bot or not. |
chatbotId |
guid | body | no | Id of chat bot. |
percentageToBotWhenOnline |
integer | body | yes | Percentage of routing to bot when there are agents online. |
percentageToBotWhenOffline |
integer | body | yes | Percentage of routing to bot when all agents are offline. |
isDefault |
bool | body | yes | Whether the account is set as default email account or not. |
channelIdentity |
string | body | no | Identity metadata of channel account. |
accountExtInfo |
string | body | no | |
filter |
string | body | no | |
createdTime |
datetime | body | no | Time when the channel account is created. |
emailAccountInfo |
string | body | no | Email info. |
Sample Request:
Response:
HTTP/1.1 200 OK
DELETE ticketing/channelAccounts/{id}
No Content
Sample Request:
Response:
HTTP/1.1 204 No Content