{ "info": { "_postman_id": "d5faafe0-28f8-47d0-b444-99c940421467", "name": "Conversation API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "3823699" }, "item": [ { "name": "App", "item": [ { "name": "Create App", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "", "type": "text", "disabled": true } ], "body": { "mode": "raw", "raw": "{\n \"display_name\": \"App name\",\n \"channel_credentials\": [\n {\n \"channel\": \"WHATSAPP\",\n \"static_bearer\": {\n \"claimed_identity\": \"__whats_app_bot_id__\",\n \"token\": \"__whats_app_bot_token__\"\n }\n },\n {\n \"channel\": \"MESSENGER\",\n \"static_token\": {\n \"token\": \"__messenger_token__\"\n }\n },\n {\n \"channel\": \"RCS\",\n \"static_bearer\": {\n \"claimed_identity\": \"__rcs_auth_id__\",\n \"token\": \"__rcs_token__\"\n }\n },\n {\n \"channel\": \"SMS\",\n \"static_bearer\": {\n \"claimed_identity\": \"__sms_service_plan_id__\",\n \"token\": \"__service_plan_token__\"\n }\n }\n ]\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/apps", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "apps" ] }, "description": "You can create a new Conversation API app using the API. You can create an app for one or more channels at once. The ID of the app is generated at creation and will be returned in the response." }, "response": [] }, { "name": "Get App", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/apps/:app_id", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "apps", ":app_id" ], "variable": [ { "key": "app_id", "value": "{{APP}}", "description": "(Required) The unique ID of the app." } ] }, "description": "Returns a particular app as specified by the App ID." }, "response": [] }, { "name": "List Apps", "request": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" }, { "key": "Authorization", "value": "", "type": "text", "disabled": true } ], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/apps", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "apps" ] }, "description": "Get a list of all apps in the specified project." }, "response": [] }, { "name": "Update App", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"display_name\": \"Updated App name\",\n \"channel_credentials\": [\n {\n \"channel\": \"MESSENGER\",\n \"static_token\": {\n \"token\": \"__new_messenger_token__\"\n }\n }\n ]\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/apps/:app_id", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "apps", ":app_id" ], "variable": [ { "key": "app_id", "value": "{{APP}}", "description": "(Required) The unique ID of the app." } ] }, "description": "Updates a particular app as specified by the App ID." }, "response": [] }, { "name": "Delete App", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/apps/:app_id", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "apps", ":app_id" ], "variable": [ { "key": "app_id", "value": "{{APP}}", "description": "(Required) The unique ID of the app." } ] }, "description": "Deletes a particular app as specified by the App ID." }, "response": [] } ], "description": "Apps are created and configured in the Sinch Dashboard. Each app is linked to an API user and includes channel credentials for every connected messaging channel. An app maintains its own list of conversations with contacts within the same project.\n\nWebhooks associated with the app define the destination for various events coming from the Conversation API.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Contact", "item": [ { "name": "Create Contact", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"channel_identities\": [\n {\n \"channel\": \"MESSENGER\",\n \"identity\": \"__messenger_id__\",\n \"app_id\": \"{{APP}}\"\n },\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"__whatsapp_id__\"\n },\n {\n \"channel\": \"RCS\",\n \"identity\": \"__rcs_id__\"\n },\n {\n \"channel\": \"SMS\",\n \"identity\": \"__sms_id__\"\n }\n ],\n \"channel_priority\": [\n \"MESSENGER\", \"RCS\", \"WHATSAPP\", \"SMS\"\n ]\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/contacts", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "contacts" ] }, "description": "You can create a new contact." }, "response": [] }, { "name": "Get Contact", "request": { "method": "GET", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/contacts/:contact_id", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "contacts", ":contact_id" ], "query": [ { "key": "", "value": "", "disabled": true } ], "variable": [ { "key": "contact_id", "value": "{{CONTACT}}", "description": "(Required) The unique ID of the contact." } ] }, "description": "Returns a specific contact as specified by the contact ID." }, "response": [] }, { "name": "List Contacts", "request": { "method": "GET", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/contacts", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "contacts" ], "query": [ { "key": "page_size", "value": "10", "description": "The maximum number of contacts to fetch. Defaults to 10 and the maximum is 20.", "disabled": true }, { "key": "page_token", "value": "token", "description": "Next page token previously returned if any.", "disabled": true }, { "key": "external_id", "value": "externalId", "description": "Optional. Contact identifier in an external system.", "disabled": true }, { "key": "channel", "value": "WHATSAPP", "description": "Optional. Conversation channel.", "disabled": true }, { "key": "identity", "value": "__whatsapp_id__", "description": "Optional. The channel identity e.g., a phone number for SMS, WhatsApp and Viber Business.", "disabled": true } ] }, "description": "List all contacts in the project." }, "response": [] }, { "name": "Delete Contact", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/contacts/:contact_id", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "contacts", ":contact_id" ], "variable": [ { "key": "contact_id", "value": "{{CONTACT}}", "description": "(Required) The unique ID of the contact." } ] }, "description": "Delete a contact as specified by the contact ID." }, "response": [] }, { "name": "Delete all Contacts", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/contacts:deleteAll", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "contacts:deleteAll" ] }, "description": "This method **deletes all contacts under the Project** specified on the path, which can be in use across multiple Apps. It also **deletes conversations and messages** associated with the contacts.\n\n**This operation is not reversible**" }, "response": [] }, { "name": "Update Contact", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"channel_identities\": [\n {\n \"channel\": \"MESSENGER\",\n \"identity\": \"__messenger_id__\",\n \"app_id\": \"{{APP}}\"\n },\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"__whatsapp_id__\"\n },\n {\n \"channel\": \"RCS\",\n \"identity\": \"__rcs_id__\"\n },\n {\n \"channel\": \"SMS\",\n \"identity\": \"__sms_id__\"\n }\n ],\n \"channel_priority\": [\n \"MESSENGER\", \"RCS\", \"WHATSAPP\", \"SMS\"\n ]\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/contacts/:contact_id", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "contacts", ":contact_id" ], "variable": [ { "key": "contact_id", "value": "{{CONTACT}}", "description": "(Required) The unique ID of the contact." } ] }, "description": "Updates a contact as specified by the contact ID." }, "response": [] }, { "name": "Merge Two Contacts", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"source_id\": \"{{MERGE_CONTACT}}\"\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/contacts/{{CONTACT}}:merge", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "contacts", "{{CONTACT}}:merge" ] }, "description": "The remaining contact will contain all conversations that the removed contact did. If both contacts had conversations within the same App, messages from the removed contact will be merged into corresponding active conversations in the destination contact. Channel identities will be moved from the source contact to the destination contact only for channels that weren't present there before. Moved channel identities will be placed at the bottom of the channel priority list. Optional fields from the source contact will be copied only if corresponding fields in the destination contact are empty The contact being removed cannot be referenced after this call." }, "response": [] }, { "name": "Get Contact Channel Profile", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"contact_id\": \"{{CONTACT}}\"\n },\n \"channel\": \"MESSENGER\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/contacts:getChannelProfile", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "contacts:getChannelProfile" ] }, "description": "Get user profile from a specific channel." }, "response": [] }, { "name": "List Contact Identity Conflicts", "request": { "method": "GET", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/contacts:identityConflicts?page_size=10", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "contacts:identityConflicts" ], "query": [ { "key": "page_size", "value": "10", "description": "Maximum number of conflicts to return (max 20)." }, { "key": "page_token", "value": "token", "description": "Pagination token for retrieving next page.", "disabled": true } ] }, "description": "Lists contact identity conflicts across supported SIM-based channels (SMS, MMS, RCS). Use this to identify contact records sharing the same identity (e.g., phone number), which must be resolved before enabling the Unified Contact ID feature." }, "response": [] } ], "description": "A contact is a collection that groups together underlying connected channel recipient identities. It's tied to a specific project and is therefore considered public to all apps sharing the same project.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Conversation", "item": [ { "name": "Create Conversation", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"active\": true,\n \"active_channel\": \"{{CHANNEL}}\",\n \"app_id\": \"{{APP}}\",\n \"contact_id\": \"{{CONTACT}}\",\n \"metadata\": \"string\",\n \"conversation_metadata\": { }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/conversations", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "conversations" ] }, "description": "Creates a new empty conversation. It is generally not needed to create a conversation explicitly since sending or receiving a message automatically creates a new conversation if it does not already exist between the given app and contact. Creating empty conversation is useful if the metadata of the conversation should be populated when the first message in the conversation is a contact message or the first message in the conversation comes out-of-band and needs to be injected with InjectMessage endpoint." }, "response": [] }, { "name": "Get Conversation", "request": { "method": "GET", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/conversations/:conversation_id", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "conversations", ":conversation_id" ], "variable": [ { "key": "conversation_id", "value": "{{CONVERSATION}}", "description": "(Required) The unique ID of the conversation." } ] }, "description": "Retrieves a conversation by id. A conversation has two participating entities, an app and a contact." }, "response": [] }, { "name": "List Conversations", "request": { "method": "GET", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/conversations?only_active=false&app_id={{APP}}", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "conversations" ], "query": [ { "key": "only_active", "value": "false", "description": "(Required) True if only active conversations should be listed." }, { "key": "app_id", "value": "{{APP}}", "description": "At least one of app_id or contact_id must be present." }, { "key": "contact_id", "value": "{{CONTACT}}", "description": "At least one of app_id or contact_id must be present.", "disabled": true }, { "key": "page_size", "value": "10", "description": "The maximum number of conversations to fetch. Defaults to 10 and the maximum is 20.", "disabled": true }, { "key": "page_token", "value": "token", "description": "Next page token previously returned if any.", "disabled": true } ] }, "description": "This operation lists all conversations that are associated with an app and/or a contact." }, "response": [] }, { "name": "Update Conversation", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n\t\"metadata\": \"some metadata\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/conversations/:conversation_id", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "conversations", ":conversation_id" ], "query": [ { "key": "update_mask.paths", "value": "", "description": "The set of field mask paths.", "disabled": true }, { "key": "metadata_update_strategy", "value": "REPLACE", "description": "Default: \"REPLACE\"\nEnum: \"REPLACE\" \"MERGE_PATCH\"", "disabled": true }, { "key": "", "value": "", "disabled": true } ], "variable": [ { "key": "conversation_id", "value": "{{CONVERSATION}}", "description": "(Required) The unique ID of the conversation. This is generated by the system." } ] }, "description": "This operation updates a conversation which can, for instance, be used to update the metadata associated with a conversation." }, "response": [] }, { "name": "Stop Active Connversation", "request": { "method": "POST", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/conversations/{{CONVERSATION}}:stop", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "conversations", "{{CONVERSATION}}:stop" ] }, "description": "This operation stops the referenced conversation, if the conversation is still active. A new conversation will be created if a new message is exchanged between the app or contact that was part of the stopped conversation." }, "response": [] }, { "name": "Inject Message into Conversation", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n\t\"direction\": \"TO_CONTACT\",\n\t\"app_message\": {\n \t\"text_message\": {\n \t\"text\": \"Text message from Sinch Conversation API.\"\n \t}\n\t},\n\t\"channel\": \"{{CHANNEL}}\",\n\t\"conversation_id\": \"{{CONVERSATION}}\",\n\t\"contact_id\": \"{{CONTACT}}\",\n\t\"accept_time\": \"2020-04-18T07:53:34.879Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/conversations/{{CONVERSATION}}:inject-message", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "conversations", "{{CONVERSATION}}:inject-message" ] }, "description": "This operation injects a conversation message in to a specific conversation." }, "response": [] }, { "name": "Delete Conversation", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/conversations/:conversation_id", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "conversations", ":conversation_id" ], "variable": [ { "key": "conversation_id", "value": "{{CONVERSATION}}", "description": "(Required) The unique ID of the conversation." } ] }, "description": "Deletes a conversation together with all the messages sent as part of the conversation." }, "response": [] } ], "description": "Endpoints for working with the conversation log.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Events", "item": [ { "name": "Send Event", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"event\": {\n \"composing_event\": {}\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/events:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "events:send" ] }, "description": "Sends an event to the referenced contact from the referenced app. Note that this operation enqueues the event in a queues so a successful response only indicates that the event has been queued." }, "response": [] } ], "description": "Endpoint for sending events.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Messages", "item": [ { "name": "Send Message", "item": [ { "name": "Generic Messages", "item": [ { "name": "Text Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"text_message\": {\n \"text\": \"Text message from Sinch Conversation API.\"\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] }, "description": "Send a text message to a recipient using channel identities (phone numbers, IDs) without needing to create a contact first. This is useful for one-off messages or when you don't want to manage contacts." }, "response": [ { "name": "Contact Based", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \t\"contact_id\": \"{{CONTACT}}\"\n },\n \"channel_priority_order\": [\n \"{{CHANNEL}}\"\n ],\n \"message\": {\n \"text_message\": {\n \"text\": \"Text message from Sinch Conversation API.\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Media Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"media_message\": {\n \"url\": \"https://www.gstatic.com/webp/gallery/1.webp\"\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [ { "name": "Contact Based", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \t\"contact_id\": \"{{CONTACT}}\"\n },\n \"channel_priority_order\": [\n \"{{CHANNEL}}\"\n ],\n \"message\": {\n \"media_message\": {\n \"url\": \"https://www.gstatic.com/webp/gallery/1.webp\"\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Choice Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"choice_message\": {\n \"text_message\": {\n \"text\": \"What do you want to do?\"\n },\n \"choices\": [\n {\n \"text_message\": {\n \"text\": \"Text Choice\"\n }\n },\n {\n \"url_message\": {\n \"title\": \"URL Choice\",\n \"url\": \"https://www.sinch.com\"\n }\n },\n {\n \"call_message\": {\n \"title\": \"Call Choice\",\n \"phone_number\": \"46732000000\"\n }\n },\n {\n \"location_message\": {\n \"title\": \"Location Choice\",\n \"label\": \"Enriching Engagement\",\n \"coordinates\": {\n \"latitude\": 55.610479,\n \"longitude\": 13.002873\n }\n }\n },\n {\n \"calendar_message\": {\n \"title\": \"Calendar Choice\",\n \"event_start\": \"2025-11-21T10:00:00Z\",\n \"event_end\": \"2025-11-21T14:00:00Z\",\n \"event_title\": \"Meeting with Sinch\",\n \"event_description\": \"Talk about Sinch products\",\n \"fallback_url\": \"https://sinch.com\"\n }\n },\n {\n \"share_location_message\": {\n \"title\": \"Share your location\",\n \"fallback_url\": \"https://maps.google.com\"\n }\n }\n ]\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [ { "name": "Contact Based", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"contact_id\": \"{{CONTACT}}\"\n },\n \"channel_priority_order\": [\n \"{{CHANNEL}}\"\n ],\n \"message\": {\n \"choice_message\": {\n \"text_message\": {\n \"text\": \"What do you want to do?\"\n },\n \"choices\": [\n {\n \"text_message\": {\n \"text\": \"Text Choice\"\n }\n },\n {\n \"url_message\": {\n \"title\": \"URL Choice\",\n \"url\": \"https://www.sinch.com\"\n }\n },\n {\n \"call_message\": {\n \"title\": \"Call Choice\",\n \"phone_number\": \"46732000000\"\n }\n },\n {\n \"location_message\": {\n \"title\": \"Location Choice\",\n \"label\": \"Enriching Engagement\",\n \"coordinates\": {\n \"latitude\": 55.610479,\n \"longitude\": 13.002873\n }\n }\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Card Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"card_message\": {\n \"title\": \"This is the card title\",\n \"description\": \"This is the card description\",\n \"media_message\": {\n \"url\": \"https://www.gstatic.com/webp/gallery/1.webp\"\n },\n \"choices\": [\n {\n \"text_message\": {\n \"text\": \"Text Choice\"\n }\n },\n {\n \"url_message\": {\n \"title\": \"URL Choice\",\n \"url\": \"https://www.sinch.com\"\n }\n },\n {\n \"call_message\": {\n \"title\": \"Call Choice\",\n \"phone_number\": \"46732000000\"\n }\n },\n {\n \"location_message\": {\n \"title\": \"Location Choice\",\n \"label\": \"Enriching Engagement\",\n \"coordinates\": {\n \"latitude\": 55.610479,\n \"longitude\": 13.002873\n }\n }\n }\n ]\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [ { "name": "Contact Based", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \t\"contact_id\": \"{{CONTACT}}\"\n },\n \"channel_priority_order\": [\n \"{{CHANNEL}}\"\n ],\n \"message\": {\n \"card_message\": {\n \"title\": \"This is the card title\",\n \"description\": \"This is the card description\",\n \"media_message\": {\n \"url\": \"https://www.gstatic.com/webp/gallery/1.webp\"\n },\n \"choices\": [\n {\n \"text_message\": {\n \"text\": \"Text Choice\"\n }\n },\n {\n \"url_message\": {\n \"title\": \"URL Choice\",\n \"url\": \"https://www.sinch.com\"\n }\n },\n {\n \"call_message\": {\n \"title\": \"Call Choice\",\n \"phone_number\": \"46732000000\"\n }\n },\n {\n \"location_message\": {\n \"title\": \"Location Choice\",\n \"label\": \"Enriching Engagement\",\n \"coordinates\": {\n \"latitude\": 55.610479,\n \"longitude\": 13.002873\n }\n }\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Carousel Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"carousel_message\": {\n \"cards\": [\n {\n \"title\": \"This is the card 1 title\",\n \"description\": \"This is the card 1 description\",\n \"media_message\": {\n \"url\": \"https://www.gstatic.com/webp/gallery/1.webp\"\n },\n \"choices\": [\n {\n \"text_message\": {\n \"text\": \"Text Choice 1\"\n }\n },\n {\n \"text_message\": {\n \"text\": \"Text Choice 2\"\n }\n },\n {\n \"text_message\": {\n \"text\": \"Text Choice 3\"\n }\n }\n ]\n },\n {\n \"title\": \"This is the card 2 title\",\n \"description\": \"This is the card 2 description\",\n \"media_message\": {\n \"url\": \"https://www.gstatic.com/webp/gallery/2.webp\"\n },\n \"choices\": [\n {\n \"url_message\": {\n \"title\": \"URL Choice\",\n \"url\": \"https://www.sinch.com\"\n }\n }\n ]\n },\n {\n \"title\": \"This is the card 3 title\",\n \"description\": \"This is the card 3 description\",\n \"media_message\": {\n \"url\": \"https://www.gstatic.com/webp/gallery/3.webp\"\n },\n \"choices\": [\n {\n \"call_message\": {\n \"title\": \"Call Choice\",\n \"phone_number\": \"46732000000\"\n }\n }\n ]\n },\n {\n \"title\": \"This is the card 4 title\",\n \"description\": \"This is the card 4 description\",\n \"media_message\": {\n \"url\": \"https://www.gstatic.com/webp/gallery/4.webp\"\n },\n \"choices\": [\n {\n \"location_message\": {\n \"title\": \"Location Choice\",\n \"label\": \"Enriching Engagement\",\n \"coordinates\": {\n \"latitude\": 55.610479,\n \"longitude\": 13.002873\n }\n }\n }\n ]\n }\n ]\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [ { "name": "Contact Based", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"contact_id\": \"{{CONTACT}}\"\n },\n \"channel_priority_order\": [\n \"{{CHANNEL}}\"\n ],\n \"message\": {\n \"carousel_message\": {\n \"cards\": [\n {\n \"title\": \"This is the card 1 title\",\n \"description\": \"This is the card 1 description\",\n \"media_message\": {\n \"url\": \"https://www.gstatic.com/webp/gallery/1.webp\"\n },\n \"choices\": [\n {\n \"text_message\": {\n \"text\": \"Text Choice 1\"\n }\n },\n {\n \"text_message\": {\n \"text\": \"Text Choice 2\"\n }\n },\n {\n \"text_message\": {\n \"text\": \"Text Choice 3\"\n }\n }\n ]\n },\n {\n \"title\": \"This is the card 2 title\",\n \"description\": \"This is the card 2 description\",\n \"media_message\": {\n \"url\": \"https://www.gstatic.com/webp/gallery/2.webp\"\n },\n \"choices\": [\n {\n \"url_message\": {\n \"title\": \"URL Choice\",\n \"url\": \"https://www.sinch.com\"\n }\n }\n ]\n },\n {\n \"title\": \"This is the card 3 title\",\n \"description\": \"This is the card 3 description\",\n \"media_message\": {\n \"url\": \"https://www.gstatic.com/webp/gallery/3.webp\"\n },\n \"choices\": [\n {\n \"call_message\": {\n \"title\": \"Call Choice\",\n \"phone_number\": \"46732000000\"\n }\n }\n ]\n },\n {\n \"title\": \"This is the card 4 title\",\n \"description\": \"This is the card 4 description\",\n \"media_message\": {\n \"url\": \"https://www.gstatic.com/webp/gallery/4.webp\"\n },\n \"choices\": [\n {\n \"location_message\": {\n \"title\": \"Location Choice\",\n \"label\": \"Enriching Engagement\",\n \"coordinates\": {\n \"latitude\": 55.610479,\n \"longitude\": 13.002873\n }\n }\n }\n ]\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] }, { "name": "List Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"list_message\": {\n \"title\": \"Product catalog\",\n \"description\": \"Choose a product from the list below.\",\n \"sections\": [\n {\n \"title\": \"Messaging plans\",\n \"items\": [\n {\n \"choice\": {\n \"title\": \"Basic Messaging\",\n \"description\": \"Starter tier with 100 conversations\",\n \"postback_data\": \"plan-basic\"\n }\n },\n {\n \"choice\": {\n \"title\": \"Pro Messaging\",\n \"description\": \"Unlimited conversations with priority support\",\n \"postback_data\": \"plan-pro\"\n }\n }\n ]\n },\n {\n \"title\": \"Add-ons\",\n \"items\": [\n {\n \"choice\": {\n \"title\": \"Advanced Analytics\",\n \"description\": \"Gain insights with detailed reporting\",\n \"postback_data\": \"addon-analytics\"\n }\n }\n ]\n }\n ],\n \"message_properties\": {\n \"whatsapp_button_text\": \"View options\"\n }\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] }, "description": "Send a list message with sections and rows compliant with supported interactive channels." }, "response": [ { "name": "Contact Based", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"contact_id\": \"{{CONTACT}}\"\n },\n \"channel_priority_order\": [\n \"{{CHANNEL}}\"\n ],\n \"message\": {\n \"list_message\": {\n \"title\": \"Product catalog\",\n \"description\": \"Choose a product from the list below.\",\n \"sections\": [\n {\n \"title\": \"Messaging plans\",\n \"items\": [\n {\n \"choice\": {\n \"title\": \"Basic Messaging\",\n \"description\": \"Starter tier with 100 conversations\",\n \"postback_data\": \"plan-basic\"\n }\n },\n {\n \"choice\": {\n \"title\": \"Pro Messaging\",\n \"description\": \"Unlimited conversations with priority support\",\n \"postback_data\": \"plan-pro\"\n }\n }\n ]\n },\n {\n \"title\": \"Add-ons\",\n \"items\": [\n {\n \"choice\": {\n \"title\": \"Advanced Analytics\",\n \"description\": \"Gain insights with detailed reporting\",\n \"postback_data\": \"addon-analytics\"\n }\n }\n ]\n }\n ],\n \"message_properties\": {\n \"whatsapp_button_text\": \"View options\"\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Location Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"location_message\": {\n \"title\": \"Location Message\",\n \"label\": \"Enriching Engagement\",\n \"coordinates\": {\n \"latitude\": 55.610479,\n \"longitude\": 13.002873\n }\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [ { "name": "Contact Based", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \t\"contact_id\": \"{{CONTACT}}\"\n },\n \"channel_priority_order\": [\n \"{{CHANNEL}}\"\n ],\n \"message\": {\n \"location_message\": {\n \"title\": \"Location Message\",\n \"label\": \"Enriching Engagement\",\n \"coordinates\": {\n \"latitude\": 55.610479,\n \"longitude\": 13.002873\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Template Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"template_message\": {\n \"omni_template\": {\n \"template_id\": \"{{TEMPLATE}}\",\n \"version\": \"1\",\n \"language_code\": \"en-US\",\n \"parameters\": {\n \"my_parameter\": \"123\"\n }\n }\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [ { "name": "Contact Based", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"contact_id\": \"{{CONTACT}}\"\n },\n \"channel_priority_order\": [\n \"{{CHANNEL}}\"\n ],\n \"message\": {\n \"template_message\": {\n \"omni_template\": {\n \"template_id\": \"{{TEMPLATE}}\",\n \"version\": \"1\",\n \"language_code\": \"en-US\",\n \"parameters\": {\n \"my_parameter\": \"123\"\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] } ] }, { "name": "Channel Specific Messages", "item": [ { "name": "RCS", "item": [ { "name": "Choice Message with WebView", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"choice_message\": {\n \"text_message\": {\n \"text\": \"What do you want to do?\"\n },\n \"choices\": [\n {\n \"url_message\": {\n \"title\": \"Open sinch.com\",\n \"url\": \"https://www.sinch.com\"\n }\n }\n ]\n }\n },\n \"channel_properties\": {\n \"RCS_WEBVIEW_MODE\": \"TALL\"\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] }, "description": "WhatsApp template message showcasing header text, body parameters, and a URL button as in Sinch template support docs." }, "response": [] } ] }, { "name": "WhatsApp", "item": [ { "name": "Payments", "item": [ { "name": "Interactive", "item": [ { "name": "Interactive PIX", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"channel_specific_message\": {\n \"WHATSAPP\": {\n \"message_type\": \"order_details\",\n \"message\": {\n \"header\": {\n \"type\": \"text\",\n \"text\": \"Payment message header\"\n },\n \"body\": {\n \"text\": \"Payment message body\"\n },\n \"footer\": {\n \"text\": \"Payment message footer\"\n },\n \"payment\": {\n \"type\": \"br\",\n \"reference_id\": \"1234\",\n \"type_of_goods\": \"digital-goods\",\n \"payment_settings\": {\n \"dynamic_pix\": {\n \"code\": \"1234\",\n \"merchant_name\": \"Test merchant\",\n \"key\": \"asdf@example.com\",\n \"key_type\": \"EMAIL\"\n }\n },\n \"total_amount_value\": 80,\n \"order\": {\n \"tax_value\": 1,\n \"tax_description\": \"optional text\",\n \"subtotal_value\": 60,\n \"expiration_time\": \"{{$timestamp}}\",\n \"expiration_description\": \"Expiration description\",\n \"discount_value\": 1,\n \"discount_description\": \"Discount description\",\n \"discount_program_name\": \"Discount program name\",\n \"shipping_value\": 20,\n \"shipping_description\": \"Shipping description\",\n \"catalog_id\": \"Catalog id\",\n \"items\": [\n {\n \"retailer_id\": \"retailer1\",\n \"name\": \"Item name 1\",\n \"amount_value\": 50,\n \"quantity\": 1,\n \"sale_amount_value\": 40\n },\n {\n \"retailer_id\": \"retailer2\",\n \"name\": \"Item name 2\",\n \"amount_value\": 20,\n \"quantity\": 1\n }\n ]\n }\n }\n }\n }\n }\n }\n}\n" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] }, { "name": "Interactive Payment Link", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"channel_specific_message\": {\n \"WHATSAPP\": {\n \"message_type\": \"order_details\",\n \"message\": {\n \"header\": {\n \"type\": \"text\",\n \"text\": \"Payment message header\"\n },\n \"body\": {\n \"text\": \"Payment message body\"\n },\n \"footer\": {\n \"text\": \"Payment message footer\"\n },\n \"payment\": {\n \"type\": \"br\",\n \"reference_id\": \"1234\",\n \"type_of_goods\": \"digital-goods\",\n \"payment_settings\": {\n \"payment_link\": {\n \"uri\": \"https://www.example.com/payment_link\"\n }\n },\n \"total_amount_value\": 80,\n \"order\": {\n \"tax_value\": 1,\n \"tax_description\": \"optional text\",\n \"subtotal_value\": 60,\n \"expiration_time\": \"{{$timestamp}}\",\n \"expiration_description\": \"Expiration description\",\n \"discount_value\": 1,\n \"discount_description\": \"Discount description\",\n \"discount_program_name\": \"Discount program name\",\n \"shipping_value\": 20,\n \"shipping_description\": \"Shipping description\",\n \"catalog_id\": \"Catalog id\",\n \"items\": [\n {\n \"retailer_id\": \"retailer1\",\n \"name\": \"Item name 1\",\n \"amount_value\": 50,\n \"quantity\": 1,\n \"sale_amount_value\": 40\n },\n {\n \"retailer_id\": \"retailer2\",\n \"name\": \"Item name 2\",\n \"amount_value\": 20,\n \"quantity\": 1\n }\n ]\n }\n }\n }\n }\n }\n }\n}\n" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] }, { "name": "Interactive Boleto", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"channel_specific_message\": {\n \"WHATSAPP\": {\n \"message_type\": \"order_details\",\n \"message\": {\n \"header\": {\n \"type\": \"text\",\n \"text\": \"Payment message header\"\n },\n \"body\": {\n \"text\": \"Payment message body\"\n },\n \"footer\": {\n \"text\": \"Payment message footer\"\n },\n \"payment\": {\n \"type\": \"br\",\n \"reference_id\": \"1234\",\n \"type_of_goods\": \"digital-goods\",\n \"payment_settings\": {\n \"boleto\": {\n \"digitable_line\": \"11111111111111111111111111111111111111111111111\"\n }\n },\n \"total_amount_value\": 80,\n \"order\": {\n \"tax_value\": 1,\n \"tax_description\": \"optional text\",\n \"subtotal_value\": 60,\n \"expiration_time\": \"{{$timestamp}}\",\n \"expiration_description\": \"Expiration description\",\n \"discount_value\": 1,\n \"discount_description\": \"Discount description\",\n \"discount_program_name\": \"Discount program name\",\n \"shipping_value\": 20,\n \"shipping_description\": \"Shipping description\",\n \"catalog_id\": \"Catalog id\",\n \"items\": [\n {\n \"retailer_id\": \"retailer1\",\n \"name\": \"Item name 1\",\n \"amount_value\": 50,\n \"quantity\": 1,\n \"sale_amount_value\": 40\n },\n {\n \"retailer_id\": \"retailer2\",\n \"name\": \"Item name 2\",\n \"amount_value\": 20,\n \"quantity\": 1\n }\n ]\n }\n }\n }\n }\n }\n }\n}\n" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] } ] }, { "name": "Template", "item": [ { "name": "PIX Template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [{\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }]\n }\n },\n \"message\": {\n \"template_message\": {\n \"channel_template\": {\n \"WHATSAPP\": {\n \"template_id\": \"test_order_details_002\",\n \"language_code\": \"en\",\n \"parameters\": {\n \"body[1]text\": \"John\",\n \"header[1]document.link\": \"https://pdfobject.com/pdf/sample.pdf\",\n \"button[0]order_details[1]action.type\": \"br\",\n \"button[0]order_details[1]action.reference_id\": \"1234\",\n \"button[0]order_details[1]action.type_of_goods\": \"digital-goods\",\n \"button[0]order_details[1]action.total_amount_value\": \"80\",\n \"button[0]order_details[1]action.order.items[1]retailer_id\": \"retailer1\",\n \"button[0]order_details[1]action.order.items[1]name\": \"Item name 1\",\n \"button[0]order_details[1]action.order.items[1]amount_value\": \"50\",\n \"button[0]order_details[1]action.order.items[1]sale_amount_value\": \"40\",\n \"button[0]order_details[1]action.order.items[1]quantity\": \"1\",\n \"button[0]order_details[1]action.order.items[2]retailer_id\": \"retailer2\",\n \"button[0]order_details[1]action.order.items[2]name\": \"Item name 2\",\n \"button[0]order_details[1]action.order.items[2]amount_value\": \"20\",\n \"button[0]order_details[1]action.order.items[2]quantity\": \"1\",\n \"button[0]order_details[1]action.order.subtotal_value\": \"60\",\n \"button[0]order_details[1]action.order.tax_value\": \"1\",\n \"button[0]order_details[1]action.order.tax_description\": \"Tax description\",\n \"button[0]order_details[1]action.order.discount_value\": \"1\",\n \"button[0]order_details[1]action.order.discount_description\": \"Discount description\",\n \"button[0]order_details[1]action.order.discount_program_name\": \"Discount program name\",\n \"button[0]order_details[1]action.order.shipping_value\": \"20\",\n \"button[0]order_details[1]action.order.shipping_description\": \"Shipping description\",\n \"button[0]order_details[1]action.order.catalog_id\": \"catalog_id\",\n \"button[0]order_details[1]action.order.expiration_time\": \"{{$timestamp}}\",\n \"button[0]order_details[1]action.order.expiration_description\": \"Expiration description\",\n \"button[0]order_details[1]action.order.payment_settings[1]type\": \"pix\",\n \"button[0]order_details[1]action.order.payment_settings[1]pix_code\": \"1234\",\n \"button[0]order_details[1]action.order.payment_settings[1]pix_merchant_name\": \"Test merchant\",\n \"button[0]order_details[1]action.order.payment_settings[1]pix_key\": \"asdf@example.com\",\n \"button[0]order_details[1]action.order.payment_settings[1]pix_key_type\": \"EMAIL\"\n }\n }\n }\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] }, { "name": "Payment Link Template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [{\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }]\n }\n },\n \"message\": {\n \"template_message\": {\n \"channel_template\": {\n \"WHATSAPP\": {\n \"template_id\": \"{{TEMPLATE}}\",\n \"language_code\": \"en\",\n \"parameters\": {\n \"body[1]text\": \"John\",\n \"header[1]document.link\": \"https://pdfobject.com/pdf/sample.pdf\",\n \"button[0]order_details[1]action.type\": \"br\",\n \"button[0]order_details[1]action.reference_id\": \"1234\",\n \"button[0]order_details[1]action.type_of_goods\": \"digital-goods\",\n \"button[0]order_details[1]action.total_amount_value\": \"80\",\n \"button[0]order_details[1]action.order.items[1]retailer_id\": \"retailer1\",\n \"button[0]order_details[1]action.order.items[1]name\": \"Item name 1\",\n \"button[0]order_details[1]action.order.items[1]amount_value\": \"50\",\n \"button[0]order_details[1]action.order.items[1]sale_amount_value\": \"40\",\n \"button[0]order_details[1]action.order.items[1]quantity\": \"1\",\n \"button[0]order_details[1]action.order.items[2]retailer_id\": \"retailer2\",\n \"button[0]order_details[1]action.order.items[2]name\": \"Item name 2\",\n \"button[0]order_details[1]action.order.items[2]amount_value\": \"20\",\n \"button[0]order_details[1]action.order.items[2]quantity\": \"1\",\n \"button[0]order_details[1]action.order.subtotal_value\": \"60\",\n \"button[0]order_details[1]action.order.tax_value\": \"1\",\n \"button[0]order_details[1]action.order.tax_description\": \"Tax description\",\n \"button[0]order_details[1]action.order.discount_value\": \"1\",\n \"button[0]order_details[1]action.order.discount_description\": \"Discount description\",\n \"button[0]order_details[1]action.order.discount_program_name\": \"Discount program name\",\n \"button[0]order_details[1]action.order.shipping_value\": \"20\",\n \"button[0]order_details[1]action.order.shipping_description\": \"Shipping description\",\n \"button[0]order_details[1]action.order.catalog_id\": \"catalog_id\",\n \"button[0]order_details[1]action.order.expiration_time\": \"{{$timestamp}}\",\n \"button[0]order_details[1]action.order.expiration_description\": \"Expiration description\",\n \"button[0]order_details[1]action.order.payment_settings[1]type\": \"payment_link\",\n \"button[0]order_details[1]action.order.payment_settings[1]payment_link_uri\": \"https://www.example.com/payment_link\"\n }\n }\n }\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] }, { "name": "Boleto Template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [{\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }]\n }\n },\n \"message\": {\n \"template_message\": {\n \"channel_template\": {\n \"WHATSAPP\": {\n \"template_id\": \"{{TEMPLATE}}\",\n \"language_code\": \"en\",\n \"parameters\": {\n \"body[1]text\": \"John\",\n \"header[1]document.link\": \"https://file-examples.com/storage/fea28b698c68e4ce99d36ee/2017/10/file-example_PDF_500_kB.pdf\",\n \"button[0]order_details[1]action.type\": \"br\",\n \"button[0]order_details[1]action.reference_id\": \"1234\",\n \"button[0]order_details[1]action.type_of_goods\": \"digital-goods\",\n \"button[0]order_details[1]action.total_amount_value\": \"80\",\n \"button[0]order_details[1]action.order.items[1]retailer_id\": \"retailer1\",\n \"button[0]order_details[1]action.order.items[1]name\": \"Item name 1\",\n \"button[0]order_details[1]action.order.items[1]amount_value\": \"50\",\n \"button[0]order_details[1]action.order.items[1]sale_amount_value\": \"40\",\n \"button[0]order_details[1]action.order.items[1]quantity\": \"1\",\n \"button[0]order_details[1]action.order.items[2]retailer_id\": \"retailer2\",\n \"button[0]order_details[1]action.order.items[2]name\": \"Item name 2\",\n \"button[0]order_details[1]action.order.items[2]amount_value\": \"20\",\n \"button[0]order_details[1]action.order.items[2]quantity\": \"1\",\n \"button[0]order_details[1]action.order.subtotal_value\": \"60\",\n \"button[0]order_details[1]action.order.tax_value\": \"1\",\n \"button[0]order_details[1]action.order.tax_description\": \"Tax description\",\n \"button[0]order_details[1]action.order.discount_value\": \"1\",\n \"button[0]order_details[1]action.order.discount_description\": \"Discount description\",\n \"button[0]order_details[1]action.order.discount_program_name\": \"Discount program name\",\n \"button[0]order_details[1]action.order.shipping_value\": \"20\",\n \"button[0]order_details[1]action.order.shipping_description\": \"Shipping description\",\n \"button[0]order_details[1]action.order.catalog_id\": \"catalog_id\",\n \"button[0]order_details[1]action.order.expiration_time\": \"{{$timestamp}}\",\n \"button[0]order_details[1]action.order.expiration_description\": \"Expiration description\",\n \"button[0]order_details[1]action.order.payment_settings[1]type\": \"boleto\",\n \"button[0]order_details[1]action.order.payment_settings[1]boleto_digitable_line\": \"11111111111111111111111111111111111111111111111\"\n }\n }\n }\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] } ] } ] }, { "name": "Cards", "item": [ { "name": "[Card] Interactive Reply Buttons", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"card_message\": {\n \"title\": \"title\",\n \"media_message\": {\n \"url\": \"{{MEDIA_URL}}\"\n },\n \"choices\": [\n {\n \"text_message\": {\n \"text\": \"text1\"\n },\n \"postback_data\": \"postback1\"\n },\n {\n \"text_message\": {\n \"text\": \"text2\"\n },\n \"postback_data\": \"postback2\"\n }\n ]\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] }, { "name": "[Card] Interactive CTA URL Button", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"card_message\": {\n \"title\": \"Your order update as requested\",\n \"description\": \"Your shipment with order id: ORD-123456789 is already shipped. We will keep you updated on the progress\",\n \"choices\": [\n {\n \"url_message\": {\n \"title\": \"Browse Products\",\n \"url\": \"https://sinch.com/products/\"\n },\n \"postback_data\": \"browse\"\n }\n ]\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] }, { "name": "[Media Card] Interactive Reply Buttons", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"card_message\": {\n \"title\": \"This is the card title\",\n \"description\": \"This is the card description\",\n \"media_message\": {\n \"url\": \"{{MEDIA_URL}}\"\n },\n \"choices\": [\n {\n \"text_message\": {\n \"text\": \"Text Choice\"\n }\n }\n ]\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] }, { "name": "[Media Card] Interactive CTA URL Button", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"card_message\": {\n \"title\": \"Your order update as requested\",\n \"description\": \"Your shipment with order id: ORD-123456789 is already shipped. We will keep you updated on the progress\",\n \"media_message\": {\n \"url\": \"{{MEDIA_URL}}\"\n },\n \"choices\": [\n {\n \"url_message\": {\n \"title\": \"Browse Products\",\n \"url\": \"https://sinch.com/products/\"\n },\n \"postback_data\": \"browse\"\n }\n ]\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] } ] }, { "name": "Choices", "item": [ { "name": "[Choice] Interactive Reply Buttons", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"choice_message\": {\n \"text_message\": {\n \"text\": \"title\"\n },\n \"choices\": [\n {\n \"text_message\": {\n \"text\": \"Button 1\"\n }\n },\n {\n \"text_message\": {\n \"text\": \"Button 2\"\n }\n }\n ]\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] }, { "name": "[Choice] Interactive CTA URL Button", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"choice_message\": {\n \"text_message\": {\n \"text\": \"title\"\n },\n \"choices\": [\n {\n \"url_message\": {\n \"title\": \"Sinch Website\",\n \"url\": \"https://sinch.com\"\n },\n \"postback_data\": \"postback1\"\n }\n ]\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] } ] }, { "name": "Flows", "item": [ { "name": "Flows Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"channel_specific_message\": {\n \"WHATSAPP\": {\n \"message_type\": \"FLOWS\",\n \"message\": {\n \"header\": {\n \"type\": \"text\",\n \"text\": \"Flow message header\"\n },\n \"body\": {\n \"text\": \"Flow message body\"\n },\n \"footer\": {\n \"text\": \"Flow message footer\"\n },\n \"flow_id\": \"843024380947952\",\n \"flow_token\": \"1\",\n \"flow_mode\": \"draft\",\n \"flow_cta\": \"testing\",\n \"flow_action\": \"navigate\",\n \"flow_action_payload\": {\n \"screen\": \"WELCOME_SCREEN\",\n \"data\": {\n \"name\": \"John Doe\"\n }\n }\n }\n }\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] }, "description": "WhatsApp template message showcasing header text, body parameters, and a URL button as in Sinch template support docs." }, "response": [] } ] }, { "name": "Templates", "item": [ { "name": "Text Template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"template_message\": {\n \"channel_template\": {\n \"WHATSAPP\": {\n \"template_id\": \"text_template\",\n \"language_code\": \"en\",\n \"parameters\": {\n \"body[1]text\": \"Value of first parameter\",\n \"body[2]text\": \"Value of second parameter\",\n \"body[3]text\": \"Value of third parameter\"\n }\n }\n }\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] }, "description": "WhatsApp template message showcasing header text, body parameters, and a URL button as in Sinch template support docs." }, "response": [] }, { "name": "Quick Reply Template", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"template_message\": {\n \"channel_template\": {\n \"WHATSAPP\": {\n \"template_id\": \"quick_reply_template\",\n \"language_code\": \"en\",\n \"parameters\": {\n \"header[1]text\": \"Value of header parameter\",\n \"body[1]text\": \"Value of first body parameter\",\n \"body[2]text\": \"Value of second body parameter\",\n \"body[3]text\": \"Value of third body parameter\",\n \"button[0]quick_reply[1]payload\": \"button0clicked\",\n \"button[1]quick_reply[1]payload\": \"button1clicked\",\n \"button[2]quick_reply[1]payload\": \"button2clicked\"\n }\n }\n }\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] }, "description": "WhatsApp template message showcasing header text, body parameters, and a URL button as in Sinch template support docs." }, "response": [] } ] }, { "name": "Lists", "item": [ { "name": "Product Catalog Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"list_message\": {\n \"title\": \"Title\",\n \"description\": \"Description\",\n \"sections\": [\n {\n \"title\": \"Section Title\",\n \"items\": [\n {\n \"product\": {\n \"id\": \"{{productId1}}\",\n \"marketplace\": \"BRIDGE\"\n }\n },\n {\n \"product\": {\n \"id\": \"{{productId2}}\",\n \"marketplace\": \"BRIDGE\"\n }\n }\n ]\n }\n ],\n \"message_properties\": {\n \"catalog_id\": \"{{catalogId}}\"\n }\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] }, { "name": "Choice List Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"list_message\": {\n \"title\": \"City walking tours\",\n \"description\": \"Pick the experience you want to reserve.\",\n \"sections\": [\n {\n \"title\": \"Weekend highlights\",\n \"items\": [\n {\n \"choice\": {\n \"title\": \"Art & Coffee Crawl\",\n \"description\": \"Gallery stops with latte art workshop\",\n \"postback_data\": \"tour-art-coffee\"\n }\n },\n {\n \"choice\": {\n \"title\": \"Secret Garden Picnic\",\n \"description\": \"Botanical greenhouse access with tasting platter\",\n \"postback_data\": \"tour-garden-picnic\"\n }\n }\n ]\n },\n {\n \"title\": \"Add-ons\",\n \"items\": [\n {\n \"choice\": {\n \"title\": \"Sunset rooftop pass\",\n \"description\": \"Golden hour photo pass\",\n \"postback_data\": \"addon-rooftop-sunset\"\n }\n }\n ]\n }\n ],\n \"message_properties\": {\n \"menu\": \"Options\",\n \"whatsapp_header\": \"Book Your Tour!\"\n }\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] } ] }, { "name": "Contacts", "item": [ { "name": "Contact Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "type": "text", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"WHATSAPP\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"contact_info_message\": {\n \"name\": {\n \"full_name\": \"Full Name\",\n \"first_name\": \"Fisrt\",\n \"last_name\": \"Last\"\n },\n \"phone_numbers\": [\n {\n \"phone_number\": \"{{contactNumber}}\",\n \"type\": \"HOME\"\n }\n ],\n \"addresses\": [{\n \"city\": \"city\",\n \"country\": \"countryName\",\n \"state\": \"state\",\n \"street\": \"street\",\n \"zip\": \"zip\",\n \"type\": \"type\",\n \"country_code\": \"countryCode\"\n }],\n \"email_addresses\": [\n {\n \"email_address\": \"sinch@sinch.com\",\n \"type\": \"WORK\"\n }\n ],\n \"organization\": {\n \"company\": \"companyName\",\n \"department\": \"department\",\n \"title\": \"role\"\n },\n \"urls\": [\n {\n \"url\": \"https://sinch.com\",\n \"type\": \"ORG\"\n }\n ],\n \"birthday\": \"YYYY-MM-DD\"\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] } ] } ] } ] }, { "name": "Channel Fallback Examples", "item": [ { "name": "Simple Text Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"RCS\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n },\n {\n \"channel\": \"SMS\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"text_message\": {\n \"text\": \"Text message from Sinch Conversation API.\"\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] }, { "name": "Different Messages by Channel", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"RCS\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n },\n {\n \"channel\": \"SMS\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"text_message\": {\n \"text\": \"This is the default message on channels other than RCS and SMS.\"\n },\n \"explicit_channel_omni_message\": {\n \"SMS\": {\n \"text_message\": {\n \"text\": \"This is the specific message for SMS.\"\n }\n },\n \"RCS\": {\n \"text_message\": {\n \"text\": \"This is the specific message for RCS.\"\n }\n }\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] }, { "name": "Card to Text Fallback", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"RCS\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n },\n {\n \"channel\": \"SMS\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n },\n \"message\": {\n \"card_message\": {\n \"title\": \"This card message will be sent only on RCS\",\n \"description\": \"This is the card description\",\n \"media_message\": {\n \"url\": \"https://www.gstatic.com/webp/gallery/1.webp\"\n }\n },\n \"explicit_channel_omni_message\": {\n \"SMS\": {\n \"text_message\": {\n \"text\": \"This text message will be sent on SMS if the RCS message fails.\"\n }\n }\n }\n }\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:send", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:send" ] } }, "response": [] } ] } ] }, { "name": "List Messages", "request": { "method": "GET", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages?channel_identity={{CHANNEL_IDENTITY}}&messages_source=DISPATCH_SOURCE", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages" ], "query": [ { "key": "channel_identity", "value": "{{CHANNEL_IDENTITY}}" }, { "key": "contact_id", "value": "{{CONTACT}}", "description": "One of conversation_id or contact_id needs to be present if messages_source is CONVERSATION_SOURCE.", "disabled": true }, { "key": "conversation_id", "value": "{{CONVERSATION}}", "description": "One of conversation_id or contact_id needs to be present if messages_source is CONVERSATION_SOURCE.", "disabled": true }, { "key": "app_id", "value": "{{APP}}", "description": "Id of the app. Required only when messages_source is DISPATCH_SOURCE.", "disabled": true }, { "key": "page_size", "value": "10", "description": "Maximum number of messages to fetch. Defaults to 10 and the maximum is 20.", "disabled": true }, { "key": "page_token", "value": "token", "description": "Next page token previously returned if any.", "disabled": true }, { "key": "start_time", "value": "DATETIME", "description": "List messages after this dateTime(inclusive). e.g. 2023-03-10T09:39:26Z", "disabled": true }, { "key": "end_time", "value": "DATETIME", "description": "List messages before this dateTime(inclusive). e.g. 2050-04-10T09:39:26Z", "disabled": true }, { "key": "view", "value": "WITH_METADATA", "description": "Default: \"WITH_METADATA\"\nEnum: \"WITH_METADATA\" \"WITHOUT_METADATA\"", "disabled": true }, { "key": "messages_source", "value": "DISPATCH_SOURCE", "description": "Default: \"CONVERSATION_SOURCE\"\nEnum: \"CONVERSATION_SOURCE\" \"DISPATCH_SOURCE\"" }, { "key": "only_recipient_originated", "value": "false", "description": "If true, fetch only recipient originated messages. Available only when messages_source is DISPATCH_SOURCE.", "disabled": true } ] }, "description": "This operation lists all messages sent or received via particular Processing Modes.\n\n- When using CONVERSATION mode, this operation lists messages associated with a conversation or a contact.\n- When using DISPATCH mode, this operation lists messages associated with an app.\n\nThe messages are ordered by their accept_time property in descending order, where accept_time is a timestamp of when the message was enqueued by the Conversation API. This means messages received most recently will be listed first.\n" }, "response": [] }, { "name": "List Messages By Channel Identity", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"channel_identities\": [\n \"{{CHANNEL_IDENTITY}}\"\n ],\n \"app_id\": \"{{APP}}\",\n \"messages_source\": \"DISPATCH_SOURCE\",\n \"page_size\": 10,\n \"page_token\": \"\",\n \"view\": \"WITHOUT_METADATA\",\n \"channel\": \"WHATSAPP\",\n \"direction\": \"TO_CONTACT\",\n \"start_time\": \"2026-01-01T08:30:00Z\",\n \"end_time\": \"2026-01-31T22:30:00Z\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:fetch-last-message", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:fetch-last-message" ] }, "description": "Lists the last message sent to a channel identity or list of channel identities. For CONVERSATION_SOURCE mode, you can also query by contact_ids. The contact_ids field is not supported in DISPATCH_SOURCE mode. Note: You can use either contact_ids OR channel_identities, but not both in the same request." }, "response": [ { "name": "By Channel Identities (CONVERSATION_SOURCE)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"channel_identities\": [\n \"{{CHANNEL_IDENTITY}}\",\n \"{{CHANNEL_IDENTITY_2}}\"\n ],\n \"page_size\": 10,\n \"view\": \"WITHOUT_METADATA\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:fetch-last-message", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:fetch-last-message" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" }, { "name": "By Contact IDs (CONVERSATION_SOURCE)", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"contact_ids\": [\n \"{{CONTACT}}\",\n \"{{CONTACT_2}}\"\n ],\n \"page_size\": 10,\n \"view\": \"WITHOUT_METADATA\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:fetch-last-message", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:fetch-last-message" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Get Message", "request": { "method": "GET", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages/:message_id?messages_source=DISPATCH_SOURCE", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages", ":message_id" ], "query": [ { "key": "messages_source", "value": "DISPATCH_SOURCE", "description": "Default: \"CONVERSATION_SOURCE\"\nEnum: \"CONVERSATION_SOURCE\" \"DISPATCH_SOURCE\"" } ], "variable": [ { "key": "message_id", "value": "message_id", "description": "(Required) The unique ID of the message." } ] }, "description": "Retrieves a specific message by its ID." }, "response": [] }, { "name": "Delete Message", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages/:message_id?messages_source=DISPATCH_SOURCE", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages", ":message_id" ], "query": [ { "key": "messages_source", "value": "DISPATCH_SOURCE", "description": "Default: \"CONVERSATION_SOURCE\"\nEnum: \"CONVERSATION_SOURCE\" \"DISPATCH_SOURCE\"" } ], "variable": [ { "key": "message_id", "value": "message_id", "description": "(Required) The unique ID of the message." } ] }, "description": "Delete a specific message by its ID." }, "response": [] } ], "description": "To start sending messages you must have a Conversation API app. The app holds information about the channel credentials and registered webhooks to which the API delivers callbacks such as message delivery reports and contact messages. If you don't already have an app please follow the instructions in the getting started guide available in the Sinch Dashboard to create one.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Webhook", "item": [ { "name": "Create Webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n\t\"app_id\": \"{{APP}}\",\n\t\"target\": \"{{WEBHOOK_URL}}\",\n\t\"target_type\": \"HTTP\",\n\t\"triggers\": [\n\t\t\"MESSAGE_DELIVERY\",\n\t\t\"EVENT_DELIVERY\",\n\t\t\"MESSAGE_INBOUND\",\n\t\t\"EVENT_INBOUND\",\n\t\t\"CONVERSATION_START\",\n\t\t\"CONVERSATION_STOP\",\n \"CONTACT_CREATE\",\n \"CONTACT_DELETE\",\n \"CONTACT_MERGE\",\n \"OPT_IN\",\n \"OPT_OUT\",\n \"CAPABILITY\",\n \"CONVERSATION_DELETE\",\n\t\t\"UNSUPPORTED\"\n\t]\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/webhooks", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "webhooks" ] }, "description": "Creates a webhook for receiving callbacks on specific triggers. You can create up to 20 webhooks per app." }, "response": [] }, { "name": "Update Webhook", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"target\": \"{{WEBHOOK_URL}}\",\n \"target_type\": \"HTTP\",\n \"triggers\": [\n \"MESSAGE_DELIVERY\",\n \"EVENT_DELIVERY\",\n \"MESSAGE_INBOUND\",\n \"EVENT_INBOUND\",\n \"CONVERSATION_START\",\n \"CONVERSATION_STOP\",\n \"UNSUPPORTED\"\n ]\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/webhooks/:webhook_id", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "webhooks", ":webhook_id" ], "variable": [ { "key": "webhook_id", "value": "{{WEBHOOK_ID}}", "description": "(Required) The unique ID of the webhook." } ] }, "description": "Updates an existing webhook as specified by the webhook ID." }, "response": [] }, { "name": "Delete Webhook", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/webhooks/:webhook_id", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "webhooks", ":webhook_id" ], "variable": [ { "key": "webhook_id", "value": "{{WEBHOOK_ID}}", "description": "(Required) The unique ID of the webhook." } ] }, "description": "Deletes a webhook as specified by the webhook ID." }, "response": [] }, { "name": "Get Webhook", "request": { "method": "GET", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/webhooks/:webhook_id", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "webhooks", ":webhook_id" ], "variable": [ { "key": "webhook_id", "value": "{{WEBHOOK_ID}}", "description": "(Required) The unique ID of the webhook." } ] }, "description": "Get a webhook as specified by the webhook ID." }, "response": [] }, { "name": "List Webhooks", "request": { "method": "GET", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/apps/:app_id/webhooks", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "apps", ":app_id", "webhooks" ], "variable": [ { "key": "app_id", "value": "{{APP}}", "description": "(Required) The unique ID of the app." } ] }, "description": "List all webhooks for a given app as specified by the App ID." }, "response": [] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Capability", "item": [ { "name": "Get Capability", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n }\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/capability:query", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "capability:query" ] }, "description": "This method is asynchronous - it immediately returns the requested Capability registration. Capability check is then delivered as a callback to registered webhooks with trigger CAPABILITY for every reachable channel." }, "response": [] } ], "description": "A Capability Query means checking the available options to reach the contact on the channels where it has a channel identity. Capability Queries can only be executed for contacts that already exist in a project/app. For executing the request, it's required to provide either the contactId or the channel recipient identities of the contact. The request is executed asynchronously, therefore the service responds immediately. The result of the Capability Query is sent to the registered webhook for the CAPABILITY trigger.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Consent", "item": [ { "name": "Get identities from consent list", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [], "body": { "mode": "raw", "raw": "{\n \"identities\": [\n {\n \"identity\": \"{{CHANNEL_IDENTITY}}\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/apps/:app_id/consents/:list_type", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "apps", ":app_id", "consents", ":list_type" ], "variable": [ { "key": "app_id", "value": "{{APP}}" }, { "key": "list_type", "value": "OPT_OUT_ALL" } ] } }, "response": [] }, { "name": "Get audit records from consent lists", "request": { "method": "GET", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/apps/:app_id/consents/identities/:identity", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "apps", ":app_id", "consents", "identities", ":identity" ], "variable": [ { "key": "app_id", "value": "{{APP}}" }, { "key": "identity", "value": "{{CHANNEL_IDENTITY}}" } ] } }, "response": [] } ] }, { "name": "Transcode", "item": [ { "name": "Transcode Message", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n\t\"app_id\": \"{{APP}}\",\n \"app_message\": {\n\t\t\"text_message\": {\n\t\t \"text\": \"Text message from Sinch Conversation API.\"\n\t\t}\n },\n \"channels\": [\n \"MESSENGER\",\n \"RCS\",\n \"WHATSAPP\",\n \"SMS\"\n ]\n}" }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/messages:transcode", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages:transcode" ] }, "description": "Transcodes the message from the Conversation API format to the channel-specific formats for the requested channels. No message is sent to the contact." }, "response": [] } ], "description": "Endpoint for transcoding generic message format to channel-specific one.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Project Settings", "item": [ { "name": "Get Project Settings", "request": { "method": "GET", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/settings", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "settings" ] }, "description": "Retrieves the current settings for the specified project." }, "response": [] }, { "name": "Update Project Settings", "request": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"contact_settings\": {\n \"unified_contact_id_enabled\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/settings", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "settings" ] }, "description": "Updates project settings (e.g. enabling/disabling Unified Contact ID)." }, "response": [] }, { "name": "Delete Project Settings", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/settings", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "settings" ] }, "description": "Deletes all project-level settings for the specified project." }, "response": [] }, { "name": "Create Project Settings", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"contact_settings\": {\n \"unified_contact_id_enabled\": true\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{CONVERSATION_API_URL}}/v1/projects/{{PROJECT}}/settings", "host": [ "{{CONVERSATION_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "settings" ] }, "description": "Creates initial settings for the project. Useful for enabling features like Unified Contact ID." }, "response": [] } ] }, { "name": "Template", "item": [ { "name": "Create Template", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"description\": \"Templated message for discount codes\",\n \"default_translation\": \"en-US\",\n \"translations\": [\n {\n \"version\": 1,\n \"language_code\": \"en-US\",\n \"text_message\": {\n \"text\": \"Your discount code is ${discount_code}\"\n },\n \"variables\": [\n {\n \"key\": \"discount_code\",\n \"preview_value\": \"US-SALE-50\"\n }\n ]\n },\n {\n \"version\": 1,\n \"language_code\": \"es-ES\",\n \"text_message\": {\n \"text\": \"Tu código de descuento es ${discount_code}\"\n },\n \"variables\": [\n {\n \"key\": \"discount_code\",\n \"preview_value\": \"ES-SALE-50\"\n }\n ]\n\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{TEMPLATE_API_URL}}/v2/projects/{{PROJECT}}/templates", "host": [ "{{TEMPLATE_API_URL}}" ], "path": [ "v2", "projects", "{{PROJECT}}", "templates" ] } }, "response": [] }, { "name": "Get Template", "request": { "method": "GET", "header": [], "url": { "raw": "{{TEMPLATE_API_URL}}/v2/projects/{{PROJECT}}/templates/{{TEMPLATE}}", "host": [ "{{TEMPLATE_API_URL}}" ], "path": [ "v2", "projects", "{{PROJECT}}", "templates", "{{TEMPLATE}}" ] } }, "response": [] }, { "name": "Delete Template", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{TEMPLATE_API_URL}}/v2/projects/{{PROJECT}}/templates/{{TEMPLATE}}", "host": [ "{{TEMPLATE_API_URL}}" ], "path": [ "v2", "projects", "{{PROJECT}}", "templates", "{{TEMPLATE}}" ] } }, "response": [] }, { "name": "Update Template", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"description\": \"Updated templated message for coupon codes\",\n \"default_translation\": \"en-US\",\n \"version\": 1,\n \"translations\": [\n {\n \"version\": 1,\n \"language_code\": \"en-US\",\n \"text_message\": {\n \"text\": \"Your coupon code is ${coupon_code}\"\n },\n \"variables\": [\n {\n \"key\": \"coupon_code\",\n \"preview_value\": \"US-SALE-50\"\n }\n ]\n },\n {\n \"version\": 1,\n \"language_code\": \"es-ES\",\n \"text_message\": {\n \"text\": \"Tu código de cupón es ${coupon_code}\"\n },\n \"variables\": [\n {\n \"key\": \"coupon_code\",\n \"preview_value\": \"ES-SALE-50\"\n }\n ]\n\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{TEMPLATE_API_URL}}/v2/projects/{{PROJECT}}/templates/{{TEMPLATE}}", "host": [ "{{TEMPLATE_API_URL}}" ], "path": [ "v2", "projects", "{{PROJECT}}", "templates", "{{TEMPLATE}}" ] } }, "response": [] }, { "name": "List Templates", "request": { "method": "GET", "header": [], "url": { "raw": "{{TEMPLATE_API_URL}}/v2/projects/{{PROJECT}}/templates", "host": [ "{{TEMPLATE_API_URL}}" ], "path": [ "v2", "projects", "{{PROJECT}}", "templates" ] } }, "response": [] }, { "name": "List Translations", "request": { "method": "GET", "header": [], "url": { "raw": "{{TEMPLATE_API_URL}}/v2/projects/{{PROJECT}}/templates/{{TEMPLATE}}/translations", "host": [ "{{TEMPLATE_API_URL}}" ], "path": [ "v2", "projects", "{{PROJECT}}", "templates", "{{TEMPLATE}}", "translations" ] } }, "response": [] } ], "description": "Endpoints for managing message templates.", "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }, { "name": "Batch", "item": [ { "name": "Send Batch", "request": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"message\": {\n \"text_message\": {\n \"text\": \"Hello ${user}! Your code is ${code}\"\n }\n },\n \"recipient_and_params\": [\n {\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY_1}}\"\n }\n ]\n }\n },\n \"parameters\": {\n \"user\": \"User 1\",\n \"code\": \"123\"\n }\n },\n {\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY_2}}\"\n }\n ]\n }\n },\n \"parameters\": {\n \"user\": \"User 2\",\n \"code\": \"456\"\n }\n },\n {\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY_3}}\"\n }\n ]\n }\n },\n \"parameters\": {\n \"user\": \"User 3\",\n \"code\": \"789\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{BATCH_API_URL}}/v1/projects/{{PROJECT}}/messages", "host": [ "{{BATCH_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages" ] } }, "response": [ { "name": "Scheduled Batch", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"send_after\": \"2023-11-30T17:00:00\",\n \"message\": {\n \"text_message\": {\n \"text\": \"This is a scheduled message for 3 recipients!\"\n }\n },\n \"recipient_and_params\": [\n {\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY_1}}\"\n }\n ]\n }\n }\n },\n {\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY_2}}\"\n }\n ]\n }\n }\n },\n {\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY_3}}\"\n }\n ]\n }\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{BATCH_API_URL}}/v1/projects/{{PROJECT}}/messages", "host": [ "{{BATCH_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" }, { "name": "Batch with Metadata", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"app_id\": \"{{APP}}\",\n \"message\": {\n \"text_message\": {\n \"text\": \"Text message\"\n }\n },\n \"recipient_and_params\": [\n {\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY_1}}\"\n }\n ]\n }\n },\n \"message_metadata\": {\n \"recipient_only\": \"arbitrary_value\",\n \"arbitrary_key\": \"overriding metadata\"\n }\n },\n {\n \"recipient\": {\n \"identified_by\": {\n \"channel_identities\": [\n {\n \"channel\": \"{{CHANNEL}}\",\n \"identity\": \"{{CHANNEL_IDENTITY_2}}\"\n }\n ]\n }\n },\n \"conversation_metadata\": {\n \"recipient_only\": \"arbitrary_value\",\n \"arbitrary_key\": \"overriding metadata\"\n }\n }\n ],\n \"message_metadata\": {\n \"arbitrary_key\": \"arbitrary_value\"\n },\n \"conversation_metadata\": {\n \"arbitrary_key\": \"arbitrary_value\"\n },\n \"batch_metadata\": {\n \"CampaignId\": \"ef6b5e86-3a1f-43b4-8cba-d44b2d8162c5\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{BATCH_API_URL}}/v1/projects/{{PROJECT}}/messages", "host": [ "{{BATCH_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Cancel Scheduled Batch", "request": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "{\n \"batch_id\": \"01GJJE4HZTAR53YE1WAA6VCF4D\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{BATCH_API_URL}}/v1/projects/{{PROJECT}}/messages", "host": [ "{{BATCH_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages" ] } }, "response": [ { "name": "Cancel by Metadata", "originalRequest": { "method": "DELETE", "header": [], "body": { "mode": "raw", "raw": "{\n \"metadata_filter\": {\n \"key_name\": \"CampaignId\",\n \"key_value\": \"ef6b5e86-3a1f-43b4-8cba-d44b2d8162c5\"\n }\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{BATCH_API_URL}}/v1/projects/{{PROJECT}}/messages", "host": [ "{{BATCH_API_URL}}" ], "path": [ "v1", "projects", "{{PROJECT}}", "messages" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] } ] } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "clientSecret", "value": "{{CLIENT_SECRET}}", "type": "string" }, { "key": "clientId", "value": "{{CLIENT_ID}}", "type": "string" }, { "key": "accessTokenUrl", "value": "{{TOKEN_ENDPOINT}}", "type": "string" }, { "key": "challengeAlgorithm", "value": "S256", "type": "string" }, { "key": "grant_type", "value": "client_credentials", "type": "string" }, { "key": "addTokenTo", "value": "header", "type": "string" }, { "key": "client_authentication", "value": "header", "type": "string" }, { "key": "accessToken", "value": "", "type": "string" }, { "key": "tokenType", "value": "bearer", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "requests": {}, "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "requests": {}, "exec": [ "" ] } } ], "variable": [ { "key": "CONVERSATION_API_URL", "value": "https://eu.conversation.api.sinch.com" }, { "key": "TEMPLATE_API_URL", "value": "https://eu.template.api.sinch.com" }, { "key": "BATCH_API_URL", "value": "https://eu.conversationbatch.api.sinch.com" }, { "key": "PROJECT", "value": "id-of-created-project" }, { "key": "APP", "value": "id-of-created-app" }, { "key": "CONTACT", "value": "id-of-created-contact" }, { "key": "CONVERSATION", "value": "id-of-created-conversation" }, { "key": "CHANNEL", "value": "WHATSAPP" }, { "key": "CHANNEL_IDENTITY", "value": "channel-identity" }, { "key": "WEBHOOK_URL", "value": "your-webhook-url" }, { "key": "WEBHOOK_ID", "value": "id-of-created-webhook" }, { "key": "TOKEN_ENDPOINT", "value": "https://eu.auth.sinch.com/oauth2/token" }, { "key": "CLIENT_ID", "value": "key-id-generated-in-portal" }, { "key": "CLIENT_SECRET", "value": "lopR2azXafao_la6QaVmCERwH5" }, { "key": "TEMPLATE", "value": "id-of-created-template" } ] }