Channel
Ticket channel info.
Channels
- Channels Manage
GET channelapp/appchannels
GET channelapp/appchannels/{id}
Model
Channel JSON Format
Channel is represented as simple flat JSON objects with the following keys:
Name | Type | Description |
---|---|---|
contactIdentityTypeId |
string | Id of contact identity type. Allowed values are "Email","Facebook","Internal","SMS","SSOId","","Twitter","Visitor","WeChat","WhatsApp" etc. |
MessageDisplayType |
string | Display type of the message. Allowed values are "FlatView", "TreeView", "EmailView". |
OutgoingMessageMaxLength |
integer | Maximum words of the channel message. |
OutgoingMessageCapability |
integer | Message types are supported by the channel. |
IfAllowActiveReply |
bool | Whether allow agent reply with the channel to a different channel message. |
IfSupportDiffAccountReply |
bool | Whether the channel supports different account to reply a message or not. |
IfAllowActiveCreation |
bool | Whether allow agent create new ticket with the channel. |
IfDisplaySubject |
bool | Whether the channel supports subject or not. |
IfDisplayContact |
bool | Whether the channel supports contact or not. |
IfDisplayCc |
bool | Whether the channel supports CC or not. |
IfDisplayToolbarOfEditor |
bool | Whether the channel supports toolbar fo the editor or not. |
IfDisplayAttachment |
bool | Whether the channel supports attachment or not. |
IfDisplayChannelAccount |
bool | Whether the channel supports channel account or not. |
IfEnableFullScreenReply |
bool | Whether the channel supports full screen reply or not. |
IfHasNote |
bool | Whether the channel supports note or not. |
IfEnableSaveAsDraft |
bool | Whether the channel supports draft or not. |
IfAllowAtFeature |
bool | Whether the channel supports mention or not. |
IfSupportBot |
bool | Whether the channel supports bot or not. |
id |
string | Id of the channel. |
Name |
string | Name of the channel. |
appId |
string | Id of the app which the channel belongs to. |
ifCanReplyToVisitor |
bool | |
ifSynchronizeNotificationResult |
bool | |
ifCanMergeTicketByAgent |
bool | |
ifCanChangeContactByAgent |
bool | |
ifCanCreateContactByAgent |
bool | |
contactIdentityType |
contactIdentityType | Reference to ContactIdentityType. |
Endpoint
Get the list of Channels
GET channelapp/appchannels
Example
Sample Request:
curl https://api11.comm100.io/v4/channelapp/appchannels \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK
Get a single Channel
GET channelapp/appchannels/{id}
Example
Sample Request:
curl https://api11.comm100.io/v4/channelapp/appchannels/Chat \
-X
'GET'
\
-H
'Authorization: Bearer {access_token}'
\
Response:
HTTP/1.1 200 OK