This collection covers all APIs exposed or consumed by the CCM of HybridChat 3.x.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8262326","collectionId":"6db80139-964f-4bce-a268-93b82419512e","publishedId":"TW6zGSe7","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-02-01T07:12:05.000Z"},"item":[{"name":"CCM Webhooks for Twilio","item":[{"name":"receive-message","id":"aaed9da2-66e9-4699-9079-625d9c171cbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/msg-client/recieve?To=whatsapp:+14155238886&From=whatsapp+1234567&Body=message body&NumMedia=0","description":"The Hybrid Chat CCM API to receive a chat message from Twilio for SMS, MMS, and WhatsApp.
\n","urlObject":{"path":["msg-client","recieve"],"query":[{"description":{"content":"The destination WhatsApp number, it should be same as TWILIO_WHATSAPP_FROM_NUMBER environment variable value in CCM environment variables. This is a required parameter.
\n","type":"text/plain"},"key":"To","value":"whatsapp:+14155238886"},{"description":{"content":"The sender WhatsApp number. This is a required parameter.
\n","type":"text/plain"},"key":"From","value":"whatsapp+1234567"},{"description":{"content":"The message body, it should not be empty if NumMedia=0. This is a required parameter
\n","type":"text/plain"},"key":"Body","value":"message body"},{"description":{"content":"The number of media files attached with this message. This is an optional parameter.
\n","type":"text/plain"},"key":"NumMedia","value":"0"}],"variable":[]}},"response":[{"id":"0e214183-9ffa-4a5c-86ba-63260b184674","name":"Whatsapp Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"From\": \"whatsapp:+923001245632\",\n \"To\": \"whatsapp:+14155238886\",\n \"Body\": \"Hello\",\n \"NumMedia\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/msg-client/recieve"},"code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"2932ce54-ca80-484a-b373-382d1e746880","name":"Whatsapp/SMS Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"To\": \"\",\n \"From\": \"+14155238886\",\n \"Body\": \"Hello\",\n \"NumMedia\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/msg-client/recieve"},"code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"Error: Message not delivered."},{"id":"589beea8-090c-4749-acd4-f8969d38119a","name":"SMS Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"To\": \"+18302435657\",\n \"From\": \"+93201071733\",\n \"Body\": \"Hello\",\n \"NumMedia\": 0\n}","options":{"raw":{"language":"json"}}},"url":"https://hcqateam.expertflow.com/msg-client/recieve"},"code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"aaed9da2-66e9-4699-9079-625d9c171cbf"}],"id":"aacc0ba7-1629-49aa-9545-199253697dc2","description":"These are the APIs of Hybrid Chat Channel Manager to receive an SMS, MMS, WhatsApp chat message from Twilio.
\n","_postman_id":"aacc0ba7-1629-49aa-9545-199253697dc2"},{"name":"CCM Webhooks for Viber","item":[{"name":"Inbound Message","id":"741f6627-f2f1-4a47-865e-289c7d93966e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"event\":\"message\", // message event, do not change\n \"timestamp\":1617105227715, // timestamp\n \"chat_hostname\":\"SN-CHAT-08_\",\n \"message_token\":5557651826925583398, // A random token\n \"sender\": {\n \"id\":\"SUcUaIjwzEu1OZjyg==\", // sender Id\n \"name\":\"Jon Doe\", // sender name\n \"avatar\":\"https://media-direct.cdn.viber.com/download_photo?dlid=12345&fltp=jpg&imsz=0000\", // sender avatar url\n \"language\":\"en\", // language\n \"country\":\"PK\", // sender country\n \"api_version\":8 // Viber API version\n },\n \"message\": {\n \"text\":\"Hi\", // message text\n \"type\":\"text\" // message type\n },\n \"silent\":false \n}","options":{"raw":{"language":"json"}}},"url":"/viber-message/receive","description":"This API should be specified in the Viber configuration to send a Viber message to Hybrid Chat Channel Manager.
\n","urlObject":{"path":["viber-message","receive"],"query":[],"variable":[]}},"response":[{"id":"032e1c6c-17e3-4bb6-9dd2-8398cf431c0b","name":"Inbound Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"event\" : \"message\",\n \"message_token\":241256543215,\n \"sender\" : \"01234567890A=\",\n \"message\": \"Hello\"\n}","options":{"raw":{"language":"json"}}},"url":"/viber-message/recieve"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"b1ceb7f9-4db0-4664-8032-d3429e8deecf","name":"Error: Message not delivered.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"event\" : \"\",\n \"message_token\":241256543215,\n \"sender\" : \"01234567890A=\",\n \"message\": \"Hello\"\n}","options":{"raw":{"language":"json"}}},"url":"/viber-message/recieve"},"code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"Error: Message not delivered."}],"_postman_id":"741f6627-f2f1-4a47-865e-289c7d93966e"}],"id":"d4c97f6f-37b2-4e61-aea8-5efece29fbd5","_postman_id":"d4c97f6f-37b2-4e61-aea8-5efece29fbd5","description":""},{"name":"CCM Webhooks for Facebook","item":[{"name":"Webhook Registration","id":"5b0eba65-7688-4677-ba6d-24d495fbd50d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"HttpServletRequest\": {\n \"hub.mode\": \"subscribe\",\n \"hub.verify_token\": \"Unique token of Facebook app \",\n \"hub.challenge\": \"CHALLEGNE_ACCEPTED\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"/webhook","description":"Facebook uses this CCM API to validate a webhook, it is called once when we register CCM Webhook API with Facebook.
\n","urlObject":{"path":["webhook"],"query":[],"variable":[]}},"response":[{"id":"f184b910-db2b-4ae5-9af8-2ad7678b89af","name":"Webhook Registration","originalRequest":{"method":"GET","header":[],"url":"/webhook"},"code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5b0eba65-7688-4677-ba6d-24d495fbd50d"},{"name":"Inbound Message","id":"38576438-f508-43ed-8cad-bccb15d7ff47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"object\": \"page\",\n \"entry\": [\n {\n \"id\": \"recipient_id\",\n \"messaging\": [\n {\n \"sender\": {\n \"id\": \"3795734577118561\"\n },\n \"recipient\": {\n \"id\": \"101064781498908\"\n },\n \"message\": {\n \"text\": \"Body of the message\",\n \"mid\": \"Unique id of the message\"\n }\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/webhook","description":"Facebook uses this API to send messages to Hybrid Chat Customer Channel Manager
\n","urlObject":{"path":["webhook"],"query":[],"variable":[]}},"response":[{"id":"5c414375-b0aa-4783-92a3-9f00fab70bfc","name":"Error: Mesage not Delivered","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"object\": \"page\",\n \"entry\": [\n {\n \"id\": \"recipient_id\",\n \"messaging\": [\n {\n \"sender\": {\n \"id\": \"\"\n },\n \"recipient\": {\n \"id\": \"101064781498908\"\n },\n \"message\": {\n \"text\": \"Body of the message\",\n \"mid\": \"Unique id of the message\"\n }\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/webhook"},"code":400,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"Error: Message Not Delivered"},{"id":"b3f67cd9-41a7-41b7-82e8-2ab887f6414e","name":"Inbound Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"object\": \"page\",\n \"entry\": [\n {\n \"id\": \"101064781498908\",\n \"messaging\": [\n {\n \"sender\": {\n \"id\": \"3795734577118561\"\n },\n \"recipient\": {\n \"id\": \"101064781498908\"\n },\n \"message\": {\n \"text\": \"Hello\",\n \"mid\": \"m_0L6vNyZ9PUmf2Wf8xFKSRoxBIXpQGFRscP1tF8tF6mQWsLfUwNoYMw-p-4jZ-5pKQXyMVlXWshyw3YgJK3Z-Vw\"\n }\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/webhook"},"code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"38576438-f508-43ed-8cad-bccb15d7ff47"}],"id":"239fd7cb-39f8-423a-950d-df498dce3ad0","_postman_id":"239fd7cb-39f8-423a-950d-df498dce3ad0","description":""},{"name":"CCM Webhooks for 360Dialog","item":[{"name":"Receive Message","id":"3fb2c64c-cfca-4d67-90ba-379005b17cbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"messages\": [{\n \"from\": \"333\",\n \"contacts\": \"Jon Doe\",\n \"text\": {\n \"body\": \"This is example text\"\n }\n }]\n}","options":{"raw":{"language":"json"}}},"url":"/360notifications","urlObject":{"path":["360notifications"],"query":[],"variable":[]}},"response":[],"_postman_id":"3fb2c64c-cfca-4d67-90ba-379005b17cbe"}],"id":"563d04ae-bdb2-42f6-951c-e7a9a693a2cf","_postman_id":"563d04ae-bdb2-42f6-951c-e7a9a693a2cf","description":""},{"name":"SMPP API's","item":[{"name":"Inbound Message","id":"7c55b130-6125-4d83-830d-54c63c8c5c18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/sms/send?To=+1234567&From=+7654321&Body=message","description":"Customer Channel Manager API to send outbound message via SMPP
\n","urlObject":{"path":["sms","send"],"query":[{"description":{"content":"Receiver id / phone number. This is a required parameter
\n","type":"text/plain"},"key":"To","value":"+1234567"},{"description":{"content":"Sender id / phone number. This is a required parameter
\n","type":"text/plain"},"key":"From","value":"+7654321"},{"description":{"content":"Message body. This is a required parameter
\n","type":"text/plain"},"key":"Body","value":"message"}],"variable":[]}},"response":[{"id":"653a1c44-9b95-4ce2-bbb5-719052409f81","name":"Inbound Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"To\": \"154452184112515\",\n \"From\": \"15454512165611\",\n \"Body\": \"Hello\"\n}","options":{"raw":{"language":"json"}}},"url":"/sms/send"},"code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"msgId\":\"14512ac4d5ww4da1c5aw\"\n}"},{"id":"8f0fc899-70a9-40fe-8ac2-c3ccb27335e4","name":"Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"To\": \"recipient_id\",\n \"From\": \"\",\n \"Body\": \"body of the message\"\n}","options":{"raw":{"language":"json"}}},"url":"/sms/send"},"code":500,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7c55b130-6125-4d83-830d-54c63c8c5c18"}],"id":"4faeeadf-0938-42d0-8faf-0bae0536bdaf","_postman_id":"4faeeadf-0938-42d0-8faf-0bae0536bdaf","description":""},{"name":"SystemInfo API","item":[{"name":"System Information","id":"f2707f48-785d-4159-a971-51128bbbcb12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/api/SystemInfo","description":"This api is used to get system information
\n","urlObject":{"path":["api","SystemInfo"],"query":[],"variable":[]}},"response":[{"id":"4767ff58-4c6d-4161-a3ec-c7309bb3f9bf","name":"System Information","originalRequest":{"method":"GET","header":[],"url":"/api/SystemInfo"},"code":200,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":"{\n \"status\" :\"IN_SERVICE\"\n}"}],"_postman_id":"f2707f48-785d-4159-a971-51128bbbcb12"}],"id":"b14643b7-385e-44fd-9aa5-b910ca9c46a3","_postman_id":"b14643b7-385e-44fd-9aa5-b910ca9c46a3","description":""},{"name":"CIM API","item":[{"name":"Send Outbound Message","id":"7e0c5e70-d8a9-4f33-984b-e4cb75a8947b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"To\": \"desitnation number\",\n \"From\": \"source number\",\n \"Body\": \"message text\",\n \"messageId\": \"message-id\",\n \"channel\": \"whatsapp | sms\"\n}","options":{"raw":{"language":"json"}}},"url":"/msg-client/send","description":"Customer Channel Manager API to send outbound SMS or WhatsApp message via Twilio.
\n","urlObject":{"path":["msg-client","send"],"query":[],"variable":[]}},"response":[],"_postman_id":"7e0c5e70-d8a9-4f33-984b-e4cb75a8947b"}],"id":"50f2bd3e-aab1-4056-b599-01c64e6639dc","_postman_id":"50f2bd3e-aab1-4056-b599-01c64e6639dc","description":""}]}