COMM100 RESTFUL API
Introduction
LiveChat Agent Private Message Android Push Audio & Video Chat Auto Distribution Campaign Chat Custom Variable Custom Variable Config Dynamic Campaign Installation Integration Calendly IOS Push LiveChat_BannedIp LiveChat_BannedVisitor LiveChat_CampaignAutoInvitation LiveChat_ConversionAction LiveChat_Field LiveChat_Segment LiveChat_Shift LiveChat_Wrap-Up Field Offline Message SecureForm_Label Segment Config Shift Config Visitor History Visitor Single Sign-On (SSO) Webhook Wrapup Category Config Chat Server Real Time
Ticketing Agent Preference Auto Distribution Channel Channel App Channel Contact Identity Type Draft Event log Field Mapping Junk Message Note Operating Hours & Holidays Routing Config Tag Ticket Ticket Recycle Bin Ticketing_BlockedSender Ticketing_ChannelAccount Ticketing_Field Ticketing_Holiday Ticketing_SLAPolicy Ticketing_Trigger View
Bot Agent Assist Learning Question Bot_AgentAssistSynonym Bot_Chatbot Bot_ChatbotCannedQuickReply Bot_ChatbotEntity Bot_ChatbotIntentCategory Bot_ChatbotSmartTrigger Bot_Taskbot Chatbot Intent Chatbot Intent Answer Chatbot Intent Question Chatbot Learning Question Chatbot Message When A Visitor Start A Chat Chatbot Message When Not Helpful Chatbot Message When Providing Possible Answer Chatbot No Answer Message Level2Menu_AgentAssist Prebuilt Entity Taskbot Booked Calendly Meeting Taskbot Version
KB KnowledgeBase_Article KnowledgeBase_Category KnowledgeBase_CustomPage KnowledgeBase_Design KnowledgeBase_Image KnowledgeBase_KnowledgeBase KnowledgeBase_Tag Preview
Global Action Type Agent Agent Single Sign-On Config Audit Log Auto Translation Contact Contact identity Credit Card Masking Config Custom Agent Away Status Config Department Config Global_AgentAwayStatus Global_Loginipallowlist Global_PrivateCannedMessage Global_PrivateCannedMessageCategory Global_PublicCannedMessage Global_PublicCannedMessageCategory Global_Role Global_Skills LiveChat_Department Login IP Allowlist Config Module Password Policy Config Permission Restricted Words Config Role Config Site Profile SkillConfig System Avatar Visitor
Reporting Cube Report
Visitor Side JavaScript API Agent Console JavaScript API
Global_AgentAwayStatus

You need Manage Custom Away Status permission to manage Custom Away Status.

Custom Agent Away Statuses
- Custom Agent Away Statuses Manage
GET global/agentAwayStatuses
- Get the list of Custom Agent Away Statuses
GET global/agentAwayStatuses/{id}
- Get a single Global_AgentAwayStatus
POST global/agentAwayStatuses
- Create a new Global_AgentAwayStatus
PUT global/agentAwayStatuses/{id}
- Update the Global_AgentAwayStatus
DELETE global/agentAwayStatuses/{id}
- Remove the Global_AgentAwayStatus
Model
Global_AgentAwayStatus JSON Format

Global_AgentAwayStatus is represented as simple flat JSON objects with the following keys:

Name Type Description
id guid Id of the custom away status.
name string Name of the custom away status.
order integer Order of the custom away status.
isSystem bool Whether the custom away status is system or not.
Endpoint
Get the list of Custom Agent Away Statuses

GET global/agentAwayStatuses

Parameters:
No Parameters
Response:

An array of   Global_AgentAwayStatus

Example

Sample Request:

curl https://api15.comm100.io/v4/global/agentAwayStatuses \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

[{"id":"5827eacf-c08e-4eb9-b09c-00155d081d0b","name":"Away","order":0,"isSystem":true}]
Get a single Global_AgentAwayStatus

GET global/agentAwayStatuses/{id}

Parameters:
No Parameters
Response:

Global_AgentAwayStatus

Example

Sample Request:

curl https://api15.comm100.io/v4/global/agentAwayStatuses/5827eacf-c08e-4eb9-b09c-00155d081d0b \
-X 'GET' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 200 OK

{"id":"5827eacf-c08e-4eb9-b09c-00155d081d0b","name":"Away","order":0,"isSystem":true}
Create a new Global_AgentAwayStatus

POST global/agentAwayStatuses

Parameters:
Name Type In Required Description
name string body yes Name of the custom away status.
order integer body no Order of the custom away status.
isSystem bool body no Whether the custom away status is system or not.
Response:

Global_AgentAwayStatus

Example

Sample Request:

curl https://api15.comm100.io/v4/global/agentAwayStatuses \
-X 'POST' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"name":"Away","order":0,"isSystem":true}'

Response:

 HTTP/1.1 201 Created

{"id":"5827eacf-c08e-4eb9-b09c-00155d081d0b","name":"Away","order":0,"isSystem":true}
Update the Global_AgentAwayStatus

PUT global/agentAwayStatuses/{id}

Parameters:
Name Type In Required Description
name string body yes Name of the custom away status.
order integer body no Order of the custom away status.
isSystem bool body no Whether the custom away status is system or not.
Response:

Global_AgentAwayStatus

Example

Sample Request:

curl https://api15.comm100.io/v4/global/agentAwayStatuses/5827eacf-c08e-4eb9-b09c-00155d081d0b \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"name":"Away","order":0,"isSystem":true}'

Response:

 HTTP/1.1 200 OK

{"id":"5827eacf-c08e-4eb9-b09c-00155d081d0b","name":"Away","order":0,"isSystem":true}
Remove the Global_AgentAwayStatus

DELETE global/agentAwayStatuses/{id}

Parameters:
No Parameters
Response:

No Content

Example

Sample Request:

curl https://api15.comm100.io/v4/global/agentAwayStatuses/5827eacf-c08e-4eb9-b09c-00155d081d0b \
-X 'DELETE' \
-H 'Authorization: Bearer {access_token}' \

Response:

 HTTP/1.1 204 No Content

© 2021 | Comm100