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
Android Push

You need the Manage Settings permission to manage Android Push.

Android Push
- Android Push Manage
GET livechat/androidPush
- Get a single Android Push
PUT livechat/androidPush
- Update the Android Push
Model
Android Push JSON Format

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

Name Type Description
androidType string Allowed values are "fcm", "thirdParty".
androidFCMAPIKey string Android fcm API key,mandatory when androidType is fcm.
androidThirdPartyURL string Android third party URL,mandatory when androidType is thirdParty.
androidThirdPartyRequestBody string Android third party request body,mandatory when androidType is thirdParty.
androidPushFcmExtraData androidPushFcmExtraData[] Reference to Android Push Fcm Extra Data.
androidPushThirdPartyRequestHeaders androidPushThirdPartyRequestHeaders[] Reference to Android Push Third Party Request Header.

Android Push Fcm Extra Data JSON Format:

Name Type Description
id guid Id of the Android push FCM extra data.
field string Field name of this Android FCM extra data.
content string Content of this Android FCM extra data.

Android Push Third Party Request Header JSON Format:

Name Type Description
id guid Id of the Android push third party request header.
field string Field name of this third party request header.
content string Content of this third party request header.
Endpoint
Get a single Android Push

GET livechat/androidPush

Parameters:
Name Type In Required Description
include string query no Allowed values are "androidPushFcmExtraData", "androidPushThirdPartyRequestHeader".
Response:

Android Push

Example

Sample Request:

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

Response:

 HTTP/1.1 200 OK

{"androidType":"fcm","androidFCMAPIKey":"123123","androidThirdPartyURL":"https://www.comm100.com","androidThirdPartyRequestBody":"11","androidPushFcmExtraData":[{"id":"56EEC186-7084-4BDF-A23B-F7B69548A733","field":"","content":""}],"androidPushThirdPartyRequestHeaders":[{"id":"1E8807C2-52C9-4532-8B51-188670B7BB23","field":"","content":""}]}
Update the Android Push

PUT livechat/androidPush

Parameters:
Name Type In Required Description
androidType string body no Allowed values are "fcm", "thirdParty".
androidFCMAPIKey string body yes Android fcm API key,mandatory when androidType is fcm.
androidThirdPartyURL string body yes Android third party URL,mandatory when androidType is thirdParty.
androidThirdPartyRequestBody string body yes Android third party request body,mandatory when androidType is thirdParty.
androidPushFcmExtraData androidPushFcmExtraData[] body no Reference to Android Push Fcm Extra Data.
androidPushThirdPartyRequestHeaders androidPushThirdPartyRequestHeaders[] body no Reference to Android Push Third Party Request Header.
Response:

Android Push

Example

Sample Request:

curl https://api15.comm100.io/v4/livechat/androidPush \
-X 'PUT' \
-H 'Authorization: Bearer {access_token}' \
-H 'Content-Type: application/json' \
-D '{"androidType":"fcm","androidFCMAPIKey":"123123","androidThirdPartyURL":"https://www.comm100.com","androidThirdPartyRequestBody":"11","androidPushFcmExtraData":[{"field":"","content":""}],"androidPushThirdPartyRequestHeaders":[{"field":"","content":""}]}'

Response:

 HTTP/1.1 200 OK

{"androidType":"fcm","androidFCMAPIKey":"123123","androidThirdPartyURL":"https://www.comm100.com","androidThirdPartyRequestBody":"11","androidPushFcmExtraData":[{"id":"56EEC186-7084-4BDF-A23B-F7B69548A733","field":"","content":""}],"androidPushThirdPartyRequestHeaders":[{"id":"1E8807C2-52C9-4532-8B51-188670B7BB23","field":"","content":""}]}
© 2021 | Comm100