API Token From Omnichat
\n"}],"url":"https://open-api.omnichat.ai/v1/chatbots","description":"Description
\nGet chatbot list
\nSubscription Required
\n- \n
Marketing Cloud / Social CDP Cloud
\n \nMarketing Open API Module
\n \n
Responses
\nSuccess - HTTP Status 200 with the following body:
\nArray of Chatbot Objects
Bad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\nAPI Token From Omnichat
\n","type":"text"}],"url":"https://open-api.omnichat.ai/v1/chatbots/:chatbotId/message-blocks","description":"Description
\nGet chatbot's message blocks list
\nSubscription Required
\n- \n
Marketing Cloud / Social CDP Cloud
\n \nMarketing Open API Module
\n \n
Path Parameters
\nResponses
\nSuccess - HTTP Status 200 with the following body:
\nArray of Message Block Objects
Bad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\nChatbot ID
\n","type":"text/plain"},"type":"any","value":"API Token From Omnichat
\n","type":"text"}],"url":"https://open-api.omnichat.ai/v1/messages?page=1&pageSize=20&after=1652371200000&before=1653580800000&platform=whatsapp&channelId","description":"Description
\nGet chat history by date range
\nSubscription Required
\n- \n
Customer Service Cloud / Social CDP Cloud
\n \nCRM Open API Module
\n \n
Query Parameters
\nResponses
\nSuccess - HTTP Status 200 with the follow response body:
\nResponse object
\nMessage Objects
Channel Objects
Bad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\n{\n \"errorCode\": \"INVALID_REQUEST_PARAMETERS\",\n \"message\": \"The date range between after and before cannot exceed 7 days.\"\n}\n\nPage number. (Default: 1)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Number of messages per page. (Default: 20 ;Max: 100)
\n","type":"text/plain"},"key":"pageSize","value":"20"},{"description":{"content":"The start of the specific date range in unix timestamp (milliseconds) (inclusive) [Max date range specified is 7 days]
\n","type":"text/plain"},"key":"after","value":"1652371200000"},{"description":{"content":"The end of the specific date range in unix timestamp (milliseconds) (exclusive) [Max date range specified is 7 days]
\n","type":"text/plain"},"key":"before","value":"1653580800000"},{"description":{"content":"[Required] Messaging Platform
\n","type":"text/plain"},"key":"platform","value":"whatsapp"},{"description":{"content":"[Optional] Specific Messaging Platform Channel ID
\n","type":"text/plain"},"key":"channelId","value":null}],"variable":[]}},"response":[{"id":"86de0ef0-f389-447c-b721-adad330f8783","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://open-api.omnichat.ai/v1/messages?page=1&pageSize=20&after=1652371200000&before=1653580800000&platform=whatsapp&channelId","protocol":"https","host":["open-api","omnichat","ai"],"path":["v1","messages"],"query":[{"key":"page","value":"1"},{"key":"pageSize","value":"20"},{"key":"after","value":"1652371200000"},{"key":"before","value":"1653580800000"},{"key":"platform","value":"whatsapp"},{"key":"channelId","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"channel\": {\n \"platform\": \"whatsapp\",\n \"channelId\": \"85290000001\"\n },\n \"id\": \"mid-1\",\n \"time\": 1604647464032,\n \"senderName\": \"Peter\",\n \"senderUserId\": \"85290000002\",\n \"senderPhone\": \"85290000002\",\n \"senderEmail\": null,\n \"senderType\": \"customer\",\n \"messageType\": \"text\",\n \"messageStatus\": \"delivered\",\n \"message\": \"hello\",\n \"mediaUrl\": null,\n \"roomId\": \"wh18695d48-5788-4d0a-a02c-9522a996258c-85290000002\",\n \"customerUserId\": \"85290000002\"\n },\n {\n \"channel\": {\n \"platform\": \"whatsapp\",\n \"channelId\": \"85290000001\"\n },\n \"id\": \"mid-2\",\n \"time\": 1604647464032,\n \"senderName\": \"Peter\",\n \"senderUserId\": \"85290000002\",\n \"senderPhone\": \"85290000002\",\n \"senderEmail\": null,\n \"senderType\": \"customer\",\n \"messageType\": \"photo\",\n \"messageStatus\": \"read\",\n \"message\": null,\n \"mediaUrl\": \"https://example.com/83b4f48c4229.png\",\n \"roomId\": \"wh18695d48-5788-4d0a-a02c-9522a996258c-85290000002\",\n \"customerUserId\": \"85290000002\"\n },\n {\n \"channel\": {\n \"platform\": \"whatsapp\",\n \"channelId\": \"85290000001\"\n },\n \"id\": \"mid-3\",\n \"time\": 1604647464032,\n \"senderName\": \"Peter\",\n \"senderUserId\": \"85290000002\",\n \"senderPhone\": \"85290000002\",\n \"senderEmail\": null,\n \"senderType\": \"customer\",\n \"messageType\": \"audio\",\n \"messageStatus\": \"read\",\n \"message\": null,\n \"mediaUrl\": \"https://example.com/83b4f48c4229.ogg\",\n \"roomId\": \"wh18695d48-5788-4d0a-a02c-9522a996258c-85290000002\",\n \"customerUserId\": \"85290000002\"\n },\n {\n \"channel\": {\n \"platform\": \"whatsapp\",\n \"channelId\": \"85290000001\"\n },\n \"id\": \"mid-4\",\n \"time\": 1604647464032,\n \"senderName\": \"Peter\",\n \"senderUserId\": \"85290000002\",\n \"senderPhone\": \"85290000002\",\n \"senderEmail\": null,\n \"senderType\": \"customer\",\n \"messageType\": \"document\",\n \"messageStatus\": \"read\",\n \"message\": null,\n \"mediaUrl\": \"https://example.com/83b4f48c4229.pdf\",\n \"roomId\": \"wh18695d48-5788-4d0a-a02c-9522a996258c-85290000002\",\n \"customerUserId\": \"85290000002\"\n },\n {\n \"channel\": {\n \"platform\": \"whatsapp\",\n \"channelId\": \"85290000001\"\n },\n \"id\": \"mid-5\",\n \"time\": 1604647464032,\n \"senderName\": \"Peter\",\n \"senderUserId\": \"85290000002\",\n \"senderPhone\": \"85290000002\",\n \"senderEmail\": null,\n \"senderType\": \"customer\",\n \"messageType\": \"video\",\n \"messageStatus\": \"read\",\n \"message\": null,\n \"mediaUrl\": \"https://example.com/83b4f48c4229.mp4\",\n \"roomId\": \"wh18695d48-5788-4d0a-a02c-9522a996258c-85290000002\",\n \"customerUserId\": \"85290000002\"\n },\n {\n \"channel\": {\n \"platform\": \"whatsapp\",\n \"channelId\": \"85290000001\"\n },\n \"id\": \"mid-6\",\n \"time\": 1604647464032,\n \"senderName\": \"Bot\",\n \"senderUserId\": \"85290000001\",\n \"senderPhone\": null,\n \"senderEmail\": null,\n \"senderType\": \"bot\",\n \"messageType\": \"chatbot\",\n \"messageStatus\": \"read\",\n \"message\": \"Welcome to Omnichat~\",\n \"mediaUrl\": null,\n \"roomId\": \"wh18695d48-5788-4d0a-a02c-9522a996258c-85290000002\",\n \"customerUserId\": \"85290000002\"\n },\n {\n \"channel\": {\n \"platform\": \"whatsapp\",\n \"channelId\": \"85290000001\"\n },\n \"id\": \"0031ab01-93b1-480a-9270-83b4f48c4229\",\n \"time\": 1604647464032,\n \"senderName\": \"Kyle Li\",\n \"senderUserId\": \"d65e5ab9-5f4f-4119-919c-298a7ac8df79\",\n \"senderPhone\": \"853922222222\",\n \"senderEmail\": \"kyleli@example.com\",\n \"senderType\": \"agent\",\n \"messageType\": \"text\",\n \"messageStatus\": \"read\",\n \"message\": \"hi~How can I help you?\",\n \"mediaUrl\": null,\n \"roomId\": \"wh18695d48-5788-4d0a-a02c-9522a996258c-85290000002\",\n \"customerUserId\": \"85290000002\"\n }\n ],\n \"totalElement\": 2301\n}"}],"_postman_id":"a696226b-c319-4db3-a229-92cfdeba804d"},{"name":"Get message details","id":"b7e92d26-136f-474d-8be4-be3c3e726e1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","description":"API Token From Omnichat
\n","type":"text"}],"url":"https://open-api.omnichat.ai/v1/messages/:messageId","description":"Description
\nGet message details
\nSubscription Required
\n- \n
Customer Service Cloud / Social CDP Cloud
\n \nCRM Open API Module
\n \n
Parameters
\nResponses
\nSuccess - HTTP Status 200 with the follow response body:
\nResponse object
\nMessage Objects
Channel Objects
Bad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\nAPI Token From Omnichat
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trackId\": \"22\",\n \"platform\": \"whatsapp\",\n \"tags\": ['222'],\n \"to\": \"886987684162\",\n \"channelId\": \"85295307057\",\n \"messages\": [\n {\n \"type\": \"whatsappTemplate\",\n \"whatsappTemplate\": {\n \"name\": \"membership_cs_kelvin\",\n \"language\": {\n \"code\": \"zh_HK\",\n \"policy\": \"deterministic\"\n },\n \"components\": [\n {\n \"type\": \"body\",\n \"parameters\": []\n },\n {\n \"type\": \"button\",\n \"sub_type\": \"quick_reply\",\n \"index\": 0,\n \"parameters\": [\n {\n \"type\": \"payload\",\n \"payload\": \"{\\\"action\\\":null}\"\n }\n ]\n }\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/direct-messages","description":"Description
\nSend a single message to a contact
\nSubscription Required
\n- \n
Marketing Cloud / Social CDP Cloud
\n \nMarketing Open API Module
\n \n
Request body
\nMessage object
Product Object
WhatsApp template Object
Please refer to Template Object in WhatsApp API Documentation.
LINE template Object
LINE template parameter Object
Custom Attribute Object
Responses
\nSuccess - HTTP Status 200 with the following response body.
\nResponse content object
Bad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\nError Codes:
\n- \n
\nINVALID_REQUEST_BODY: Invalid request body \n
\nCONTACT_UNSUBSCRIBED: Contact is unsubscribed \n
\nCONTACT_NOT_REACHABLE: Contact is exceeded the subscription plan contact limit \n
\nINTERNAL_SERVER_ERROR: Internal server error \n
\nUNEXPECTED_ERROR: Unexpected error, please contact developers \n
API Token From Omnichat
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"platform\": \"line\",\n \"channelId\": \"123456789\",\n \"ids\": [\n \"U66a669e12ff66601c06e1dcd06e8f63c\",\n \"U1535b48edaae6ea9bf7408e4d08b3d41\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/identities/member-data","description":"Description
\nCheck Member Data using Social Identity
\nSubscription Required
\n- \n
CS / Marketing / OMO Sales / Social CDP Cloud
\n \nCRM Open API Module
\n \n
Request Body
\nResponses
\nSuccess - HTTP Status 200 with the following response body
\nResponse object
\nArray of Check Identity Result Objects
Bad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\nThe Get Contacts API has been moved to the new documentation. Please refer to the new document for the latest information.
\nhttps://developers.omnichat.ai/docs/contacts-api#get-contacts
\n\n
Description
\nGet updated contacts by specific date range
\nSubscription Required
\n- \n
CS / Marketing / OMO Sales / Social CDP Cloud
\n \nCRM Open API Module
\n \n
Query Parameters
\nResponses
\nSuccess - HTTP Status 200 with the follow response body:
\nResponse object
\nContact Objects
Channel Objects
Custom Attribute Objects
Bad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\n[Required] Messaging Platform
\n","type":"text/plain"},"key":"platform","value":"line"},{"description":{"content":"[Optional] Specific Messaging Platform Channel ID
\n","type":"text/plain"},"key":"channelId","value":""},{"description":{"content":"[Optional] Specific contact ID
\n","type":"text/plain"},"key":"userId","value":null},{"description":{"content":"Page number. (Default: 1)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Number of contacts per page. (Default: 20 ;Max: 100)
\n","type":"text/plain"},"key":"pageSize","value":"20"},{"description":{"content":"The start of the specific date range in unix timestamp (milliseconds) (inclusive) [Max date range specified is 7 days]
\n","type":"text/plain"},"key":"updatedAfter","value":"1652371200000"},{"description":{"content":"The end of the specific date range in unix timestamp (milliseconds) (exclusive) [Max date range specified is 7 days]
\n","type":"text/plain"},"key":"updatedBefore","value":"1653580800000"}],"variable":[]}},"response":[{"id":"2ad2127c-3c9a-419f-9f4b-02194617cbfa","name":"LINE","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://open-api.omnichat.ai/v1/contacts?platform=line&page=1&pageSize=20&updatedAfter=1652371200000&updatedBefore=1653580800000","protocol":"https","host":["open-api","omnichat","ai"],"path":["v1","contacts"],"query":[{"key":"platform","value":"line","description":"[Required] Messaging Platform"},{"key":"channelId","value":"","description":"[Optional] Specific Messaging Platform Channel ID","type":"text","disabled":true},{"key":"page","value":"1","description":"Page number. Default: 1"},{"key":"pageSize","value":"20","description":"Number of contacts per page. Default: 20 (Max: 100)"},{"key":"updatedAfter","value":"1652371200000","description":"The start of the specific date range in unix timestamp (milliseconds) (inclusive)"},{"key":"updatedBefore","value":"1653580800000","description":"The end of the specific date range in unix timestamp (milliseconds) (exclusive)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"channel\": {\n \"platform\": \"line\",\n \"channelId\": \"165000000\"\n },\n \"id\": \"U2bd582c37356d37cb6d46a823de3a908\",\n \"name\": \"Alan\",\n \"lastMessageTime\": 1604650656053,\n \"subscribedAt\": 1604650656053,\n \"unsubscribedAt\": 1604650656053,\n \"updatedAt\": 1604650656053,\n \"tags\": [\n \"VIP\",\n \"Sports\"\n ],\n \"customAttributes\": [\n { \"key\": \"MEMBER_TIER\", \"value\": \"GOLD\", \"type\": \"text\", \"displayName\": \"Member Tier\"},\n { \"key\": \"GENDER\", \"value\": \"M\", \"type\": \"text\", \"displayName\": \"Gender\"}\n ],\n \"status\": true,\n \"note\": \"new customer\",\n \"email\": \"test@email.com\",\n \"phone\": \"886966633355\",\n \"memberId\": \"9431\",\n \"agentName\": null,\n \"agentEmployeeCode\": null,\n \"agentBindTime\": null,\n \"agentLocationName\": null,\n \"agentLocationCode\": null\n },\n {\n \"channel\": {\n \"platform\": \"line\",\n \"channelId\": \"165000000\"\n },\n \"id\": \"U2bd582c37356d37cb6d46a823de3a413\",\n \"name\": \"Mary\",\n \"lastMessageTime\": 1604650656053,\n \"tags\": [],\n \"status\": true,\n \"note\": \"\",\n \"email\": \"mary@email.com\",\n \"phone\": \"88690000000\",\n \"memberId\": \"\",\n \"agentName\": \"Sales Ken\",\n \"agentEmployeeCode\": \"S0001\",\n \"agentBindTime\": 1604650656053,\n \"agentLocationName\": \"Shop A\",\n \"agentLocationCode\": \"S-001\"\n },\n {\n \"channel\": {\n \"platform\": \"line\",\n \"channelId\": \"165000002\"\n },\n \"id\": \"U2bd582c37356d37cb6d46a823de3a444\",\n \"name\": \"Peter\",\n \"lastMessageTime\": 1604650656053,\n \"tags\": [],\n \"status\": true,\n \"note\": \"refund on 6/7\",\n \"email\": \"peter@email.com\",\n \"phone\": \"\",\n \"memberId\": \"\",\n \"agentName\": null,\n \"agentEmployeeCode\": null,\n \"agentBindTime\": null,\n \"agentLocationName\": null,\n \"agentLocationCode\": null\n }\n ],\n \"totalElements\": 3\n}"},{"id":"af929048-3fb7-48ec-b189-42d90057e38e","name":"Facebook","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://open-api.omnichat.ai/v1/contacts?platform=facebook&page=1&pageSize=20&updatedAfter=1652371200000&updatedBefore=1653580800000","protocol":"https","host":["open-api","omnichat","ai"],"path":["v1","contacts"],"query":[{"key":"platform","value":"facebook","description":"[Required] Messaging Platform"},{"key":"channelId","value":"","description":"[Optional] Specific Messaging Platform Channel ID","type":"text","disabled":true},{"key":"page","value":"1","description":"Page number. Default: 1"},{"key":"pageSize","value":"20","description":"Number of contacts per page. Default: 20 (Max: 100)"},{"key":"updatedAfter","value":"1652371200000","description":"The start of the specific date range in unix timestamp (milliseconds) (inclusive)"},{"key":"updatedBefore","value":"1653580800000","description":"The end of the specific date range in unix timestamp (milliseconds) (exclusive)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"channel\": {\n \"platform\": \"facebook\",\n \"channelId\": \"202104673972398\"\n },\n \"id\": \"1991015490937924\",\n \"name\": \"Mary\",\n \"lastMessageTime\": 1604650656053,\n \"subscribedAt\": 1604650656053,\n \"unsubscribedAt\": 1604650656053,\n \"updatedAt\": 1604650656053,\n \"tags\": [],\n \"customAttributes\": [\n { \"key\": \"MEMBER_TIER\", \"value\": \"GOLD\", \"type\": \"text\", \"displayName\": \"Member Tier\"},\n { \"key\": \"GENDER\", \"value\": \"M\", \"type\": \"text\", \"displayName\": \"Gender\"}\n ],\n \"status\": true,\n \"note\": \"\",\n \"email\": \"mary@email.com\",\n \"phone\": \"88690000000\",\n \"memberId\": \"\",\n \"agentName\": null,\n \"agentEmployeeCode\": null,\n \"agentBindTime\": null,\n \"agentLocationName\": null,\n \"agentLocationCode\": null\n }\n ],\n \"totalElements\": 1\n}"},{"id":"93a1ca6f-3484-4cb4-a741-df52284619c7","name":"Instagram","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://open-api.omnichat.ai/v1/contacts?platform=instagram&page=1&pageSize=20&updatedAfter=1652371200000&updatedBefore=1653580800000","protocol":"https","host":["open-api","omnichat","ai"],"path":["v1","contacts"],"query":[{"key":"platform","value":"instagram","description":"[Required] Messaging Platform"},{"key":"channelId","value":"","description":"[Optional] Specific Messaging Platform Channel ID","type":"text","disabled":true},{"key":"page","value":"1","description":"Page number. Default: 1"},{"key":"pageSize","value":"20","description":"Number of contacts per page. Default: 20 (Max: 100)"},{"key":"updatedAfter","value":"1652371200000","description":"The start of the specific date range in unix timestamp (milliseconds) (inclusive)"},{"key":"updatedBefore","value":"1653580800000","description":"The end of the specific date range in unix timestamp (milliseconds) (exclusive)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"channel\": {\n \"platform\": \"instagram\",\n \"channelId\": \"17841441723885812\"\n },\n \"id\": \"3202549109798234\",\n \"name\": \"Mary\",\n \"lastMessageTime\": 1604650656053,\n \"subscribedAt\": 1604650656053,\n \"unsubscribedAt\": 1604650656053,\n \"updatedAt\": 1604650656053,\n \"tags\": [],\n \"customAttributes\": [\n { \"key\": \"MEMBER_TIER\", \"value\": \"GOLD\", \"type\": \"text\", \"displayName\": \"Member Tier\"},\n { \"key\": \"GENDER\", \"value\": \"M\", \"type\": \"text\", \"displayName\": \"Gender\"}\n ],\n \"status\": true,\n \"note\": \"\",\n \"email\": \"mary@email.com\",\n \"phone\": \"88690000000\",\n \"memberId\": \"\",\n \"agentName\": null,\n \"agentEmployeeCode\": null,\n \"agentBindTime\": null,\n \"agentLocationName\": null,\n \"agentLocationCode\": null\n }\n ],\n \"totalElements\": 1\n}"},{"id":"d26b6400-0ee2-40f9-a989-fe47cfd44025","name":"WhatsApp","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://open-api.omnichat.ai/v1/contacts?platform=whatsapp&page=1&pageSize=20&updatedAfter=1652371200000&updatedBefore=1653580800000","protocol":"https","host":["open-api","omnichat","ai"],"path":["v1","contacts"],"query":[{"key":"platform","value":"whatsapp","description":"[Required] Messaging Platform"},{"key":"channelId","value":"","description":"[Optional] Specific Messaging Platform Channel ID","type":"text","disabled":true},{"key":"page","value":"1","description":"Page number. Default: 1"},{"key":"pageSize","value":"20","description":"Number of contacts per page. Default: 20 (Max: 100)"},{"key":"updatedAfter","value":"1652371200000","description":"The start of the specific date range in unix timestamp (milliseconds) (inclusive)"},{"key":"updatedBefore","value":"1653580800000","description":"The end of the specific date range in unix timestamp (milliseconds) (exclusive)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"channel\": {\n \"platform\": \"whatsapp\",\n \"channelId\": \"852900000001\"\n },\n \"id\": \"88690000000\",\n \"name\": \"Mary\",\n \"lastMessageTime\": 1604650656053,\n \"subscribedAt\": 1604650656053,\n \"unsubscribedAt\": 1604650656053,\n \"updatedAt\": 1604650656053,\n \"tags\": [],\n \"customAttributes\": [\n { \"key\": \"MEMBER_TIER\", \"value\": \"GOLD\", \"type\": \"text\", \"displayName\": \"Member Tier\"},\n { \"key\": \"GENDER\", \"value\": \"M\", \"type\": \"text\", \"displayName\": \"Gender\"}\n ],\n \"status\": true,\n \"note\": \"\",\n \"email\": \"mary@email.com\",\n \"phone\": \"88690000000\",\n \"memberId\": \"\",\n \"agentName\": \"Sales Ken\",\n \"agentEmployeeCode\": \"S0001\",\n \"agentBindTime\": 1604650656053,\n \"agentLocationName\": \"Shop A\",\n \"agentLocationCode\": \"S-001\"\n }\n ],\n \"totalElements\": 1\n}"},{"id":"3d60e777-7750-4fe0-a5f3-850a3bc5d44e","name":"Webchat","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://open-api.omnichat.ai/v1/contacts?page=1&pageSize=20&updatedAfter=1652371200000&updatedBefore=1653580800000&platform=webchat","protocol":"https","host":["open-api","omnichat","ai"],"path":["v1","contacts"],"query":[{"key":"channelId","value":"","description":"[Optional] Specific Messaging Platform Channel ID","type":"text","disabled":true},{"key":"page","value":"1","description":"Page number. Default: 1"},{"key":"pageSize","value":"20","description":"Number of contacts per page. Default: 20 (Max: 100)"},{"key":"updatedAfter","value":"1652371200000","description":"The start of the specific date range in unix timestamp (milliseconds) (inclusive)"},{"key":"updatedBefore","value":"1653580800000","description":"The end of the specific date range in unix timestamp (milliseconds) (exclusive)"},{"key":"platform","value":"webchat"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"channel\": {\n \"platform\": \"webchat\",\n \"channelId\": \"webchat\"\n },\n \"id\": \"02f9573e-01dc-4189-9ee6-ed3821486def\",\n \"name\": \"Mary\",\n \"lastMessageTime\": 1604650656053,\n \"subscribedAt\": 1604650656053,\n \"unsubscribedAt\": 1604650656053,\n \"updatedAt\": 1604650656053,\n \"tags\": [],\n \"customAttributes\": [\n { \"key\": \"MEMBER_TIER\", \"value\": \"GOLD\", \"type\": \"text\", \"displayName\": \"Member Tier\"},\n { \"key\": \"GENDER\", \"value\": \"M\", \"type\": \"text\", \"displayName\": \"Gender\"}\n ],\n \"status\": true,\n \"note\": \"\",\n \"email\": \"mary@email.com\",\n \"phone\": \"88690000000\",\n \"memberId\": \"\",\n \"agentName\": null,\n \"agentEmployeeCode\": null,\n \"agentBindTime\": null,\n \"agentLocationName\": null,\n \"agentLocationCode\": null\n }\n ],\n \"totalElements\": 1\n}"}],"_postman_id":"9fbcd2aa-7420-4a6c-ad25-fdb308dd0a6c"},{"name":"Upsert a Contact","id":"ef0e2438-ff90-4a58-97f6-44aa821ba2f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","description":"API Token From Omnichat
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Peter Chan\",\n\t\"status\": false,\n\t\"email\": \"example@example.com\",\n\t\"phone\": \"85298765432\",\n\t\"memberId\": \"M00001\",\n\t\"agentEmployeeCode\": \"EMP-001\",\n\t\"agentLocationCode\": \"SHOP-A\",\n \"tagsToAdd\": [ \"VVIP\", \"Sporty\" ],\n \"tagsToRemove\": [ \"VIP\" ],\n\t\"customAttributes\": [\n\t\t{ \"key\": \"MemberTier\", \"value\": \"GOLD\" },\n\t\t{ \"key\": \"Points\", \"value\": 2031 },\n\t\t{ \"key\": \"TotalSpending\", \"value\": 900.00 },\n\t\t{ \"key\": \"AcceptedMarketingPromotion\", \"value\": true },\n\t\t{ \"key\": \"LastPurchaseDate\", \"value\": \"2022-11-01\" },\n\t\t{ \"key\": \"RegisterDatetime\", \"value\": \"2022-11-01T14:16:00\" }\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/contacts/{platform}?channelId=1655713616&userId=Ufc16ca0dac59929c665558fd0c040d1c","description":"Description
\nThis API allows you to create or update a contact
\nSubscription Required
\n- \n
CS / Marketing / OMO Sales / Social CDP Cloud
\n \nCRM Open API Module
\n \n
Parameters
\nRequest Body
\nCustom Attribute Objects
Responses
\nSuccess - HTTP Status 204 with empty response body
\nBad request - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\nError Codes:
\n- \n
\nINVALID_REQUEST_BODY: Request body or field validation failed \n
\nMISSING_URL_PARAMETER: Required path variable or query parameter is missing \n
\nINVALID_REQUEST_PARAMETERS: Query parameter constraint violation \n
\nINTERNAL_SERVER_ERROR: Internal server error \n
\nCHANNEL_ID_NOT_FOUND: Channel not found for the given platform and team \n
\nWEBCHAT_USER_NOT_FOUND: Webchat user not found for the given user ID \n
\nINVALID_PLATFORM: Platform is not supported \n
\nAGENT_NOT_FOUND: Agent not found for the given employee code and location \n
\nINVALID_CUSTOM_ATTRIBUTE: Custom attribute key or value does not match the team's schema \n
\nUNEXPECTED_ERROR: Unexpected error, please contact developers \n
Specific Messaging Platform Channel ID.
\n","type":"text/plain"},"key":"channelId","value":"1655713616"},{"description":{"content":"Contact’s User ID
\n","type":"text/plain"},"key":"userId","value":"Ufc16ca0dac59929c665558fd0c040d1c"}],"variable":[]}},"response":[],"_postman_id":"ef0e2438-ff90-4a58-97f6-44aa821ba2f7"},{"name":"Delete Contact by User ID","id":"0ac0b773-2184-4189-9300-430a0d3522e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","description":"API Token From Omnichat
\n","type":"text"}],"url":"https://open-api.omnichat.ai/v1/contacts/:platform?channelId=1655713616&userId=Ufc16ca0dac59929c665558fd0c040d1c","description":"Description
\nThis API allows you to delete a contact data (including member profile & chat history) by User ID
\nSubscription Required
\n- \n
CS / Marketing / OMO Sales / Social CDP Cloud
\n \nCRM Open API Module
\n \n
Parameters
\nResponses
\nSuccess - HTTP Status 204 with empty response body
\nBad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\nSpecific Messaging Platform Channel ID.
\n","type":"text/plain"},"key":"channelId","value":"1655713616"},{"description":{"content":"Contact’s User ID
\n","type":"text/plain"},"key":"userId","value":"Ufc16ca0dac59929c665558fd0c040d1c"}],"variable":[{"id":"f4030216-ec02-491d-bb65-2a9138749229","description":{"content":"Messaging Platform
\n","type":"text/plain"},"type":"any","value":"line","key":"platform"}]}},"response":[],"_postman_id":"0ac0b773-2184-4189-9300-430a0d3522e3"}],"id":"9965c07f-a4ee-451c-936c-f196bde5d564","_postman_id":"9965c07f-a4ee-451c-936c-f196bde5d564","description":""},{"name":"Loyalty","item":[{"name":"Adjust loyalty points","id":"c886ff06-ae1c-4807-ad70-7dd341c4fb51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"points\": 10,\n \"phone\": \"852912345678\",\n \"email\": \"\",\n \"memberId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/loyalty-points/action/adjust","description":"Description
\nThis API allows you to adjust (add/deduct) contact's loyalty points using phone number, email or member ID.
\nSubscription Required
\n- \n
Loyalty Points Module
\n \nLoyalty Open API Module
\n \n
Request Body
\n","urlObject":{"protocol":"https","path":["v1","loyalty-points","action","adjust"],"host":["open-api","omnichat","ai"],"query":[],"variable":[]}},"response":[{"id":"ecf9b863-cdcb-465e-8ada-f35719b46316","name":"Adjust loyalty points using phone number","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"phone\": \"852912345678\",\n \"points\": 10\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/loyalty-points/action/adjust"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"bbcc6fa1-b2f2-4948-aa36-882b0f4a2a35","name":"Adjust loyalty points using email","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"john.doe@omnichat.ai\",\n \"points\": 10\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/loyalty-points/action/adjust"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"acc3a6d3-0b38-44a8-a00f-71550d7174a4","name":"Adjust loyalty points using member ID","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"memberId\": \"123456\",\n \"points\": 10\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/loyalty-points/action/adjust"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c886ff06-ae1c-4807-ad70-7dd341c4fb51"}],"id":"d56c7473-2f1a-4e53-950c-0d0041c42d01","_postman_id":"d56c7473-2f1a-4e53-950c-0d0041c42d01","description":""},{"name":"OMO Sales","item":[{"name":"Get teammate’s messages sent report","id":"6574b20a-d62f-43f4-8659-e9acb272c8ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://open-api.omnichat.ai/v1/reports/messages?page=1&pageSize=20&after=1652371200000&before=1653580800000","description":"Description
\nThe messages sent statistics of each teammates in a specific date range in a specific date range
\nSubscription Required
\n- \n
OMO Sales Cloud
\n \nOMO Sales Open API Module
\n \n
Query Parameters
\nResponses
\nSuccess - HTTP Status 200
\nMessage Sent Statistics Objects
Shop Location Objects
Message Count Objects
Bad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\nPage number. (Default: 1)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Number of result per page. (Default: 20 ;Max: 100)
\n","type":"text/plain"},"key":"pageSize","value":"20"},{"description":{"content":"The start of the specific date range in unix timestamp (milliseconds) (inclusive) [Max date range specified by after & before is 7 days]
\n","type":"text/plain"},"key":"after","value":"1652371200000"},{"description":{"content":"The end of the specific date range in unix timestamp (milliseconds) (exclusive) [Max date range specified by after & before is 7 days]
\n","type":"text/plain"},"key":"before","value":"1653580800000"}],"variable":[]}},"response":[{"id":"85b45dba-e7f8-46b1-9d13-bababb6ee63c","name":"Succcess","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://open-api.omnichat.ai/v1/reports/messages?page=1&pageSize=20&after=1652371200000&before=1653580800000","protocol":"https","host":["open-api","omnichat","ai"],"path":["v1","reports","messages"],"query":[{"key":"page","value":"1"},{"key":"pageSize","value":"20"},{"key":"after","value":"1652371200000"},{"key":"before","value":"1653580800000"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"name\": \"Sales Ken\",\n \"employeeCode\": \"S0001\",\n \"shopLocations\": [\n { \"name\": \"Shop A\", \"code\": \"S-001\" },\n { \"name\": \"Shop B\", \"code\": \"S-002\" }\n ],\n \"messageCount\": [\n { \"platform\": \"line\", \"messages\": 131, \"productReferralLinks\": 5 },\n { \"platform\": \"facebook\", \"messages\": 4, \"productReferralLinks\": 0 },\n { \"platform\": \"whatsapp\", \"messages\": 0, \"productReferralLinks\": 0 }\n ]\n }\n ],\n \"totalElements\": 1\n}"}],"_postman_id":"6574b20a-d62f-43f4-8659-e9acb272c8ac"},{"name":"Get product referral link order report","id":"2ff19920-132e-4a1a-a06b-677596fa7a35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://open-api.omnichat.ai/v1/reports/product-referral-links/orders?page=1&pageSize=20&after=1652371200000&before=1653580800000","description":"Description
\nGet all orders from product referral links in a specific date range
\n- \n
- Order data returns in this API is real time \n
Subscription Required
\n- \n
- OMO Sales Cloud \n
- OMO Sales Open API Module \n
Query Parameters
\nResponses
\nSuccess - HTTP Status 200
\nOrder Objects
91App Order ID Object
Bad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\nPage number. (Default: 1)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Number of result per page. (Default: 20 ;Max: 100)
\n","type":"text/plain"},"key":"pageSize","value":"20"},{"description":{"content":"The start of the specific date range in unix timestamp (milliseconds) (inclusive) [Max date range specified by after & before is 7 days]
\n","type":"text/plain"},"key":"after","value":"1652371200000"},{"description":{"content":"The end of the specific date range in unix timestamp (milliseconds) (exclusive) [Max date range specified by after & before is 7 days]
\n","type":"text/plain"},"key":"before","value":"1653580800000"}],"variable":[]}},"response":[{"id":"48d8785a-91b1-4448-a63f-f11088efd736","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://open-api.omnichat.ai/v1/reports/product-referral-links/orders?page=1&pageSize=20&after=1652371200000&before=1653580800000","protocol":"https","host":["open-api","omnichat","ai"],"path":["v1","reports","product-referral-links","orders"],"query":[{"key":"page","value":"1"},{"key":"pageSize","value":"20"},{"key":"after","value":"1652371200000"},{"key":"before","value":"1653580800000"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"orderId\": \"TX000001\",\n \"currency\": \"TWD\",\n \"total\": 100,\n \"date\": 1604650656053,\n \"memberId\": \"M001\",\n \"linkSentTime\": 1604650656053,\n \"linkClickedTime\": 1604650656053,\n \"considerationTime\": 14.51,\n \"agentName\": \"Sales Ken\",\n \"agentEmployeeCode\": \"S0001\",\n \"agentLocationName\": \"Shop A\",\n \"agentLocationCode\": \"S-001\",\n \"91appOrderId\": {\n \"tgCode\": \"TG00000000001\",\n \"tmCode\": [\"TM00000000001\", \"TM00000000002\"],\n \"tsCode\": [\"TS00000000001\", \"TS00000000002\"]\n }\n }\n ],\n \"totalElements\": 1\n}"}],"_postman_id":"2ff19920-132e-4a1a-a06b-677596fa7a35"},{"name":"Check product referral link tracking info","id":"65442cc9-49bb-4eab-ad18-88e66c018162","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://open-api.omnichat.ai/v1/product-referral-links/info?ocsaid={{ocsaid}}","description":"Description
\nGet the tracking code information
\nSubscription Required
\n- \n
- OMO Sales Cloud \n
- OMO Sales Open API Module \n
Query Parameters
\nResponses
\nSuccess - HTTP Status 200 with the following body:
\nTracking Code Info Objects
Bad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\nsales tracking code
\n","type":"text/plain"},"key":"ocsaid","value":"{{ocsaid}}"}],"variable":[]}},"response":[{"id":"e6e68103-1182-4bcb-85d5-702b37365fd3","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://open-api.omnichat.ai/v1/product-referral-links/info?ocsaid=c9ecaebe-7e50-4b9a-ae3c-e233390319dc:LP:639ace6c69c2b348ad6f6806","protocol":"https","host":["open-api","omnichat","ai"],"path":["v1","product-referral-links","info"],"query":[{"key":"ocsaid","value":"c9ecaebe-7e50-4b9a-ae3c-e233390319dc:LP:639ace6c69c2b348ad6f6806"}]}},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"agentName\": \"Sales Ken\",\n \"agentEmployeeCode\": \"S0001\",\n \"agentLocationName\": \"Shop A\",\n \"agentLocationCode\": \"S-001\",\n \"linkSentTime\": 1604650656053,\n \"linkClickedTime\": 1604650656053,\n \"linkTrackingMode\": \"sent\",\n \"linkLifetime\": 14\n }\n}"}],"_postman_id":"65442cc9-49bb-4eab-ad18-88e66c018162"},{"name":"Upload Roster","id":"6d7ed6ce-3f3d-4fde-bfa7-296f57fbbfac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","description":"API Token From Omnichat
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"month\": \"2023-04\",\n \"idField\": \"email\",\n \"records\": [\n {\n \"id\": \"A001\",\n \"locationCode\": \"locationCode-001\",\n \"time\": [\n {\n \"day\": 1,\n \"in\": \"09:30\",\n \"out\": \"18:30\"\n },\n {\n \"day\": 2,\n \"in\": \"09:30\",\n \"out\": \"18:30\"\n },\n {\n \"day\": 3,\n \"in\": \"09:30\",\n \"out\": \"18:30\"\n }\n ]\n },\n {\n \"id\": \"A002\",\n \"locationCode\": \"locationCode-001\",\n \"time\": [\n {\n \"day\": 1,\n \"in\": \"09:30\",\n \"out\": \"18:30\"\n },\n {\n \"day\": 2,\n \"in\": \"09:30\",\n \"out\": \"18:30\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/rosters","description":"Description
\nThis API allows you to upload salesperson roster to Omnichat
\nSubscription Required
\n- \n
- OMO Sales Cloud \n
- OMO Sales Open API Module \n
Request body
\nStaff Roster Record object
Roster Time Object
Responses
\nSuccess - HTTP Status 200 with empty response body
\nBad request - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\nAPI Token From Omnichat
\n","type":"text"}],"url":"https://open-api.omnichat.ai/v1/whatsapp-message-templates?page=1&pageSize=20&phone=85298765432","description":"Description
\nGet WhatsApp message templates
\nSubscription Required
\n- \n
- Marketing Could / Social CDP Cloud \n
- Marketing Open API Module \n
Responses
\nSuccess - HTTP Status 200 with the follow response body:
\nResponse object
\nWhatsAppMessageTemplate Objects
Bad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\nPage number. (Default: 1)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Number of templates per page. (Default: 20 ;Max: 100)
\n","type":"text/plain"},"key":"pageSize","value":"20"},{"description":{"content":"WhatsApp Business phone number
\n","type":"text/plain"},"key":"phone","value":"85298765432"}],"variable":[]}},"response":[{"id":"e25d90b3-5bd0-4459-982e-1fdd2613b327","name":"Get WhatsApp Templates","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","description":"API Token From Omnichat","type":"text"}],"url":{"raw":"https://open-api.omnichat.ai/v1/whatsapp-message-templates?page=1&pageSize=20&phone=85298765432","protocol":"https","host":["open-api","omnichat","ai"],"path":["v1","whatsapp-message-templates"],"query":[{"key":"page","value":"1","description":"Page number. (Default: 1)"},{"key":"pageSize","value":"20","description":"Number of templates per page. (Default: 20 ;Max: 100)"},{"key":"phone","value":"85298765432","description":"WhatsApp Business phone number"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"id\": \"1029152384366117\",\n \"category\": \"UTILITY\",\n \"status\": \"APPROVED\",\n \"name\": \"pre_order_message\",\n \"language\": \"zh_HK\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"text\": \"親愛的顧客：\\n\\n感謝您於網店的訂購！\\n\\n有關您的訂單（訂單編號：{{1}}）中訂購了 {{2}}件數預售產品\",\n \"example\": {\n \"body_text\": [\n [\n \"ORDER0001\",\n \"3\"\n ]\n ]\n }\n }\n ]\n },\n {\n \"id\": \"3862205883993025\",\n \"category\": \"MARKETING\",\n \"status\": \"APPROVED\",\n \"name\": \"autopush_eu\",\n \"language\": \"zh_HK\",\n \"components\": [\n {\n \"type\": \"BODY\",\n \"text\": \"多謝您的支持，請持續關注我們最新動態與優惠資訊。若有查詢，歡迎與我們聯絡喔！💖\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"立即預約測試\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"主目錄\"\n },\n {\n \"type\": \"QUICK_REPLY\",\n \"text\": \"專人服務\"\n }\n ]\n }\n ]\n },\n {\n \"id\": \"204650988695266\",\n \"category\": \"UTILITY\",\n \"status\": \"APPROVED\",\n \"name\": \"canceled_order_en\",\n \"language\": \"en\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"TEXT\",\n \"text\": \"Order cancelled\"\n },\n {\n \"type\": \"BODY\",\n \"text\": \"Order has been cancelled by store\\nOrder number：{{1}}\\nOrder amount：{{2}}$ {{3}}\\nPayment method：{{4}}\\nDelivery method：{{5}}\\nStore：{{6}}\\n*The link includes personal information, please do not share.\\n{{7}}\",\n \"example\": {\n \"body_text\": [\n [\n \"230601063333IRU\",\n \"HKD\",\n \"120\",\n \"online\",\n \"home-delivery\",\n \"Omnichat\",\n \"https://www.google.com.tw\"\n ]\n ]\n }\n }\n ]\n },\n {\n \"id\": \"3474989632786277\",\n \"category\": \"MARKETING\",\n \"status\": \"APPROVED\",\n \"name\": \"cart_abandonment_reminder_en\",\n \"language\": \"en_US\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"IMAGE\",\n \"example\": {\n \"header_handle\": [\n \"https://scontent.whatsapp.net/v/t61.29466-34/295221653_3474989639452943_5806187949635819452_n.jpg?ccb=1-7&_nc_sid=57045b&_nc_ohc=GP4r5ue28zkAX_ofKdM&_nc_ht=scontent.whatsapp.net&edm=AH51TzQEAAAA&oh=01_AdS2_FN15DXiw_DHqee6LNfsNhTUBKpkO5m3MRLt1nc5nA&oe=64E82E12\"\n ]\n }\n },\n {\n \"type\": \"BODY\",\n \"text\": \"{{1}}\\n{{2}}\\n{{3}}\\n\\nIf you do not want to receive WhatsApp message, please send \\\"Unsubscribe\\\"\",\n \"example\": {\n \"body_text\": [\n [\n \"Black Tee\",\n \"$29.99\",\n \"Checkout with coupon code ABC123 to enjoy 10% off discount!\"\n ]\n ]\n }\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"URL\",\n \"text\": \"View Product\",\n \"url\": \"https://api.omnichat.ai/restapi/v1/redirect/abandoned_cart_msg?url={{1}}\",\n \"example\": [\n \"https://api.omnichat.ai/restapi/v1/redirect/abandoned_cart_msg?url=https://apple.com\"\n ]\n }\n ]\n }\n ]\n },\n {\n \"id\": \"378881204331613\",\n \"category\": \"MARKETING\",\n \"status\": \"APPROVED\",\n \"name\": \"doc_test\",\n \"language\": \"en_US\",\n \"components\": [\n {\n \"type\": \"HEADER\",\n \"format\": \"DOCUMENT\",\n \"example\": {\n \"header_handle\": [\n \"https://scontent.whatsapp.net/v/t61.29466-34/299826941_378881207664946_3677727754011328572_n.pdf?ccb=1-7&_nc_sid=57045b&_nc_ohc=NOpL2ghaAB8AX8Lhvn0&_nc_ht=scontent.whatsapp.net&edm=AH51TzQEAAAA&oh=01_AdQn13farA6qGfiAmkTdLl3IhgbPIcsuvRtV-fa4f6C8-A&oe=64E8317C\"\n ]\n }\n },\n {\n \"type\": \"BODY\",\n \"text\": \"You can contact us via phone call\"\n },\n {\n \"type\": \"FOOTER\",\n \"text\": \"Brand A\"\n },\n {\n \"type\": \"BUTTONS\",\n \"buttons\": [\n {\n \"type\": \"PHONE_NUMBER\",\n \"text\": \"Contact Us\",\n \"phone_number\": \"+85200000000\"\n }\n ]\n }\n ]\n }\n ],\n \"totalElements\": 5\n}"}],"_postman_id":"911cc1b7-6c78-4413-9b52-6ed30fc85bbd"}],"id":"1be790f8-4024-46c1-afa6-e4781e1f3291","_postman_id":"1be790f8-4024-46c1-afa6-e4781e1f3291","description":""},{"name":"Rooms","item":[{"name":"Assign follow up agent","id":"70f26131-973d-452d-922c-5cb90574f743","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","description":"API Token From Omnichat
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"platform\": \"whatsapp\",\n \"channelId\": \"85250000001\",\n \"userId\": \"85215022101325\",\n \"agentEmail\": \"agent001@example.com\",\n \"agentPhone\": null,\n\t\"agentEmployeeCode\": \"EM0001\",\n\t\"agentShopLocationCode\": \"SHOP02\"\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/rooms/assign-agent","description":"Description
\nAssign follow up agent user to a contact
\nNote
\nif target room is a collaboration room and the target agent role is not CS role, the target agent must be assigned as a collaborator before assign-agent. Call /collaborator/assign first.
Subscription Required
\n- \n
Customer Service Could / Social CDP Cloud
\n \nCRM Open API Module
\n \n
Request body
\nResponses
\nSuccess - HTTP Status 204 with empty response body
\nBad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{ \"message\": \"OCE::<category>::<message>\" }\n\nError Response Examples
\nFor detailed error response examples, refer to: Assign agent - Error Response example
\n","urlObject":{"protocol":"https","path":["v1","rooms","assign-agent"],"host":["open-api","omnichat","ai"],"query":[],"variable":[]}},"response":[{"id":"9617e00e-bfd5-4a4b-a37f-d1bd673998dc","name":"Assign to CS user","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"platform\": \"whatsapp\",\n \"channelId\": \"85250000001\",\n \"userId\": \"85215022101325\",\n \"agentEmail\": null,\n \"agentPhone\": \"+85298765432\",\n \"agentEmployeeCode\": null,\n \"agentShopLocationCode\": null\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/rooms/assign-agent"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""},{"id":"8d3a65e3-1f07-4c15-9d07-c68103d454fc","name":"Assign to salesperson","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"platform\": \"whatsapp\",\n \"channelId\": \"85250000001\",\n \"userId\": \"85215022101325\",\n \"agentEmail\": null,\n \"agentPhone\": null,\n \"agentEmployeeCode\": \"EM0001\",\n \"agentShopLocationCode\": \"SHOP02\"\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/rooms/assign-agent"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"70f26131-973d-452d-922c-5cb90574f743"},{"name":"Assign collaborator","id":"d5c19faf-ed5b-46d6-88f2-6ab3512625dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","disabled":false},{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n \"platform\": \"whatsapp\",\n \"channelId\": \"85250000001\",\n \"userId\": \"85215022101325\",\n \"agentEmail\": \"agent001@example.com\",\n \"agentPhone\": null,\n \"agentEmployeeCode\": \"EM0001\",\n \"agentShopLocationCode\": \"SHOP02\"\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/rooms/assign-collaborator","description":"Description
\nAssign collaborator to a contact
\nSubscription Required
\n- \n
Customer Service Could / Social CDP Cloud
\n \nCRM Open API Module
\n \n
Request body
\nResponses
\nSuccess - HTTP Status 204 with empty response body
\nBad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{ \"message\": \"OCE::<category>::<message>\" }\n\n400 Bad Request
\n500 Internal Server Error
\n","urlObject":{"protocol":"https","path":["v1","rooms","assign-collaborator"],"host":["open-api","omnichat","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"d5c19faf-ed5b-46d6-88f2-6ab3512625dc"},{"name":"Unassign agent","id":"9ea26161-d084-48cc-9b6c-43a378562246","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","disabled":false},{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n \"platform\": \"whatsapp\",\n \"channelId\": \"85250000001\",\n \"userId\": \"85215022101325\"\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/rooms/unassign-agent","description":"Description
\nUnassign single sales role agent
\nSubscription Required
\n- \n
- Available for OMO teams only \n
Request body
\nResponses
\nSuccess - HTTP Status 204 with empty response body
\nBad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{ \"message\": \"OCE::<category>::<message>\" }\nError Response Examples
\nFor detailed error response examples, refer to: Unassign Agent - Error Response example
\n","urlObject":{"protocol":"https","path":["v1","rooms","unassign-agent"],"host":["open-api","omnichat","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"9ea26161-d084-48cc-9b6c-43a378562246"},{"name":"Unassign collaborator","id":"34bfee7a-c6bb-412a-81fa-90cf6d69b7a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","disabled":false},{"key":"Content-Type","value":"application/json","disabled":false}],"body":{"mode":"raw","raw":"{\n \"platform\": \"whatsapp\",\n \"channelId\": \"85250000001\",\n \"userId\": \"85215022101325\",\n \"agentEmail\": \"agent001@example.com\"\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/rooms/unassign-collaborator","description":"Description
\nUnassign collaborator from a contact
\nSubscription Required
\n- \n
Customer Service Could / Social CDP Cloud
\n \nCRM Open API Module
\n \n
Request body
\nResponses
\nSuccess - HTTP Status 204 with empty response body
\nBad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{ \"message\": \"OCE::<category>::<message>\" }\n\n400 Bad Request
\n500 Internal Server Error
\n","urlObject":{"protocol":"https","path":["v1","rooms","unassign-collaborator"],"host":["open-api","omnichat","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"34bfee7a-c6bb-412a-81fa-90cf6d69b7a8"}],"id":"7a869355-042c-4421-8d56-5c9877c5d5b8","_postman_id":"7a869355-042c-4421-8d56-5c9877c5d5b8","description":""},{"name":"Broadcast","item":[{"name":"Send broadcast","id":"b53ed761-e423-426a-b8f8-d6e94b8c3a00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","description":"API Token From Omnichat
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"subject\": \"Final Sales Promo\",\n \"platform\": \"line\",\n \"channelId\": \"12345678\",\n \"to\": [\n \"U1111111111111\",\n \"U2222222222222\"\n ],\n \"tags\": [\"sales-2023\"],\n \"messages\": [\n {\n \"type\": \"text\",\n \"text\": \"Final Sale Message 1\"\n },\n {\n \"type\": \"text\",\n \"text\": \"Final Sale Message 2\"\n },\n {\n \"type\": \"image\",\n \"image\": \"https://example.com/image.png\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/broadcast","description":"Description
\nSend broadcast message to multiple contacts
\nSubscription Required
\n- \n
- Marketing Could / Social CDP Cloud \n
- Marketing Open API Module \n
Request body
\nMessage object
Product Object
WhatsApp template Object
Please refer to Template Object in WhatsApp API Documentation.
Please refer to namespace in WhatsApp API Documentation Guide
Responses
\nSuccess - HTTP Status 200 with the follow body:
\nResponse content object
Bad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\nDescription
\nGet broadcast job list
\nSubscription Required
\n- \n
Marketing / Social CDP Could
\n \nMarketing Open API Module
\n \n
Query Parameters
\nResponses
\nSuccess - HTTP Status 200 with the follow response body:
\nResponse object
\nBroadcastJob Object
Bad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\n[Required] Messaging Platform
\n","type":"text/plain"},"key":"platform","value":"line"},{"description":{"content":"[Optional] Specific Messaging Platform Channel ID
\n","type":"text/plain"},"key":"channelId","value":""},{"description":{"content":"Page number. (Default: 1)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Number of contacts per page. (Default: 10 ;Max: 100)
\n","type":"text/plain"},"key":"pageSize","value":"10"},{"description":{"content":"[Optional] Broadcast job type
\n","type":"text/plain"},"key":"type","value":"1,3,4"}],"variable":[]}},"response":[{"id":"350edb1e-0551-42ee-9cce-af34ed169f0d","name":"Get broadcast list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://open-api.omnichat.ai/v1/broadcast?platform=line&channelId=&page=1&pageSize=10&type=1,3","protocol":"https","host":["open-api","omnichat","ai"],"path":["v1","broadcast"],"query":[{"key":"platform","value":"line","description":"[Required] Messaging Platform"},{"key":"channelId","value":"","description":"[Optional] Specific Messaging Platform Channel ID"},{"key":"page","value":"1","description":"Page number. Default: 1"},{"key":"pageSize","value":"10","description":"Number of contacts per page. Default: 10 (Max: 100)"},{"key":"type","value":"1,3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n\t\"content\": [\n\t\t{\n\t\t\t\"id\": \"9748a4b1-d106-4d67-bc1c-9fe6cb85a91b\",\n\t\t\t\"platform\": \"line\",\n\t\t\t\"channelId\": \"124321231\",\n\t\t\t\"channelName\": \"LINE OA 1\",\n\t\t\t\"subject\": \"Broadcast 1\",\n\t\t\t\"recipientType\": 1,\n\t\t\t\"type\": 1,\n\t\t\t\"mode\": \"filter\",\n\t\t\t\"sentAt\": \"2023-01-03T12:32:12\",\n\t\t\t\"status\": 1,\n \"recipientCount\": 1942,\n \"success\": 1491,\n \"successRate\": \"76.78%\",\n \"sent\": 1662,\n \"sentRate\": \"85.58%\",\n \"failed\": 280,\n \"failRate\": \"14.42%\",\n \"read\": 861,\n \"readRate\": \"57.75%\",\n \"clicked\": 9,\n \"clickRate\": \"0.60%\",\n\t\t\t\"purchase\": 1,\n\t\t\t\"revenue\": \"NT$10,234\",\n\t\t\t\"tags\": [\"cyn-broadcast\"]\n\t\t}\t\n\t],\n\t\"totalElements\": 20\n}"}],"_postman_id":"5cd5ff29-4464-4774-ab8e-a9888eaad7d2"},{"name":"Get broadcast details","id":"65888a59-2beb-4f9d-ae4e-e567d92c3e6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://open-api.omnichat.ai/v1/broadcast/:id","description":"Description
\nGet broadcast job details
\nSubscription Required
\n- \n
Marketing / Social CDP Could
\n \nMarketing Open API Module
\n \n
Path Parameters
\nResponses
\nSuccess - HTTP Status 200 with the follow response body:
\nResponse object
\nBroadcastJob Object
Bad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\nBroadcast job ID
\n","type":"text/plain"},"type":"any","value":"9748a4b1-d106-4d67-bc1c-9fe6cb85a91b","key":"id"}]}},"response":[{"id":"2435eb31-f520-4818-b414-0ae2de905720","name":"Get broadcast job details","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://open-api.omnichat.ai/v1/broadcast/:id","protocol":"https","host":["open-api","omnichat","ai"],"path":["v1","broadcast",":id"],"variable":[{"key":"id","value":"9748a4b1-d106-4d67-bc1c-9fe6cb85a91b","description":"Broadcast job ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"id\": \"9748a4b1-d106-4d67-bc1c-9fe6cb85a91b\",\n \"platform\": \"line\",\n \"channelId\": \"124321231\",\n \"channelName\": \"LINE OA 1\",\n \"subject\": \"Broadcast 1\",\n \"recipientType\": 2,\n \"type\": 1,\n \"mode\": \"filter\",\n \"sentAt\": \"2024-06-07T11:32:01\",\n \"status\": 1,\n \"recipientCount\": 1942,\n \"success\": 1491,\n \"successRate\": \"76.78%\",\n \"sent\": 1662,\n \"sentRate\": \"85.58%\",\n \"failed\": 280,\n \"failRate\": \"14.42%\",\n \"read\": 861,\n \"readRate\": \"57.75%\",\n \"clicked\": 9,\n \"clickRate\": \"0.60%\",\n \"revenue\": \"HK$ 0.00\",\n \"purchase\": 0,\n \"tags\": [],\n \"respondRate\": \"0.69%\",\n \"responded\": 342,\n \"unsubscribeRate\": \"0.02%\",\n \"unsubscribed\": 11,\n \"cost\": \"HK$ 34,707.40\",\n \"roas\": \"0.00%\",\n \"messageCount\": 57988,\n \"messageSuccess\": 49582,\n \"messageSuccessRate\": \"85.50%\",\n \"responseRateWithin12Hour\": \"0.35%\",\n \"responseRateWithin24Hour\": \"0.45%\",\n \"responseRateWithin48Hour\": \"0.69%\",\n \"respondedWithin12Hour\": 172,\n \"respondedWithin24Hour\": 223,\n \"respondedWithin48Hour\": 342\n }\n}"}],"_postman_id":"65888a59-2beb-4f9d-ae4e-e567d92c3e6c"},{"name":"Get broadcast recipient list","id":"22901cfb-0713-40a8-bad1-a8fa15423ad3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://open-api.omnichat.ai/v1/broadcast/:id/recipients?page=1&pageSize=10","urlObject":{"protocol":"https","path":["v1","broadcast",":id","recipients"],"host":["open-api","omnichat","ai"],"query":[{"key":"page","value":"1"},{"key":"pageSize","value":"10"}],"variable":[{"id":"87cb2852-cd02-4f28-94b4-a2ec805ed0cd","description":{"content":"Broadcast job ID
\n","type":"text/plain"},"type":"any","value":"9748a4b1-d106-4d67-bc1c-9fe6cb85a91b","key":"id"}]}},"response":[{"id":"1da71bde-c5a2-4cce-8648-cfefbbced37e","name":"Get broadcast job recipient list","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://open-api.omnichat.ai/v1/broadcast/:id/recipients?page=1&pageSize=10","protocol":"https","host":["open-api","omnichat","ai"],"path":["v1","broadcast",":id","recipients"],"query":[{"key":"page","value":"1"},{"key":"pageSize","value":"10"}],"variable":[{"key":"id","value":"9748a4b1-d106-4d67-bc1c-9fe6cb85a91b","description":"Broadcast job ID"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n\t\"content\": [\n\t\t{\n\t\t\t\"name\": \"Peter\",\n\t\t\t\"phone\": \"85291234567\",\n\t\t\t\"success\": true,\n\t\t\t\"sentAt\": \"2023-07-24T11:38:33\",\n\t\t\t\"clicked\": true,\n\t\t\t\"clickedAt\": \"\",\n\t\t\t\"read\": false,\n\t\t\t\"readAt\": null,\n\t\t\t\"responded\": false,\n\t\t\t\"respondedAt\": null,\n\t\t\t\"messageId\": \"wamid.HBgMODg2OTEyODY1OTcyFQIAERgSMkZBOUNDMkE4NEE2M0I3REQ0AA==\",\n\t\t\t\"error\": null\n\t\t},\n\t\t{\n\t\t\t\"name\": \"Mary\",\n\t\t\t\"phone\": \"85290000000\",\n\t\t\t\"success\": false,\n\t\t\t\"sentAt\": null,\n\t\t\t\"clicked\": false,\n\t\t\t\"clickedAt\": null,\n\t\t\t\"read\": false,\n\t\t\t\"readAt\": null,\n\t\t\t\"responded\": false,\n\t\t\t\"respondedAt\": null,\n\t\t\t\"messageId\": null,\n\t\t\t\"error\": \"Undeliverable\"\n\t\t}\n\t],\n\t\"totalElements\": 20\n}"}],"_postman_id":"22901cfb-0713-40a8-bad1-a8fa15423ad3"}],"id":"49cf808d-750f-41e9-8e81-a0689314d7a9","_postman_id":"49cf808d-750f-41e9-8e81-a0689314d7a9","description":""},{"name":"Customers","item":[{"name":"Get customer detail by member ID","id":"8dcb38fc-7b49-450b-82cb-8da23fde0520","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","description":"API Token From Omnichat
\n","type":"text"}],"url":"https://open-api.omnichat.ai/v1/customers?memberId={{memberId}}","description":"Description
\nThis API allows you to get the customer details by Member ID
\nSubscription Required
\n- \n
CS / Marketing / OMO Sales / Social CDP Could
\n \nCRM Open API Module
\n \n
Parameters
\nResponses
\nSuccess - HTTP Status 200 with the follow response body:
\nResponse object
\nCustomer Object
Custom Attribute Objects
Bad request - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"MISSING_URL_PARAMETER\",\n \"message\": \"Missing URL parameters\"\n}\n\nCustomer's member ID
\n","type":"text/plain"},"key":"memberId","value":"{{memberId}}"}],"variable":[]}},"response":[{"id":"0541adef-b564-4ea8-bbfb-3eda63d1fe36","name":"Get customer detail by member ID","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","description":"API Token From Omnichat","type":"text"}],"url":{"raw":"https://open-api.omnichat.ai/v1/customers?memberId={{memberId}}","protocol":"https","host":["open-api","omnichat","ai"],"path":["v1","customers"],"query":[{"key":"memberId","value":"{{memberId}}","description":"Customer's member ID"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": {\n \"username\": \"6694e599b4dadc211e33f9da\",\n \"name\": \"Peter Chan\",\n \"profilePicture\": \"https://example.com/profile.png\",\n \"memberId\": \"OC-TEST-0001\",\n \"phone\": \"85222222222\",\n \"email\": \"example@omnichat.ai\",\n \"socialChannelSubscribed\": true,\n \"tags\": [\n \"VVIP\",\n \"Sporty\"\n ],\n \"reachable\": true,\n \"customAttributes\": [\n {\n \"key\": \"gender\",\n \"type\": 1,\n \"value\": \"male\",\n \"displayName\": \"Gender\",\n \"status\": true\n },\n {\n \"key\": \"total_spending\",\n \"type\": 2,\n \"value\": 120321.11,\n \"displayName\": \"Total Spending\",\n \"status\": true\n },\n {\n \"key\": \"date_01\",\n \"type\": 3,\n \"value\": \"2025-11-11\",\n \"displayName\": \"Date field\",\n \"status\": true\n },\n {\n \"key\": \"date_time_01\",\n \"type\": 4,\n \"value\": \"2024-11-18 05:15:48\",\n \"displayName\": \"Date time field\",\n \"status\": true\n },\n {\n \"key\": \"boolean_field\",\n \"type\": 5,\n \"value\": false,\n \"displayName\": \"Boolean Field\",\n \"status\": true\n }\n ],\n \"linkedUsers\": [\n {\n \"platform\": \"line\",\n \"channelId\": \"1111111111111\",\n \"channelUserId\": \"U0000000000000000000000\",\n \"channelUsername\": \"liu0000000000000000000000\",\n \"channelName\": \"LINE channel name\",\n \"roomId\": \"li1111111111111-u0000000000000000000000\",\n \"subscribed\": true\n },\n {\n \"platform\": \"whatsapp\",\n \"channelId\": \"85211111111\",\n \"channelUserId\": \"85222222222\",\n \"channelUsername\": \"wh24e3c17b-fa49-403a-a3de-398831f39394-85222222222\",\n \"channelName\": \"WhatsApp Business Name\",\n \"roomId\": \"wh24e3c17b-fa49-403a-a3de-398831f39394-85222222222\",\n \"subscribed\": true\n }\n ],\n \"pointBalance\": \"1\",\n \"accumulatedPoints\": \"1\",\n \"lastMessageReceivedAt\": 1742196237835,\n \"lastCsMessageSentAt\": 1729564624123,\n \"lastMarketingMessageSentAt\": 1736236655000,\n \"createdAt\": 1679037836356,\n \"updatedAt\": 1743387002575\n }\n}"}],"_postman_id":"8dcb38fc-7b49-450b-82cb-8da23fde0520"},{"name":"Upsert a Customer by member ID","id":"d95c7106-310a-402c-acde-dfd8681368c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","description":"API Token From Omnichat
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Peter Chan\",\n\t\"email\": \"example@example.com\",\n\t\"phone\": \"85298765432\",\n \"tagsToAdd\": [ \"VVIP\", \"Sporty\" ],\n \"tagsToRemove\": [ \"VIP\" ],\n\t\"customAttributes\": [\n\t\t{ \"key\": \"MemberTier\", \"value\": \"GOLD\" },\n\t\t{ \"key\": \"Points\", \"value\": 2031 },\n\t\t{ \"key\": \"TotalSpending\", \"value\": 900.00 },\n\t\t{ \"key\": \"AcceptedMarketingPromotion\", \"value\": true },\n\t\t{ \"key\": \"LastPurchaseDate\", \"value\": \"2022-11-01\" },\n\t\t{ \"key\": \"RegisterDatetime\", \"value\": \"2022-11-01T14:16:00\" }\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/customers?memberId={{memberId}}","description":"Description
\nThis API allows you to create or update a customer by Member ID
\nSubscription Required
\n- \n
- CS / Marketing / OMO Sales / Social CDP Could \n
- CRM Open API Module \n
Parameters
\nRequest Body
\nCustom Attribute Objects
Responses
\nSuccess - HTTP Status 204 with empty response body
\nBad request - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"MISSING_URL_PARAMETER\",\n \"message\": \"Missing URL parameters\"\n}\n\nCustomer's member ID
\n","type":"text/plain"},"key":"memberId","value":"{{memberId}}"}],"variable":[]}},"response":[],"_postman_id":"d95c7106-310a-402c-acde-dfd8681368c2"},{"name":"Upsert a Customer by omniCustomerId","id":"099492bd-2bf0-47d1-b1b6-09c4b8f8e09d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","description":"API Token From Omnichat
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"name\": \"Peter Chan\",\n\t\"email\": \"example@example.com\",\n\t\"phone\": \"85298765432\",\n \"tagsToAdd\": [ \"VVIP\", \"Sporty\" ],\n \"tagsToRemove\": [ \"VIP\" ],\n\t\"customAttributes\": [\n\t\t{ \"key\": \"MemberTier\", \"value\": \"GOLD\" },\n\t\t{ \"key\": \"Points\", \"value\": 2031 },\n\t\t{ \"key\": \"TotalSpending\", \"value\": 900.00 },\n\t\t{ \"key\": \"AcceptedMarketingPromotion\", \"value\": true },\n\t\t{ \"key\": \"LastPurchaseDate\", \"value\": \"2022-11-01\" },\n\t\t{ \"key\": \"RegisterDatetime\", \"value\": \"2022-11-01T14:16:00\" }\n\t]\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/customers?omniCustomerId={{omniCustomerId}}","description":"Description
\nThis API allows you to create or update a customer by OmniCustomer ID
\nSubscription Required
\n- \n
CS / Marketing / OMO Sales / Social CDP Could
\n \nCRM Open API Module
\n \n
Parameters
\nRequest Body
\nCustom Attribute Objects
Responses
\nSuccess - HTTP Status 204 with empty response body
\nBad request - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"MISSING_URL_PARAMETER\",\n \"message\": \"Missing URL parameters\"\n}\n\nAPI Token From Omnichat
\n","type":"text"}],"url":"https://open-api.omnichat.ai/v1/customers?memberId={{memberID}}","description":"Description
\nThis API allows you to delete a customer data (including member profile & chat history) by Member ID
\nSubscription Required
\n- \n
CS / Marketing / OMO Sales / Social CDP Could
\n \nCRM Open API Module
\n \n
Query Parameters
\nResponses
\nSuccess - HTTP Status 204 with empty response body
\nBad request / Internal Server Error - HTTP Status 4xx / 5xx
\n{\n \"errorCode\": \"\",\n \"message\": \"\"\n}\n\nContact's member ID
\n","type":"text/plain"},"key":"memberId","value":"{{memberID}}"}],"variable":[]}},"response":[],"_postman_id":"4f47a8a2-919a-4b0a-9b06-01b52051aa6a"}],"id":"47809bae-e893-4dc0-baf2-66a86b496b54","_postman_id":"47809bae-e893-4dc0-baf2-66a86b496b54","description":""},{"name":"WhatsApp Message Webhook","item":[{"name":"Message Status","item":[{"name":"Status: Message Sent","id":"27acf038-a51f-4278-9140-76ea575d2eac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"{{WHATSAPP-BUSINESS-ACCOUNT-ID}}\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"{{BUSINESS-PHONE-NUMBER}}\",\n \"phone_number_id\": \"{{BUSINESS-PHONE-NUMBER-ID}}\"\n },\n\n // Contacts will be included for sent, delivered, and read status\n \"contacts\": [ // ADDED\n {\n \"profile\": {\n \"name\": \"{{USER-DISPLAY-NAME}}\", // ADDED // Only included if user has enabled the username feature\n \"username\": \"{{USERNAME}}\" // ADDED\n },\n \"wa_id\": \"{{USER-PHONE-NUMBER}}\", // ADDED\n \"user_id\": \"{{BSUID}}\", // ADDED // Only included if parent BSUIDs enabled\n \"parent_user_id\": \"{{PARENT-BSUID}}\" // ADDED\n }\n ],\n\n \"statuses\": [\n {\n \"id\": \"{{MESSAGE-ID}}\",\n \"conversation\": {\n \"expiration_timestamp\": \"1692148560\",\n \"origin\": {\n \"type\": \"{{CONVERSATION-CATEGORY}}\"\n },\n \"id\": \"{{CONVERSATION-ID}}\"\n },\n \"pricing\": {\n \"pricing_model\": \"CBP\",\n \"category\": \"{{CONVERSATION-CATEGORY}}\",\n \"billable\": true\n },\n \"status\": \"sent\",\n \"timestamp\": \"1692064412\",\n \"recipient_id\": \"{{RECIPIENT-PHONE-NUMBER}}\", // CHANGED\n \"recipient_user_id\": \"{{BSUID}}\", // ADDED // Only included if parent BSUIDs enabled\n \"parent_recipient_user_id\": \"{{PARENT-BSUID}}\" // ADDED\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"text"}}},"url":"https://your-webhook-url.com/whatsapp-webhook","description":"The following notification is received when a business sends a message
\n","urlObject":{"protocol":"https","path":["whatsapp-webhook"],"host":["your-webhook-url","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"27acf038-a51f-4278-9140-76ea575d2eac"},{"name":"Status: Message Delivered","id":"fe5b772d-aae1-4fc5-bdf3-cd2aad8b58f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"{{WHATSAPP-BUSINESS-ACCOUNT-ID}}\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"{{BUSINESS-PHONE-NUMBER}}\",\n \"phone_number_id\": \"{{BUSINESS-PHONE-NUMBER-ID}}\"\n },\n\n // Contacts will be included for sent, delivered, and read status\n \"contacts\": [ // ADDED\n {\n \"profile\": {\n \"name\": \"{{USER-DISPLAY-NAME}}\", // ADDED // Only included if user has enabled the username feature\n \"username\": \"{{USERNAME}}\" // ADDED\n },\n \"wa_id\": \"{{USER-PHONE-NUMBER}}\", // ADDED\n \"user_id\": \"{{BSUID}}\", // ADDED // Only included if parent BSUIDs enabled\n \"parent_user_id\": \"{{PARENT-BSUID}}\" // ADDED\n }\n ],\n\n \"statuses\": [\n {\n \"id\": \"{{MESSAGE-ID}}\",\n \"conversation\": {\n \"expiration_timestamp\": \"1692148560\",\n \"origin\": {\n \"type\": \"{{CONVERSATION-CATEGORY}}\"\n },\n \"id\": \"{{CONVERSATION-ID}}\"\n },\n \"pricing\": {\n \"pricing_model\": \"CBP\",\n \"category\": \"{{CONVERSATION-CATEGORY}}\",\n \"billable\": true\n },\n \"status\": \"delivered\",\n \"timestamp\": \"1692064412\",\n \"recipient_id\": \"{{RECIPIENT-PHONE-NUMBER}}\", // CHANGED\n \"recipient_user_id\": \"{{BSUID}}\", // ADDED // Only included if parent BSUIDs enabled\n \"parent_recipient_user_id\": \"{{PARENT-BSUID}}\" // ADDED\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"text"}}},"url":"https://your-webhook-url.com/whatsapp-webhook","description":"The following notification is received when a business’ message is delivered
\n","urlObject":{"protocol":"https","path":["whatsapp-webhook"],"host":["your-webhook-url","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fe5b772d-aae1-4fc5-bdf3-cd2aad8b58f4"},{"name":"Status: Message Read","id":"77a88973-4c33-476b-8812-f85ac3be5c20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"{{WHATSAPP-BUSINESS-ACCOUNT-ID}}\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"{{BUSINESS-PHONE-NUMBER}}\",\n \"phone_number_id\": \"{{BUSINESS-PHONE-NUMBER-ID}}\"\n },\n\n // Contacts will be included for sent, delivered, and read status\n \"contacts\": [ // ADDED\n {\n \"profile\": {\n \"name\": \"{{USER-DISPLAY-NAME}}\", // ADDED // Only included if user has enabled the username feature\n \"username\": \"{{USERNAME}}\" // ADDED\n },\n \"wa_id\": \"{{USER-PHONE-NUMBER}}\", // ADDED\n \"user_id\": \"{{BSUID}}\", // ADDED // Only included if parent BSUIDs enabled\n \"parent_user_id\": \"{{PARENT-BSUID}}\" // ADDED\n }\n ],\n\n \"statuses\": [\n {\n \"id\": \"{{MESSAGE-ID}}\",\n \"status\": \"read\",\n \"timestamp\": \"{{TIMESTAMP}}\",\n \"recipient_id\": \"{{RECIPIENT-PHONE-NUMBER}}\", // CHANGED\n \"recipient_user_id\": \"{{BSUID}}\", // ADDED // Only included if parent BSUIDs enabled\n \"parent_recipient_user_id\": \"{{PARENT-BSUID}}\" // ADDED\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"text"}}},"url":"https://your-webhook-url.com/whatsapp-webhook","description":"The following notification is received when a business’ message is read
\n","urlObject":{"protocol":"https","path":["whatsapp-webhook"],"host":["your-webhook-url","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"77a88973-4c33-476b-8812-f85ac3be5c20"},{"name":"Status: Message Failed","id":"6bb43b13-b338-4500-8d88-03fc89b3fa05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"{{WHATSAPP-BUSINESS-ACCOUNT-ID}}\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"{{BUSINESS-PHONE-NUMBER}}\",\n \"phone_number_id\": \"{{BUSINESS-PHONE-NUMBER-ID}}\"\n },\n \"statuses\": [\n {\n \"id\": \"wamid.ID\",\n \"status\": \"failed\",\n \"timestamp\": \"1712721774\",\n \"recipient_id\": \"{{RECIPIENT-PHONE-NUMBER}}\", // CHANGED\n \"recipient_user_id\": \"{{BSUID}}\", // ADDED // Only included if parent BSUIDs enabled\n \"parent_recipient_user_id\": \"{{PARENT-BSUID}}\", // ADDED\n \"errors\": [\n {\n \"code\": 131014,\n \"title\": \"Request for url https://URL.jpg failed with error: 404 (Not Found)\"\n }\n ]\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"text"}}},"url":"https://your-webhook-url.com/whatsapp-webhook","description":"The following notification shows a Webhook with failed status
\n","urlObject":{"protocol":"https","path":["whatsapp-webhook"],"host":["your-webhook-url","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6bb43b13-b338-4500-8d88-03fc89b3fa05"},{"name":"Status: Message Deleted","id":"3fd48738-6709-44c6-94a2-1bb933832f3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"{{WHATSAPP-BUSINESS-ACCOUNT-ID}}\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"{{BUSINESS-PHONE-NUMBER}}\",\n \"phone_number_id\": \"{{BUSINESS-PHONE-NUMBER-ID}}\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"NAME\"\n },\n \"wa_id\": \"{{RECIPIENT-PHONE-NUMBER}}\"\n }\n ],\n \"messages\": [\n {\n \"from\": \"{{RECIPIENT-PHONE-NUMBER}}\",\n \"id\": \"{{MESSAGE-ID}}\",\n \"timestamp\": \"1712721774\",\n \"errors\": [\n {\n \"code\": 131051,\n \"details\": \"Message type is not currently supported\",\n \"title\": \"Unsupported message type\"\n }\n ],\n \"type\": \"unsupported\"\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://your-webhook-url.com/whatsapp-webhook","description":"Currently, the Cloud API does not support webhook status updates for deleted messages. If a user deletes a message, you will receive a webhook with an error code for an unsupported message type:
\n","urlObject":{"protocol":"https","path":["whatsapp-webhook"],"host":["your-webhook-url","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3fd48738-6709-44c6-94a2-1bb933832f3a"}],"id":"94b596b0-5abe-43d6-b9ee-10b6767787e5","_postman_id":"94b596b0-5abe-43d6-b9ee-10b6767787e5","description":""},{"name":"Message","item":[{"name":"Received Text Message","id":"c7f9895a-be4a-4462-80de-2b376cb5ffb9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"{{WHATSAPP-BUSINESS-ACCOUNT-ID}}\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"{{BUSINESS-PHONE-NUMBER}}\",\n \"phone_number_id\": \"{{BUSINESS-PHONE-NUMBER-ID}}\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"{{WHATSAPP-USER-PROFILE-NAME}}\",\n \"username\": \"{{USERNAME}}\" // ADDED - Only included if user has enabled the username feature\n },\n \"wa_id\": \"{{WHATSAPP-USER-ID}}\", // CHANGED\n \"user_id\": \"{{BSUID}}\", // ADDED\n \"parent_user_id\": \"{{PARENT-BSUID}}\" // ADDED - Only included if parent BSUIDs enabled\n }\n ],\n \"messages\": [\n {\n \"from\": \"{{WHATSAPP-USER-PHONE-NUMBER}}\", // CHANGED\n \"from_user_id\": \"{{BSUID}}\", // ADDED\n \"from_parent_user_id\": \"{{PARENT-BSUID}}\", // ADDED\n \"group_id\": \"{{GROUP-ID}}\", // ADDED - Only included if incoming message sent in a group\n \"id\": \"{{MESSAGE-ID}}\",\n \"timestamp\": \"1603059201\",\n \"text\": {\n \"body\": \"Hello this is an answer\"\n },\n \"type\": \"text\"\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"text"}}},"url":"https://your-webhook-url.com/whatsapp-webhook","description":"The following is an example of a text message you received from a customer
\n","urlObject":{"protocol":"https","path":["whatsapp-webhook"],"host":["your-webhook-url","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c7f9895a-be4a-4462-80de-2b376cb5ffb9"},{"name":"Received Message with Reaction","id":"f3e94b76-e5a0-4188-9f70-60fbc771952d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"{{WHATSAPP-BUSINESS-ACCOUNT-ID}}\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"{{BUSINESS-PHONE-NUMBER}}\",\n \"phone_number_id\": \"{{BUSINESS-PHONE-NUMBER-ID}}\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"{{WHATSAPP-USER-PROFILE-NAME}}\",\n \"username\": \"{{USERNAME}}\" // ADDED - Only included if user has enabled the username feature\n },\n \"wa_id\": \"{{WHATSAPP-USER-ID}}\", // CHANGED\n \"user_id\": \"{{BSUID}}\", // ADDED\n \"parent_user_id\": \"{{PARENT-BSUID}}\" // ADDED - Only included if parent BSUIDs enabled\n }\n ],\n \"messages\": [\n {\n \"from\": \"{{WHATSAPP-USER-PHONE-NUMBER}}\", // CHANGED\n \"from_user_id\": \"{{BSUID}}\", // ADDED\n \"from_parent_user_id\": \"{{PARENT-BSUID}}\", // ADDED\n \"group_id\": \"{{GROUP-ID}}\", // ADDED - Only included if incoming message sent in a group\n \"id\": \"{{MESSAGE-ID}}\",\n \"timestamp\": \"1603059201\",\n \"type\": \"reaction\",\n \"reaction\": {\n \"emoji\": \"If the message being reacted to is more than 30 days old the reaction message webhook will not be delivered. Note that for reactions, the timestamp value indicates when the customer sent the reaction, not when the Webhook was generated.
When a message with media is received, the WhatsApp Business API downloads the media. A notification is sent to your Webhook once the media is downloaded.
\nThe Webhook notification contains information that identifies the media object and enables you to find and retrieve the object.
\n","urlObject":{"protocol":"https","path":["whatsapp-webhook"],"host":["your-webhook-url","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d1470a60-017f-4dae-890b-4d0970e72088"},{"name":"Received Media Message with Sticker","id":"64591950-d753-4cc1-937b-94ed06a56cf2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"{{WHATSAPP-BUSINESS-ACCOUNT-ID}}\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"{{BUSINESS-PHONE-NUMBER}}\",\n \"phone_number_id\": \"{{BUSINESS-PHONE-NUMBER-ID}}\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"{{WHATSAPP-USER-PROFILE-NAME}}\",\n \"username\": \"{{USERNAME}}\" // ADDED - Only included if user has enabled the username feature\n },\n \"wa_id\": \"{{WHATSAPP-USER-ID}}\", // CHANGED\n \"user_id\": \"{{BSUID}}\", // ADDED\n \"parent_user_id\": \"{{PARENT-BSUID}}\" // ADDED - Only included if parent BSUIDs enabled\n }\n ],\n \"messages\": [\n {\n \"from\": \"{{WHATSAPP-USER-PHONE-NUMBER}}\", // CHANGED\n \"from_user_id\": \"{{BSUID}}\", // ADDED\n \"from_parent_user_id\": \"{{PARENT-BSUID}}\", // ADDED\n \"group_id\": \"{{GROUP-ID}}\", // ADDED - Only included if incoming message sent in a group\n \"id\": \"{{MESSAGE-ID}}\",\n \"timestamp\": \"1603059201\",\n \"type\": \"sticker\",\n \"sticker\": {\n \"id\": \"When you receive a media message containing a sticker, WhatsApp Business API downloads the sticker and a notification is sent to your Webhook once the sticker is downloaded.
\nThe Webhook notification contains information that identifies the media object and allows you to find and retrieve the object.
\n","urlObject":{"protocol":"https","path":["whatsapp-webhook"],"host":["your-webhook-url","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"64591950-d753-4cc1-937b-94ed06a56cf2"},{"name":"Received Contact Messages","id":"7262c14f-0dfa-446c-a9e2-c60f47d2125e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"{{WHATSAPP-BUSINESS-ACCOUNT-ID}}\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"{{BUSINESS-PHONE-NUMBER}}\",\n \"phone_number_id\": \"{{BUSINESS-PHONE-NUMBER-ID}}\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"{{WHATSAPP-USER-PROFILE-NAME}}\",\n \"username\": \"{{USERNAME}}\" // ADDED - Only included if user has enabled the username feature\n },\n \"wa_id\": \"{{WHATSAPP-USER-ID}}\", // CHANGED\n \"user_id\": \"{{BSUID}}\", // ADDED\n \"parent_user_id\": \"{{PARENT-BSUID}}\" // ADDED - Only included if parent BSUIDs enabled\n }\n ],\n \"messages\": [\n {\n \"from\": \"{{WHATSAPP-USER-PHONE-NUMBER}}\", // CHANGED\n \"from_user_id\": \"{{BSUID}}\", // ADDED\n \"from_parent_user_id\": \"{{PARENT-BSUID}}\", // ADDED\n \"group_id\": \"{{GROUP-ID}}\", // ADDED - Only included if incoming message sent in a group\n \"id\": \"{{MESSAGE-ID}}\",\n \"timestamp\": \"1603059201\",\n \"type\": \"contacts\",\n \"contacts\": [\n {\n \"addresses\": [\n {\n \"city\": \"The following is an example of a contact message you received from a customer.
\n","urlObject":{"protocol":"https","path":["whatsapp-webhook"],"host":["your-webhook-url","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7262c14f-0dfa-446c-a9e2-c60f47d2125e"},{"name":"Received Static Location Messages","id":"cb77697c-20f3-493b-85ac-b29f1f47bf0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"{{WHATSAPP-BUSINESS-ACCOUNT-ID}}\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"{{BUSINESS-PHONE-NUMBER}}\",\n \"phone_number_id\": \"{{BUSINESS-PHONE-NUMBER-ID}}\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"{{WHATSAPP-USER-PROFILE-NAME}}\",\n \"username\": \"{{USERNAME}}\" // ADDED - Only included if user has enabled the username feature\n },\n \"wa_id\": \"{{WHATSAPP-USER-ID}}\", // CHANGED\n \"user_id\": \"{{BSUID}}\", // ADDED\n \"parent_user_id\": \"{{PARENT-BSUID}}\" // ADDED - Only included if parent BSUIDs enabled\n }\n ],\n \"messages\": [\n {\n \"from\": \"{{WHATSAPP-USER-PHONE-NUMBER}}\", // CHANGED\n \"from_user_id\": \"{{BSUID}}\", // ADDED\n \"from_parent_user_id\": \"{{PARENT-BSUID}}\", // ADDED\n \"group_id\": \"{{GROUP-ID}}\", // ADDED - Only included if incoming message sent in a group\n \"id\": \"{{MESSAGE-ID}}\",\n \"timestamp\": \"1603059201\",\n \"type\": \"location\",\n \"location\": {\n \"latitude\": \"The following is an example of a static location message you received from a customer.
\n","urlObject":{"protocol":"https","path":["whatsapp-webhook"],"host":["your-webhook-url","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cb77697c-20f3-493b-85ac-b29f1f47bf0a"},{"name":"Received Message Triggered by Click to WhatsApp Ads","id":"75bb96ef-8fda-4ee6-b5b7-aef344db904d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"{{WHATSAPP-BUSINESS-ACCOUNT-ID}}\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"{{BUSINESS-PHONE-NUMBER}}\",\n \"phone_number_id\": \"{{BUSINESS-PHONE-NUMBER-ID}}\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"{{WHATSAPP-USER-PROFILE-NAME}}\",\n \"username\": \"{{USERNAME}}\" // ADDED - Only included if user has enabled the username feature\n },\n \"wa_id\": \"{{WHATSAPP-USER-ID}}\", // CHANGED\n \"user_id\": \"{{BSUID}}\", // ADDED\n \"parent_user_id\": \"{{PARENT-BSUID}}\" // ADDED - Only included if parent BSUIDs enabled\n }\n ],\n \"messages\": [\n {\n \"from\": \"{{WHATSAPP-USER-PHONE-NUMBER}}\", // CHANGED\n \"from_user_id\": \"{{BSUID}}\", // ADDED\n \"from_parent_user_id\": \"{{PARENT-BSUID}}\", // ADDED\n \"group_id\": \"{{GROUP-ID}}\", // ADDED - Only included if incoming message sent in a group\n \"id\": \"{{MESSAGE-ID}}\",\n \"timestamp\": \"1603059201\",\n \"type\": \"text\",\n \"text\": {\n \"body\": \"\"\n },\n \"referral\": {\n \"source_url\": \"It’s possible to receive an unknown message callback notification. The following is an example of a message you received from a customer that is not supported.
\n","urlObject":{"protocol":"https","path":["whatsapp-webhook"],"host":["your-webhook-url","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"051589b5-39b8-4cb0-a56d-a416125dd995"},{"name":"Received Callback from a Quick Reply Button Click","id":"b87c5b55-f3cd-4f88-b7f8-877afe359575","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"{{WHATSAPP-BUSINESS-ACCOUNT-ID}}\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"{{BUSINESS-PHONE-NUMBER}}\",\n \"phone_number_id\": \"{{BUSINESS-PHONE-NUMBER-ID}}\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"{{WHATSAPP-USER-PROFILE-NAME}}\",\n \"username\": \"{{USERNAME}}\" // ADDED - Only included if user has enabled the username feature\n },\n \"wa_id\": \"{{WHATSAPP-USER-ID}}\", // CHANGED\n \"user_id\": \"{{BSUID}}\", // ADDED\n \"parent_user_id\": \"{{PARENT-BSUID}}\" // ADDED - Only included if parent BSUIDs enabled\n }\n ],\n \"messages\": [\n {\n \"context\": {\n \"from\": \"16505553333\",\n \"id\": \"{{REFERER-MESSAGE-ID}}\"\n },\n \"from\": \"{{WHATSAPP-USER-PHONE-NUMBER}}\", // CHANGED\n \"from_user_id\": \"{{BSUID}}\", // ADDED\n \"from_parent_user_id\": \"{{PARENT-BSUID}}\", // ADDED\n \"group_id\": \"{{GROUP-ID}}\", // ADDED - Only included if incoming message sent in a group\n \"id\": \"{{MESSAGE-ID}}\",\n \"timestamp\": \"1603059201\",\n \"type\": \"button\",\n \"button\": {\n \"text\": \"No\",\n \"payload\": \"No-Button-Payload\"\n }\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"text"}}},"url":"https://your-webhook-url.com/whatsapp-webhook","description":"When your customer clicks on a quick reply button in an interactive message template, a response is sent. Below is an example of the callback format.
\n","urlObject":{"protocol":"https","path":["whatsapp-webhook"],"host":["your-webhook-url","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b87c5b55-f3cd-4f88-b7f8-877afe359575"},{"name":"Received Product Enquiry Message","id":"6cf3152b-e73c-4ffe-8113-46a143d352b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"object\": \"whatsapp_business_account\",\n \"entry\": [\n {\n \"id\": \"{{WHATSAPP-BUSINESS-ACCOUNT-ID}}\",\n \"changes\": [\n {\n \"value\": {\n \"messaging_product\": \"whatsapp\",\n \"metadata\": {\n \"display_phone_number\": \"{{BUSINESS-PHONE-NUMBER}}\",\n \"phone_number_id\": \"{{BUSINESS-PHONE-NUMBER-ID}}\"\n },\n \"contacts\": [\n {\n \"profile\": {\n \"name\": \"{{WHATSAPP-USER-PROFILE-NAME}}\",\n \"username\": \"{{USERNAME}}\" // ADDED - Only included if user has enabled the username feature\n },\n \"wa_id\": \"{{WHATSAPP-USER-ID}}\", // CHANGED\n \"user_id\": \"{{BSUID}}\", // ADDED\n \"parent_user_id\": \"{{PARENT-BSUID}}\" // ADDED - Only included if parent BSUIDs enabled\n }\n ],\n \"messages\": [\n {\n \"from\": \"{{WHATSAPP-USER-PHONE-NUMBER}}\", // CHANGED\n \"from_user_id\": \"{{BSUID}}\", // ADDED\n \"from_parent_user_id\": \"{{PARENT-BSUID}}\", // ADDED\n \"group_id\": \"{{GROUP-ID}}\", // ADDED - Only included if incoming message sent in a group\n \"id\": \"{{MESSAGE-ID}}\",\n \"timestamp\": \"1603059201\",\n \"type\": \"text\",\n \"text\": {\n \"body\": \"MESSAGE_TEXT\"\n },\n \"context\": {\n \"from\": \"PHONE_NUMBER\",\n \"id\": \"{{REFERER-MESSAGE-ID}}\",\n \"referred_product\": {\n \"catalog_id\": \"CATALOG_ID\",\n \"product_retailer_id\": \"PRODUCT_ID\"\n }\n }\n }\n ]\n },\n \"field\": \"messages\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"text"}}},"url":"https://your-webhook-url.com/whatsapp-webhook","description":"A Product Enquiry Message is received when a user is asking for more information about a specific product. These can be received as in two scenarios:
\n- When a customer replies to Single or Multi-Product Messages
- When a customer accesses a business’ catalog through another entry point, navigates to a Product Details Page, and clicks Message Business about this Product.
API Token From Omnichat
\n","type":"text"}],"url":"https://open-api.omnichat.ai/v1/system-users","urlObject":{"protocol":"https","path":["v1","system-users"],"host":["open-api","omnichat","ai"],"query":[],"variable":[]}},"response":[{"id":"473e9a65-0bb3-4fbf-86be-bb562a87ad99","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","description":"API Token From Omnichat","type":"text"}],"url":"https://open-api.omnichat.ai/v1/system-users"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"team\": \"Omnichat\",\n \"username\": \"1d9e3925-f08c-4236-92ef-b4c5394c9a14\",\n \"email\": \"john.doe@omnichat.ai\",\n \"phone\": \"+85212345678\",\n \"profilePicture\": \"https://media-cdn.omnichat.ai/upload/photos/user-upload-photo/1d9e3925-f08c-4236-92ef-b4c5394c9a14.png\",\n \"available\": true,\n \"status\": 1,\n \"role\": 7,\n \"name\": \"John Doe\",\n \"employeeCode\": \"E0001\",\n \"shops\": [\n {\n \"id\": \"60fd8409892243037e17f1d2\",\n \"code\": \"A01\",\n \"name\": \"Shop A01\",\n \"categories\": []\n }\n ]\n },\n {\n \"team\": \"Omnichat\",\n \"username\": \"e5255710-1701-4876-ac22-1d0da7f9291c\",\n \"email\": \"peter.pan@omnichat.ai\",\n \"phone\": null,\n \"profilePicture\": null,\n \"available\": true,\n \"status\": 1,\n \"role\": 7,\n \"name\": \"Peter Pan\",\n \"employeeCode\": null,\n \"shops\": null\n }\n ]\n}"}],"_postman_id":"d5a45c38-5650-4999-b2c6-19603a7bac5f"}],"id":"976efcb7-9858-45a6-8bac-0942f697d2f2","_postman_id":"976efcb7-9858-45a6-8bac-0942f697d2f2","description":""},{"name":"Tag","item":[{"name":"Get tagging log records","id":"08ecab47-a8da-4bbc-a384-15522d6c9a64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","description":"API Token From Omnichat
\n","type":"text"}],"url":"https://open-api.omnichat.ai/v1/tagging-logs/records?taggedAfter=1742087630000&taggedBefore=1742202830000&page=1&pageSize=20","description":"Description
\nGet tagging log records by specific date range
\nSubscription Required
\n- \n
- CRM Open API Module \n
Query Parameters
\nResponses
\nSuccess - HTTP Status 200 with the follow response body:
\nResponse object
\nTaggingLog Objects
[Required] The start of the specific date range in unix timestamp (milliseconds) (inclusive)
\n","type":"text/plain"},"key":"taggedAfter","value":"1742087630000"},{"description":{"content":"[Required] The end of the specific date range in unix timestamp (milliseconds) (exclusive)
\n","type":"text/plain"},"key":"taggedBefore","value":"1742202830000"},{"description":{"content":"Page
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Page size
\n","type":"text/plain"},"key":"pageSize","value":"20"}],"variable":[]}},"response":[{"id":"2e6818b1-66ed-423e-abe1-947e68a41530","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{API-TOKEN}}","description":"API Token From Omnichat","type":"text"}],"url":{"raw":"https://open-api.omnichat.ai/v1/tagging-logs/records?taggedAfter=1742087630000&taggedBefore=1742202830000","protocol":"https","host":["open-api","omnichat","ai"],"path":["v1","tagging-logs","records"],"query":[{"key":"taggedAfter","value":"1742087630000"},{"key":"taggedBefore","value":"1742202830000"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"time\": \"2023-01-03T12:32:12\",\n \"platform\": \"whatsapp\",\n \"channelId\": \"85211111111\",\n \"userId\": \"85222222222\",\n \"tag\": \"subscribed\",\n \"source\": \"Bot\",\n \"messageId\": \"wamid.123213123123\"\n }\n ],\n \"totalElements\": 1\n}"}],"_postman_id":"08ecab47-a8da-4bbc-a384-15522d6c9a64"}],"id":"9ea6a1aa-9cbe-40ba-8c47-dd5e676d17ed","_postman_id":"9ea6a1aa-9cbe-40ba-8c47-dd5e676d17ed","description":""},{"name":"Meta Business","item":[{"name":"Upload Public Key","id":"5432956a-eba6-4a49-bad8-a0a2caec3250","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API-TOKEN}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"phone\":\"{{YOUR_WHATSAPP_NUMBER}}\", \n \"businessPublicKey\":\"{{YOUR_PUBLIC_KEY}}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://open-api.omnichat.ai/v1/whatsapp-business/public-key","urlObject":{"protocol":"https","path":["v1","whatsapp-business","public-key"],"host":["open-api","omnichat","ai"],"query":[],"variable":[]}},"response":[],"_postman_id":"5432956a-eba6-4a49-bad8-a0a2caec3250"}],"id":"a6a8f79a-1df8-4f88-8a92-30b1880dadb2","_postman_id":"a6a8f79a-1df8-4f88-8a92-30b1880dadb2","description":""},{"name":"Channels","item":[{"name":"Get Channels","id":"146096d9-b276-4d6d-8b45-5013864226a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{API-TOKEN}}"}]},"isInherited":false},"method":"GET","header":[],"url":"https://open-api.omnichat.ai/v1/channels","description":"Description
\nGet Channel Info
\nResponses
\nSuccess - HTTP Status 200 with the follow response body:
\nResponse object
\nReturn array of Channel
\nResponse Example
\n[\n {\n \"platform\": \"webchat\",\n \"channelId\": \"webchat\",\n \"channelName\": \"Team name\"\n },\n { \n \"platform\": \"line\",\n \"channelId\": \"1657703186\",\n \"channelName\": \"LINE Channel Name\"\n }\n]\n\nGet Channel Info
\n","_postman_id":"2c5d2150-d277-4513-b18b-25fa1e40b92c"}],"variable":[{"key":"channelId","value":"1655713616"},{"key":"platform","value":"line"},{"key":"userId","value":"Ufc16ca0dac59929c665558fd0c040d1c"}]}