{"id":448,"date":"2026-11-09T19:25:03","date_gmt":"2026-11-09T19:25:03","guid":{"rendered":"https:\/\/sms.es\/?page_id=448"},"modified":"2026-11-09T19:27:16","modified_gmt":"2026-11-09T19:27:16","slug":"docs-omnichannel-api","status":"publish","type":"page","link":"https:\/\/sms.es\/en\/docs-omnichannel-api\/","title":{"rendered":""},"content":{"rendered":"\n<!-- SMS.es Developers \u00b7 Omnichannel \/ Unifier API docs \u00b7 requires sms-devdocs.css + sms-devdocs.js -->\n<!-- Change the API base URL in data-base-url below: every code sample updates automatically. -->\n<link rel=\"preconnect\" href=\"https:\/\/fonts.googleapis.com\"><link rel=\"preconnect\" href=\"https:\/\/fonts.gstatic.com\" crossorigin>\n<link href=\"https:\/\/fonts.googleapis.com\/css2?family=DM+Sans:wght@400;500;600;700&#038;family=JetBrains+Mono:wght@400;600&#038;display=swap\" rel=\"stylesheet\">\n<div id=\"sms-devdocs\" data-base-url=\"https:\/\/unifier.sms.es\">\n  <div class=\"sms-top\">\n    <button type=\"button\" class=\"sms-burger\" aria-label=\"Menu\"><span><\/span><span><\/span><span><\/span><\/button>\n    <a class=\"sms-brand\" href=\"#omnichannel-overview\">SMS<b>.es<\/b> <span>Developers<\/span><\/a>\n    <span class=\"sms-top-sec\">Omnichannel<\/span>\n    <span class=\"sms-top-sp\"><\/span>\n    <input type=\"search\" class=\"sms-search\" placeholder=\"Search\" aria-label=\"Search\">\n  <\/div>\n  <div class=\"sms-layout\">\n    <aside class=\"sms-side\">\n      <div class=\"sms-side-h\">Omnichannel<\/div>\n      <ul class=\"sms-nav-l\"><li><a href=\"#omnichannel-overview\" data-id=\"omnichannel-overview\" class=\"\">Overview<\/a><\/li><li><a href=\"#use-cases\" data-id=\"use-cases\" class=\"\">Use Cases<\/a><\/li><li class=\"sms-nav-c\" data-cat=\"unifier-api\"><div class=\"sms-nav-row\"><a href=\"#unifier-api\" data-id=\"unifier-api\">Unifier API<\/a><button type=\"button\" class=\"sms-nav-tg\" aria-label=\"Toggle\"><\/button><\/div><ul class=\"sms-nav-l\"><li><a href=\"#unifier-api-introduction\" data-id=\"unifier-api-introduction\" class=\"\">Introduction<\/a><\/li><li class=\"sms-nav-c\" data-cat=\"message-request\"><div class=\"sms-nav-row\"><a href=\"#message-request\" data-id=\"message-request\">Message Request<\/a><button type=\"button\" class=\"sms-nav-tg\" aria-label=\"Toggle\"><\/button><\/div><ul class=\"sms-nav-l\"><li><a href=\"#send-message\" data-id=\"send-message\" class=\"sms-nav-api\">Request to send a message that may include fallback messages to a receiver<span class=\"sms-nm sms-nm--post\">POST<\/span><\/a><\/li><\/ul><\/li><li class=\"sms-nav-c\" data-cat=\"message-retrievers\"><div class=\"sms-nav-row\"><a href=\"#message-retrievers\" data-id=\"message-retrievers\">Inbound and Outbound message retrievers<\/a><button type=\"button\" class=\"sms-nav-tg\" aria-label=\"Toggle\"><\/button><\/div><ul class=\"sms-nav-l\"><li><a href=\"#get-message\" data-id=\"get-message\" class=\"sms-nav-api\">Get the message based on the message&#x27;s ID<span class=\"sms-nm sms-nm--get\">GET<\/span><\/a><\/li><\/ul><\/li><li class=\"sms-nav-c\" data-cat=\"notifications\"><div class=\"sms-nav-row\"><a href=\"#notifications\" data-id=\"notifications\">Notifications<\/a><button type=\"button\" class=\"sms-nav-tg\" aria-label=\"Toggle\"><\/button><\/div><ul class=\"sms-nav-l\"><li><a href=\"#get-updates\" data-id=\"get-updates\" class=\"sms-nav-api\">Get list of latest notifications for every message send from the account<span class=\"sms-nm sms-nm--get\">GET<\/span><\/a><\/li><li><a href=\"#receive-notification-webhook\" data-id=\"receive-notification-webhook\" class=\"sms-nav-api\">Receive message update notifications (customer webhook)<span class=\"sms-nm sms-nm--event\">EVENT<\/span><\/a><\/li><\/ul><\/li><li class=\"sms-nav-c\" data-cat=\"senders\"><div class=\"sms-nav-row\"><a href=\"#senders\" data-id=\"senders\">Senders<\/a><button type=\"button\" class=\"sms-nav-tg\" aria-label=\"Toggle\"><\/button><\/div><ul class=\"sms-nav-l\"><li><a href=\"#get-senders\" data-id=\"get-senders\" class=\"sms-nav-api\">Get list of senders filtered by one or more channel types<span class=\"sms-nm sms-nm--get\">GET<\/span><\/a><\/li><\/ul><\/li><li class=\"sms-nav-c\" data-cat=\"inbound-outbound-messages\"><div class=\"sms-nav-row\"><a href=\"#inbound-outbound-messages\" data-id=\"inbound-outbound-messages\">Inbound and Outbound messages<\/a><button type=\"button\" class=\"sms-nav-tg\" aria-label=\"Toggle\"><\/button><\/div><ul class=\"sms-nav-l\"><li><a href=\"#download-file\" data-id=\"download-file\" class=\"sms-nav-api\">Download a media file delivered by inbound message<span class=\"sms-nm sms-nm--get\">GET<\/span><\/a><\/li><\/ul><\/li><\/ul><\/li><\/ul>\n    <\/aside>\n    <main class=\"sms-content\">\n      <article class=\"sms-view\" id=\"sms-v-omnichannel-overview\" data-view=\"omnichannel-overview\" data-title=\"Overview\"><nav class=\"sms-bc\"><a href=\"#omnichannel-overview\" class=\"sms-bc-home\" aria-label=\"Home\"><svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\"><path fill=\"currentColor\" d=\"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6a1 1 0 0 0-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z\"\/><\/svg><\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#omnichannel-overview\">Omnichannel<\/a><span class=\"sms-bc-sep\">\u203a<\/span><span class=\"sms-bc-cur\">Overview<\/span><\/nav>\n<div class=\"sms-md\">\n<h1>Omnichannel<\/h1>\n<p>Omnichannel lets you communicate with your customers across multiple channels through one single interface. With it you can:<\/p>\n<ul>\n<li>send messages with built-in fallback routes,<\/li>\n<li>receive delivery notifications (DLRs),<\/li>\n<li>handle inbound messages,<\/li>\n<li>download inbound media and other event data.<\/li>\n<\/ul>\n<p><b>Supported channels:<\/b> RBM, SMS, Telegram, WhatsApp, Facebook and Instagram Messenger, and Email (outbound only).<\/p>\n<h2>Unifier API<\/h2>\n<p>The Unifier API is the SMS.es HTTP API for omnichannel messaging. Use it to send messages (including fallback routes), retrieve notifications for DLRs and inbound messages, and download inbound media and other events.<\/p>\n<p>The complete API reference is available in the <a href=\"#unifier-api-introduction\">OpenAPI specification<\/a>.<\/p>\n<div class=\"sms-cards\">\n<a class=\"sms-card\" href=\"#use-cases\"><div class=\"sms-card-t\">\ud83d\udcc4 Use Cases<\/div><div class=\"sms-card-d\">What you can do with the Unifier API.<\/div><\/a>\n<a class=\"sms-card\" href=\"#unifier-api\"><div class=\"sms-card-t\">\ud83d\uddc3\ufe0f Unifier API<\/div><div class=\"sms-card-d\">6 items<\/div><\/a>\n<\/div>\n<\/div><nav class=\"sms-pager\"><span><\/span><a class=\"sms-pg sms-pg--next\" href=\"#use-cases\"><span>Next<\/span><b>Use Cases \u00bb<\/b><\/a><\/nav><\/article><article class=\"sms-view\" id=\"sms-v-use-cases\" data-view=\"use-cases\" data-title=\"Use Cases\" hidden><nav class=\"sms-bc\"><a href=\"#omnichannel-overview\" class=\"sms-bc-home\" aria-label=\"Home\"><svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\"><path fill=\"currentColor\" d=\"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6a1 1 0 0 0-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z\"\/><\/svg><\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#omnichannel-overview\">Omnichannel<\/a><span class=\"sms-bc-sep\">\u203a<\/span><span class=\"sms-bc-cur\">Use Cases<\/span><\/nav>\n<div class=\"sms-md\">\n<h1>What You Can Do with the Unifier API<\/h1>\n<p>The SMS.es Unifier API lets you send and receive messages across multiple channels through a single interface \u2014 with built-in fallback routes, delivery tracking and inbound message handling.<\/p>\n<ul>\n<li><b>Send messages<\/b> \u2014 send a message to a receiver on any supported channel, with one or more fallback messages if the primary channel fails.<\/li>\n<li><b>Retrieve messages<\/b> \u2014 get a previously sent message by its ID, including its sender, receiver, channel and body.<\/li>\n<li><b>Get notifications<\/b> \u2014 poll for the latest notifications (DLRs, inbound messages and fallback events) across all channels.<\/li>\n<li><b>Webhooks<\/b> \u2014 register a webhook to receive the same notifications pushed in real time, instead of polling.<\/li>\n<li><b>Download media<\/b> \u2014 download media files (images, audio, video, documents) delivered by inbound messages.<\/li>\n<li><b>Senders<\/b> \u2014 look up the available senders, filtered by one or more channel types.<\/li>\n<\/ul>\n<h2>Supported channels<\/h2>\n<p>RBM, SMS, Telegram, WhatsApp, Facebook and Instagram Messenger, and Email (outbound only).<\/p>\n<h2>Common scenarios<\/h2>\n<ul>\n<li><b>Multi-channel notifications with fallback<\/b> \u2014 for example, try RBM first and fall back to SMS if the receiver doesn\u2019t have RCS.<\/li>\n<li><b>Rich messaging<\/b> \u2014 cards, carousels, WhatsApp templates, location and contact messages, in addition to plain text.<\/li>\n<li><b>Delivery tracking<\/b> \u2014 DLR and status updates via webhook, or by polling for updates.<\/li>\n<li><b>Inbound handling<\/b> \u2014 receive customer replies and download any media they send.<\/li>\n<\/ul>\n<h2>Authentication<\/h2>\n<p>Every REST call, except your own webhook endpoint, must include the API key in the <code>X-API-Key<\/code> header. The key is the <code>client_secret<\/code> of your customer connection; some deployments also enforce an IP whitelist.<\/p>\n<h2 id=\"send-a-message-with-a-fallback\">Send a Message with a Fallback<\/h2>\n<div class=\"sms-code\" data-lang=\"bash\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>curl -X POST &quot;{{BASE}}\/v1\/messages&quot; \\\n  -H &quot;X-API-Key: &lt;X-API-Key&gt;&quot; \\\n  -H &quot;Content-Type: application\/json&quot; \\\n  -d &#x27;{\n  &quot;message&quot;: {\n    &quot;sender&quot;: &quot;SMSes_Agent&quot;,\n    &quot;receiver&quot;: &quot;34600123456&quot;,\n    &quot;channel&quot;: &quot;whatsApp&quot;,\n    &quot;body&quot;: {\n      &quot;textMessage&quot;: {\n        &quot;content&quot;: &quot;Your order has shipped!&quot;\n      }\n    }\n  },\n  &quot;fallback&quot;: [\n    {\n      &quot;sender&quot;: &quot;SMSes&quot;,\n      &quot;receiver&quot;: &quot;34600123456&quot;,\n      &quot;channel&quot;: &quot;sms&quot;,\n      &quot;body&quot;: {\n        &quot;textMessage&quot;: {\n          &quot;content&quot;: &quot;Your order has shipped! (SMS fallback)&quot;\n        }\n      }\n    }\n  ]\n}&#x27;<\/code><\/pre><\/div>\n<p>The response confirms which channel actually carried the message:<\/p>\n<div class=\"sms-code\" data-lang=\"json\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;message&quot;: {\n    &quot;msgId&quot;: &quot;b1f6b8b2-6e7b-4a9a-9a3e-2f7e6a3c9b10&quot;,\n    &quot;channel&quot;: &quot;whatsApp&quot;,\n    &quot;hasFallbacks&quot;: true\n  }\n}<\/code><\/pre><\/div>\n<h2>Get the Latest Notifications<\/h2>\n<div class=\"sms-code\" data-lang=\"bash\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>curl &quot;{{BASE}}\/v1\/updates?order=desc&quot; \\\n  -H &quot;X-API-Key: &lt;X-API-Key&gt;&quot;<\/code><\/pre><\/div>\n<h2>List Senders by Channel<\/h2>\n<div class=\"sms-code\" data-lang=\"bash\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>curl &quot;{{BASE}}\/v1\/senders?channelType=whatsApp,sms&quot; \\\n  -H &quot;X-API-Key: &lt;X-API-Key&gt;&quot;<\/code><\/pre><\/div>\n<h2 id=\"receiving-notifications-via-webhook\">Receiving Notifications via Webhook<\/h2>\n<p>Instead of polling for updates, register a webhook URL in your connection settings to receive the same <code>Notification<\/code> payloads pushed in real time. Each request carries an <code>X-Msg-Api-Signature<\/code> header (<code>base64(SHA512(body + verifyToken))<\/code>) so you can verify that it was sent by the platform.<\/p>\n<h2>Technical Characteristics<\/h2>\n<ul>\n<li>REST HTTP API with JSON payloads<\/li>\n<li>API key authentication (<code>X-API-Key<\/code> header), with optional IP whitelisting<\/li>\n<li>Multi-channel: RBM, SMS, Telegram, WhatsApp, Facebook and Instagram Messenger, and Email (outbound only)<\/li>\n<li>Fallback message chains and rich message types (text, media, cards, carousels, templates, location, contacts)<\/li>\n<li>Push notifications via signed webhook, or on-demand polling for updates<\/li>\n<\/ul>\n<\/div><nav class=\"sms-pager\"><a class=\"sms-pg sms-pg--prev\" href=\"#omnichannel-overview\"><span>Previous<\/span><b>\u00ab Overview<\/b><\/a><a class=\"sms-pg sms-pg--next\" href=\"#unifier-api\"><span>Next<\/span><b>Unifier API \u00bb<\/b><\/a><\/nav><\/article><article class=\"sms-view\" id=\"sms-v-unifier-api\" data-view=\"unifier-api\" data-title=\"Unifier API\" hidden><nav class=\"sms-bc\"><a href=\"#omnichannel-overview\" class=\"sms-bc-home\" aria-label=\"Home\"><svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\"><path fill=\"currentColor\" d=\"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6a1 1 0 0 0-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z\"\/><\/svg><\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#omnichannel-overview\">Omnichannel<\/a><span class=\"sms-bc-sep\">\u203a<\/span><span class=\"sms-bc-cur\">Unifier API<\/span><\/nav>\n<div class=\"sms-md\">\n<h1>Unifier API<\/h1>\n<p>The Unifier API is the SMS.es HTTP API for omnichannel messaging. Use it to send messages (including fallback routes), retrieve notifications for DLRs and inbound messages, and download inbound media and other events.<\/p>\n<div class=\"sms-cards\">\n<a class=\"sms-card\" href=\"#unifier-api-introduction\"><div class=\"sms-card-t\">\ud83d\udcc4 Introduction<\/div><div class=\"sms-card-d\">Unifier API is an HTTP API for omnichannel messaging.<\/div><\/a>\n<a class=\"sms-card\" href=\"#message-request\"><div class=\"sms-card-t\">\ud83d\uddc3\ufe0f Message Request<\/div><div class=\"sms-card-d\">1 item<\/div><\/a>\n<a class=\"sms-card\" href=\"#message-retrievers\"><div class=\"sms-card-t\">\ud83d\uddc3\ufe0f Inbound and Outbound message retrievers<\/div><div class=\"sms-card-d\">1 item<\/div><\/a>\n<a class=\"sms-card\" href=\"#notifications\"><div class=\"sms-card-t\">\ud83d\uddc3\ufe0f Notifications<\/div><div class=\"sms-card-d\">2 items<\/div><\/a>\n<a class=\"sms-card\" href=\"#senders\"><div class=\"sms-card-t\">\ud83d\uddc3\ufe0f Senders<\/div><div class=\"sms-card-d\">1 item<\/div><\/a>\n<a class=\"sms-card\" href=\"#inbound-outbound-messages\"><div class=\"sms-card-t\">\ud83d\uddc3\ufe0f Inbound and Outbound messages<\/div><div class=\"sms-card-d\">1 item<\/div><\/a>\n<\/div>\n<\/div><nav class=\"sms-pager\"><a class=\"sms-pg sms-pg--prev\" href=\"#use-cases\"><span>Previous<\/span><b>\u00ab Use Cases<\/b><\/a><a class=\"sms-pg sms-pg--next\" href=\"#unifier-api-introduction\"><span>Next<\/span><b>Introduction \u00bb<\/b><\/a><\/nav><\/article><article class=\"sms-view\" id=\"sms-v-unifier-api-introduction\" data-view=\"unifier-api-introduction\" data-title=\"Introduction\" hidden><nav class=\"sms-bc\"><a href=\"#omnichannel-overview\" class=\"sms-bc-home\" aria-label=\"Home\"><svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\"><path fill=\"currentColor\" d=\"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6a1 1 0 0 0-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z\"\/><\/svg><\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#omnichannel-overview\">Omnichannel<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#unifier-api\">Unifier API<\/a><span class=\"sms-bc-sep\">\u203a<\/span><span class=\"sms-bc-cur\">Introduction<\/span><\/nav>\n<div class=\"sms-md\">\n<span class=\"sms-ver\">Version: 1.0<\/span>\n<h1>UnifierAPI<\/h1>\n<p>Unifier API is an HTTP API for omnichannel messaging. Use it to send messages (including fallback routes), retrieve notifications for DLRs and inbound messages, or download inbound media and other events.<\/p>\n<p>The API base URL is:<\/p>\n<p><code class=\"sms-base\">{{BASE}}<\/code><\/p>\n<p><b>Supported channels:<\/b> RBM, SMS, Telegram, WhatsApp, Email*, Facebook and Instagram Messenger.<br>* Outbound only<\/p>\n<p><b>Typical flows:<\/b><\/p>\n<ul>\n<li>Send messages with optional fallback messages (<code>POST \/v1\/messages<\/code>).<\/li>\n<li>Poll for notifications (<code>GET \/v1\/updates<\/code>).<\/li>\n<li>Register a customer webhook URL in your connection settings to receive the same notification payloads as push-style <code>Notification<\/code> events (signed with <code>X-Msg-Api-Signature<\/code>).<\/li>\n<\/ul>\n<p><b>Authentication:<\/b> every REST call (except your own webhook endpoint) must include the API key in the <code>X-API-Key<\/code> header. Keys are the <code>client_secret<\/code> of the customer connection. Some deployments also enforce an IP whitelist on the connection.<\/p>\n<p><b>Definitions:<\/b><\/p>\n<ul>\n<li><b>Message request<\/b> \u2014 the HTTP request from the customer to the Unifier API to send a message to the intended recipient\u2019s device. It can also contain fallback messages.<\/li>\n<li><b>Outbound message<\/b> \u2014 a message delivered from our service to the telecom network, or to Google RBM, WhatsApp, etc., to terminate on the intended recipient\u2019s device.<\/li>\n<li><b>Inbound message<\/b> \u2014 a message initiated and sent by a mobile subscriber (end user) from their device, routed via the SMS telecom network or Google RBM, WhatsApp, etc., to the designated sender of the message request.<\/li>\n<li><b>DLR<\/b> \u2014 a status sent back by the telecom network to confirm whether a previously submitted SMS was delivered to the recipient\u2019s handset, or to report a failure\/error if delivery was unsuccessful.<\/li>\n<li><b>Notification<\/b> \u2014 information about an inbound message, a DLR or a fallback event.<\/li>\n<\/ul>\n<h2>Authentication<\/h2>\n<div class=\"sms-authbox\">\n<table><tbody>\n<tr><th>Security Scheme Type:<\/th><td>apiKey<\/td><\/tr>\n<tr><th>Header parameter name:<\/th><td>X-API-Key<\/td><\/tr>\n<\/tbody><\/table>\n<p>API key obtained from the <code>client_secret<\/code> of your customer connection. Send it as <code>X-API-Key: &lt;your-key-here&gt;<\/code><\/p>\n<\/div>\n<\/div><nav class=\"sms-pager\"><a class=\"sms-pg sms-pg--prev\" href=\"#unifier-api\"><span>Previous<\/span><b>\u00ab Unifier API<\/b><\/a><a class=\"sms-pg sms-pg--next\" href=\"#message-request\"><span>Next<\/span><b>Message Request \u00bb<\/b><\/a><\/nav><\/article><article class=\"sms-view\" id=\"sms-v-message-request\" data-view=\"message-request\" data-title=\"Message Request\" hidden><nav class=\"sms-bc\"><a href=\"#omnichannel-overview\" class=\"sms-bc-home\" aria-label=\"Home\"><svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\"><path fill=\"currentColor\" d=\"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6a1 1 0 0 0-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z\"\/><\/svg><\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#omnichannel-overview\">Omnichannel<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#unifier-api\">Unifier API<\/a><span class=\"sms-bc-sep\">\u203a<\/span><span class=\"sms-bc-cur\">Message Request<\/span><\/nav>\n<div class=\"sms-md\">\n<h1>Message Request<\/h1>\n<p>A message request is the HTTP request you send to the Unifier API (<code>POST \/v1\/messages<\/code>) to deliver a message to a receiver.<\/p>\n<p>Each request specifies the <code>sender<\/code>, the <code>receiver<\/code>, the <code>channel<\/code> (one of <code>rbm<\/code>, <code>sms<\/code>, <code>telegram<\/code>, <code>whatsApp<\/code>, <code>email<\/code>, <code>instagram<\/code>, <code>facebook<\/code>) and the message body.<\/p>\n<p>The body can be any of the supported message types: plain text, file, audio, picture, video, location, contact card, email, WhatsApp template, RBM card, RBM carousel or RBM suggestions.<\/p>\n<p>A request can also include an optional <code>fallback<\/code> array \u2014 alternate messages, which can target different channels, sent automatically if the primary message is not delivered.<\/p>\n<div class=\"sms-cards\"><a class=\"sms-card\" href=\"#send-message\"><div class=\"sms-card-t\">\ud83d\udcc4\ufe0f Request to send a message that may include fallback messages to a receiver<\/div><div class=\"sms-card-d\">Request to send a message that may include fallback messages to a receiver<\/div><\/a><\/div>\n<\/div><nav class=\"sms-pager\"><a class=\"sms-pg sms-pg--prev\" href=\"#unifier-api-introduction\"><span>Previous<\/span><b>\u00ab Introduction<\/b><\/a><a class=\"sms-pg sms-pg--next\" href=\"#send-message\"><span>Next<\/span><b>Request to send a message that may include fallback messages to a receiver \u00bb<\/b><\/a><\/nav><\/article><article class=\"sms-view\" id=\"sms-v-send-message\" data-view=\"send-message\" data-title=\"Request to send a message that may include fallback messages to a receiver\" hidden><nav class=\"sms-bc\"><a href=\"#omnichannel-overview\" class=\"sms-bc-home\" aria-label=\"Home\"><svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\"><path fill=\"currentColor\" d=\"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6a1 1 0 0 0-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z\"\/><\/svg><\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#omnichannel-overview\">Omnichannel<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#unifier-api\">Unifier API<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#message-request\">Message Request<\/a><span class=\"sms-bc-sep\">\u203a<\/span><span class=\"sms-bc-cur\">Request to send a message that may include fallback messages to a receiver<\/span><\/nav><div class=\"sms-api\"><div class=\"sms-api-main\"><h1>Request to send a message that may include fallback messages to a receiver<\/h1><div class=\"sms-ep\"><span class=\"sms-m sms-m--post\">POST<\/span><span class=\"sms-ep-p\">\/v1\/messages<\/span><\/div><hr><div class=\"sms-md\"><p>Request to send a message that may include fallback messages to a receiver.<\/p><\/div><h2>Request<\/h2><div class=\"sms-mime\">application\/json<\/div><div class=\"sms-tabs sms-tabs--box\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"5-0\">Example (auto)<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"5-1\">Body<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"5-0\"><div class=\"sms-code\" data-lang=\"json\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;message&quot;: {\n    &quot;msgId&quot;: &quot;string&quot;,\n    &quot;sender&quot;: &quot;string&quot;,\n    &quot;receiver&quot;: &quot;string&quot;,\n    &quot;channel&quot;: &quot;rbm&quot;,\n    &quot;validityPeriod&quot;: 0,\n    &quot;connectionCName&quot;: &quot;string&quot;,\n    &quot;dcs&quot;: &quot;gsm&quot;,\n    &quot;body&quot;: {\n      &quot;fileMessage&quot;: {\n        &quot;name&quot;: &quot;string&quot;,\n        &quot;url&quot;: &quot;string&quot;,\n        &quot;fileType&quot;: &quot;string&quot;,\n        &quot;mimeType&quot;: &quot;string&quot;,\n        &quot;size&quot;: 0,\n        &quot;playingLength&quot;: &quot;string&quot;,\n        &quot;thumbnailName&quot;: &quot;string&quot;,\n        &quot;thumbnailUrl&quot;: &quot;string&quot;,\n        &quot;thumbnailMimeType&quot;: &quot;string&quot;,\n        &quot;thumbnailSize&quot;: 0\n      }\n    },\n    &quot;custom&quot;: {}\n  },\n  &quot;fallback&quot;: [\n    {\n      &quot;msgId&quot;: &quot;string&quot;,\n      &quot;sender&quot;: &quot;string&quot;,\n      &quot;receiver&quot;: &quot;string&quot;,\n      &quot;channel&quot;: &quot;rbm&quot;,\n      &quot;validityPeriod&quot;: 0,\n      &quot;connectionCName&quot;: &quot;string&quot;,\n      &quot;dcs&quot;: &quot;gsm&quot;,\n      &quot;body&quot;: {\n        &quot;fileMessage&quot;: {\n          &quot;name&quot;: &quot;string&quot;,\n          &quot;url&quot;: &quot;string&quot;,\n          &quot;fileType&quot;: &quot;string&quot;,\n          &quot;mimeType&quot;: &quot;string&quot;,\n          &quot;size&quot;: 0,\n          &quot;playingLength&quot;: &quot;string&quot;,\n          &quot;thumbnailName&quot;: &quot;string&quot;,\n          &quot;thumbnailUrl&quot;: &quot;string&quot;,\n          &quot;thumbnailMimeType&quot;: &quot;string&quot;,\n          &quot;thumbnailSize&quot;: 0\n        }\n      },\n      &quot;custom&quot;: {}\n    }\n  ]\n}<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"5-1\"><details class=\"sms-schema\" open><summary><b>Body<\/b><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">message<\/span><span class=\"sms-pt\">object<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">msgId<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">sender<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">Depends on the channel: RBM \u2014 agent ID; SMS \u2014 short code or alphanumeric sender ID; Telegram \u2014 bot username; WhatsApp \u2014 sender phone number.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">receiver<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">Depends on the channel: RBM, WhatsApp and SMS \u2014 phone number; Telegram \u2014 numeric user ID (not the username).<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">channel<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-enum\">Possible values: [<code>rbm<\/code>], [<code>sms<\/code>], [<code>telegram<\/code>], [<code>whatsApp<\/code>], [<code>email<\/code>], [<code>instagram<\/code>], [<code>facebook<\/code>]<\/div><div class=\"sms-pd\">Channel identifier (<code>rbm<\/code> is RCS Business Messaging).<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">validityPeriod<\/span><span class=\"sms-pt\">number<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">connectionCName<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-pd\">Only needed for SMS messages when no default omnichannel connection is whitelisted for the account.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">dcs<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>gsm<\/code>], [<code>unicode<\/code>], [<code>auto<\/code>]<\/div><div class=\"sms-pd\">Only needed for SMS messages, when the sender&#8217;s encoding is set to \u00abauto\u00bb.<\/div><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">body<\/span><span class=\"sms-pt\">oneOf<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-oneof\"><div class=\"sms-oneof-h\">oneOf<\/div><div class=\"sms-tabs sms-tabs--pill\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"1-0\">FileMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"1-1\">TextMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"1-2\">AudioMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"1-3\">PictureMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"1-4\">VideoMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"1-5\">LocationMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"1-6\">ContactMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"1-7\">TemplateMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"1-8\">EmailMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"1-9\">CardMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"1-10\">SuggestionsMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"1-11\">CarouselMessage<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"1-0\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">fileMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">fileType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">playingLength<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailMimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailSize<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"1-1\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">textMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">content<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"1-2\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">audioMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">playingLength<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"1-3\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">pictureMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailMimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailSize<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"1-4\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">videoMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">playingLength<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailMimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailSize<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"1-5\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">locationMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"1-6\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">contactMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">email<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">address<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">phone<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">firstName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">lastName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">country<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">language<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"1-7\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">WhatsApp template name.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">languageCode<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">components<\/span><span class=\"sms-pt\">TemplateComponent[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">type<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">subType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">index<\/span><span class=\"sms-pt\">integer<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">parameters<\/span><span class=\"sms-pt\">ComponentParameter[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-oneof\"><div class=\"sms-oneof-h\">oneOf<\/div><div class=\"sms-tabs sms-tabs--pill\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"2-0\">ComponentParameterCurrency<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"2-1\">ComponentParameterDateTime<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"2-2\">ComponentParameterDocument<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"2-3\">ComponentParameterImage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"2-4\">ComponentParameterVideo<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"2-0\"><div class=\"sms-prop\"><span class=\"sms-pn\">code<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">ISO 4217 currency code (e.g. USD, EUR, GBP, TRY, INR). Tells WhatsApp which currency format to use.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">amount1000<\/span><span class=\"sms-pt\">integer<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">Amount multiplied by 1000.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">fallbackValue<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-pd\">Text displayed if the device cannot localise the currency.<\/div><\/div><\/div><div class=\"sms-pane\" data-pane=\"2-1\"><div class=\"sms-prop\"><span class=\"sms-pn\">fallbackValue<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><div class=\"sms-pane\" data-pane=\"2-2\"><div class=\"sms-prop\"><span class=\"sms-pn\">link<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><div class=\"sms-pane\" data-pane=\"2-3\"><div class=\"sms-prop\"><span class=\"sms-pn\">link<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><div class=\"sms-pane\" data-pane=\"2-4\"><div class=\"sms-prop\"><span class=\"sms-pn\">link<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/div><\/div><div class=\"sms-arr\">]<\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"1-8\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">emailMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">subject<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">htmlContent<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">textContent<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"1-9\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">layout<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Rich card layout<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardOrientation<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>HORIZONTAL<\/code>], [<code>VERTICAL<\/code>]<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">imageAlignment<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>LEFT<\/code>], [<code>RIGHT<\/code>]<\/div><div class=\"sms-pd\">Required if cardOrientation is HORIZONTAL.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardWidth<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SMALL_WIDTH<\/code>], [<code>MEDIUM_WIDTH<\/code>]<\/div><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">content<\/span><span class=\"sms-pt\">object<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Content of a card message<\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">media<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Media elements<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">height<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SHORT_HEIGHT<\/code>], [<code>MEDIUM_HEIGHT<\/code>], [<code>TALL_HEIGHT<\/code>]<\/div><\/div><\/div><\/details><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">suggestions<\/span><span class=\"sms-pt\">Suggestion[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">replyWith<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">openUrl<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">dialNumber<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">composeMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">showMapLocation<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">label<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">createCalendarEvent<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">start<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">end<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"1-10\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">suggestions<\/span><span class=\"sms-pt\">Suggestion[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">replyWith<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">openUrl<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">dialNumber<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">composeMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">showMapLocation<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">label<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">createCalendarEvent<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">start<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">end<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"1-11\"><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">layout<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Rich card layout<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardOrientation<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>HORIZONTAL<\/code>], [<code>VERTICAL<\/code>]<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">imageAlignment<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>LEFT<\/code>], [<code>RIGHT<\/code>]<\/div><div class=\"sms-pd\">Required if cardOrientation is HORIZONTAL.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardWidth<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SMALL_WIDTH<\/code>], [<code>MEDIUM_WIDTH<\/code>]<\/div><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">content<\/span><span class=\"sms-pt\">MessageContentCard[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">media<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Media elements<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">height<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SHORT_HEIGHT<\/code>], [<code>MEDIUM_HEIGHT<\/code>], [<code>TALL_HEIGHT<\/code>]<\/div><\/div><\/div><\/details><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">suggestions<\/span><span class=\"sms-pt\">Suggestion[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">replyWith<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">openUrl<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">dialNumber<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">composeMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">showMapLocation<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">label<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">createCalendarEvent<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">start<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">end<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/div><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">custom<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Optional key-value map for client-specific metadata.<\/div><div class=\"sms-sch-empty\">object<\/div><\/div><\/details><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">fallback<\/span><span class=\"sms-pt\">IndividualMessage[]<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">msgId<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">sender<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">Depends on the channel: RBM \u2014 agent ID; SMS \u2014 short code or alphanumeric sender ID; Telegram \u2014 bot username; WhatsApp \u2014 sender phone number.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">receiver<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">Depends on the channel: RBM, WhatsApp and SMS \u2014 phone number; Telegram \u2014 numeric user ID (not the username).<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">channel<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-enum\">Possible values: [<code>rbm<\/code>], [<code>sms<\/code>], [<code>telegram<\/code>], [<code>whatsApp<\/code>], [<code>email<\/code>], [<code>instagram<\/code>], [<code>facebook<\/code>]<\/div><div class=\"sms-pd\">Channel identifier (<code>rbm<\/code> is RCS Business Messaging).<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">validityPeriod<\/span><span class=\"sms-pt\">number<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">connectionCName<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-pd\">Only needed for SMS messages when no default omnichannel connection is whitelisted for the account.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">dcs<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>gsm<\/code>], [<code>unicode<\/code>], [<code>auto<\/code>]<\/div><div class=\"sms-pd\">Only needed for SMS messages, when the sender&#8217;s encoding is set to \u00abauto\u00bb.<\/div><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">body<\/span><span class=\"sms-pt\">oneOf<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-oneof\"><div class=\"sms-oneof-h\">oneOf<\/div><div class=\"sms-tabs sms-tabs--pill\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"3-0\">FileMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"3-1\">TextMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"3-2\">AudioMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"3-3\">PictureMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"3-4\">VideoMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"3-5\">LocationMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"3-6\">ContactMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"3-7\">TemplateMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"3-8\">EmailMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"3-9\">CardMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"3-10\">SuggestionsMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"3-11\">CarouselMessage<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"3-0\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">fileMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">fileType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">playingLength<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailMimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailSize<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"3-1\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">textMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">content<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"3-2\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">audioMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">playingLength<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"3-3\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">pictureMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailMimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailSize<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"3-4\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">videoMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">playingLength<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailMimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailSize<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"3-5\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">locationMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"3-6\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">contactMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">email<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">address<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">phone<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">firstName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">lastName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">country<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">language<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"3-7\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">WhatsApp template name.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">languageCode<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">components<\/span><span class=\"sms-pt\">TemplateComponent[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">type<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">subType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">index<\/span><span class=\"sms-pt\">integer<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">parameters<\/span><span class=\"sms-pt\">ComponentParameter[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-oneof\"><div class=\"sms-oneof-h\">oneOf<\/div><div class=\"sms-tabs sms-tabs--pill\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"4-0\">ComponentParameterCurrency<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"4-1\">ComponentParameterDateTime<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"4-2\">ComponentParameterDocument<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"4-3\">ComponentParameterImage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"4-4\">ComponentParameterVideo<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"4-0\"><div class=\"sms-prop\"><span class=\"sms-pn\">code<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">ISO 4217 currency code (e.g. USD, EUR, GBP, TRY, INR). Tells WhatsApp which currency format to use.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">amount1000<\/span><span class=\"sms-pt\">integer<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">Amount multiplied by 1000.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">fallbackValue<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-pd\">Text displayed if the device cannot localise the currency.<\/div><\/div><\/div><div class=\"sms-pane\" data-pane=\"4-1\"><div class=\"sms-prop\"><span class=\"sms-pn\">fallbackValue<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><div class=\"sms-pane\" data-pane=\"4-2\"><div class=\"sms-prop\"><span class=\"sms-pn\">link<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><div class=\"sms-pane\" data-pane=\"4-3\"><div class=\"sms-prop\"><span class=\"sms-pn\">link<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><div class=\"sms-pane\" data-pane=\"4-4\"><div class=\"sms-prop\"><span class=\"sms-pn\">link<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/div><\/div><div class=\"sms-arr\">]<\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"3-8\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">emailMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">subject<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">htmlContent<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">textContent<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"3-9\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">layout<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Rich card layout<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardOrientation<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>HORIZONTAL<\/code>], [<code>VERTICAL<\/code>]<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">imageAlignment<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>LEFT<\/code>], [<code>RIGHT<\/code>]<\/div><div class=\"sms-pd\">Required if cardOrientation is HORIZONTAL.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardWidth<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SMALL_WIDTH<\/code>], [<code>MEDIUM_WIDTH<\/code>]<\/div><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">content<\/span><span class=\"sms-pt\">object<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Content of a card message<\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">media<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Media elements<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">height<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SHORT_HEIGHT<\/code>], [<code>MEDIUM_HEIGHT<\/code>], [<code>TALL_HEIGHT<\/code>]<\/div><\/div><\/div><\/details><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">suggestions<\/span><span class=\"sms-pt\">Suggestion[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">replyWith<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">openUrl<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">dialNumber<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">composeMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">showMapLocation<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">label<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">createCalendarEvent<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">start<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">end<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"3-10\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">suggestions<\/span><span class=\"sms-pt\">Suggestion[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">replyWith<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">openUrl<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">dialNumber<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">composeMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">showMapLocation<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">label<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">createCalendarEvent<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">start<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">end<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"3-11\"><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">layout<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Rich card layout<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardOrientation<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>HORIZONTAL<\/code>], [<code>VERTICAL<\/code>]<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">imageAlignment<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>LEFT<\/code>], [<code>RIGHT<\/code>]<\/div><div class=\"sms-pd\">Required if cardOrientation is HORIZONTAL.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardWidth<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SMALL_WIDTH<\/code>], [<code>MEDIUM_WIDTH<\/code>]<\/div><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">content<\/span><span class=\"sms-pt\">MessageContentCard[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">media<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Media elements<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">height<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SHORT_HEIGHT<\/code>], [<code>MEDIUM_HEIGHT<\/code>], [<code>TALL_HEIGHT<\/code>]<\/div><\/div><\/div><\/details><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">suggestions<\/span><span class=\"sms-pt\">Suggestion[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">replyWith<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">openUrl<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">dialNumber<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">composeMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">showMapLocation<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">label<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">createCalendarEvent<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">start<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">end<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/div><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">custom<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Optional key-value map for client-specific metadata.<\/div><div class=\"sms-sch-empty\">object<\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/details><\/div><\/div><h2>Responses<\/h2><div class=\"sms-tabs sms-tabs--resp\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab sms-rc sms-rc--2 is-on\" data-tab=\"8-0\">200<\/button><button type=\"button\" class=\"sms-tab sms-rc sms-rc--4\" data-tab=\"8-1\">400<\/button><button type=\"button\" class=\"sms-tab sms-rc sms-rc--4\" data-tab=\"8-2\">401<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"8-0\"><p class=\"sms-rdesc\">Successful operation (message accepted for processing; implementation returns HTTP 200).<\/p><div class=\"sms-mime\">application\/json<\/div><div class=\"sms-tabs sms-tabs--box\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"6-0\">Example<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"6-1\">Schema<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"6-0\"><div class=\"sms-code\" data-lang=\"json\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;message&quot;: {\n    &quot;msgId&quot;: &quot;7d0f9c1e-2b1a-4c3e-9f5a-0e6b2d7a8c41&quot;,\n    &quot;channel&quot;: &quot;rbm&quot;,\n    &quot;hasFallbacks&quot;: true,\n    &quot;smsParts&quot;: {\n      &quot;total&quot;: 0\n    }\n  }\n}<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"6-1\"><details class=\"sms-schema\" open><summary><b>Schema<\/b><\/summary><div class=\"sms-nest\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">message<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">msgId<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">channel<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>rbm<\/code>], [<code>sms<\/code>], [<code>telegram<\/code>], [<code>whatsApp<\/code>], [<code>email<\/code>], [<code>instagram<\/code>], [<code>facebook<\/code>]<\/div><div class=\"sms-pd\">Channel identifier (<code>rbm<\/code> is RCS Business Messaging).<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">hasFallbacks<\/span><span class=\"sms-pt\">boolean<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">smsParts<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">total<\/span><span class=\"sms-pt\">number<\/span><\/div><\/div><\/details><\/div><\/details><\/div><\/details><\/div><\/div><\/div><div class=\"sms-pane\" data-pane=\"8-1\"><p class=\"sms-rdesc\">Invalid input<\/p><div class=\"sms-mime\">application\/json<\/div><div class=\"sms-tabs sms-tabs--box\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"7-0\">Example<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"7-1\">Schema<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"7-0\"><div class=\"sms-code\" data-lang=\"json\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;error&quot;: {\n    &quot;code&quot;: &quot;string&quot;,\n    &quot;message&quot;: &quot;string&quot;,\n    &quot;description&quot;: &quot;string&quot;,\n    &quot;items&quot;: [\n      {\n        &quot;name&quot;: &quot;string&quot;,\n        &quot;message&quot;: &quot;string&quot;,\n        &quot;description&quot;: &quot;string&quot;\n      }\n    ]\n  }\n}<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"7-1\"><details class=\"sms-schema\" open><summary><b>Schema<\/b><\/summary><div class=\"sms-nest\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">error<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">code<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">message<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">items<\/span><span class=\"sms-pt\">object[]<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">message<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/details><\/div><\/details><\/div><\/div><\/div><div class=\"sms-pane\" data-pane=\"8-2\"><p class=\"sms-rdesc\">Unauthorized<\/p><\/div><\/div><\/div><aside class=\"sms-api-side\"><div class=\"sms-tabs sms-tabs--lang\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"9-0\">cURL<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"9-1\">Python<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"9-2\">Node.js<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"9-3\">PHP<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"9-4\">Go<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"9-5\">Java<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"9-6\">C#<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"9-7\">Ruby<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"9-8\">PowerShell<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"9-0\"><div class=\"sms-code\" data-lang=\"bash\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>curl -L -X POST &quot;{{BASE}}\/v1\/messages&quot; \\\n  -H &quot;Accept: application\/json&quot; \\\n  -H &quot;X-API-Key: &lt;X-API-Key&gt;&quot; \\\n  -H &quot;Content-Type: application\/json&quot; \\\n  --data-raw &#x27;{\n  &quot;message&quot;: {\n    &quot;msgId&quot;: &quot;7d0f9c1e-2b1a-4c3e-9f5a-0e6b2d7a8c41&quot;,\n    &quot;sender&quot;: &quot;SMSes_Agent&quot;,\n    &quot;receiver&quot;: &quot;34600123456&quot;,\n    &quot;channel&quot;: &quot;rbm&quot;,\n    &quot;body&quot;: {\n      &quot;textMessage&quot;: {\n        &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n      }\n    },\n    &quot;custom&quot;: {\n      &quot;orderId&quot;: &quot;4521&quot;\n    }\n  },\n  &quot;fallback&quot;: [\n    {\n      &quot;sender&quot;: &quot;SMSes&quot;,\n      &quot;receiver&quot;: &quot;34600123456&quot;,\n      &quot;channel&quot;: &quot;sms&quot;,\n      &quot;dcs&quot;: &quot;gsm&quot;,\n      &quot;body&quot;: {\n        &quot;textMessage&quot;: {\n          &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n        }\n      }\n    }\n  ]\n}&#x27;<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"9-1\"><div class=\"sms-code\" data-lang=\"python\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>import requests\n\nurl = &quot;{{BASE}}\/v1\/messages&quot;\nheaders = {\n  &quot;Accept&quot;: &quot;application\/json&quot;,\n  &quot;X-API-Key&quot;: &quot;&lt;X-API-Key&gt;&quot;,\n}\npayload = {\n  &quot;message&quot;: {\n    &quot;msgId&quot;: &quot;7d0f9c1e-2b1a-4c3e-9f5a-0e6b2d7a8c41&quot;,\n    &quot;sender&quot;: &quot;SMSes_Agent&quot;,\n    &quot;receiver&quot;: &quot;34600123456&quot;,\n    &quot;channel&quot;: &quot;rbm&quot;,\n    &quot;body&quot;: {\n      &quot;textMessage&quot;: {\n        &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n      }\n    },\n    &quot;custom&quot;: {\n      &quot;orderId&quot;: &quot;4521&quot;\n    }\n  },\n  &quot;fallback&quot;: [\n    {\n      &quot;sender&quot;: &quot;SMSes&quot;,\n      &quot;receiver&quot;: &quot;34600123456&quot;,\n      &quot;channel&quot;: &quot;sms&quot;,\n      &quot;dcs&quot;: &quot;gsm&quot;,\n      &quot;body&quot;: {\n        &quot;textMessage&quot;: {\n          &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n        }\n      }\n    }\n  ]\n}\n\nresponse = requests.post(url, headers=headers, json=payload)\nprint(response.status_code)\nprint(response.text)<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"9-2\"><div class=\"sms-code\" data-lang=\"javascript\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>const response = await fetch(&quot;{{BASE}}\/v1\/messages&quot;, {\n  method: &quot;POST&quot;,\n  headers: {\n    &quot;Accept&quot;: &quot;application\/json&quot;,\n    &quot;X-API-Key&quot;: &quot;&lt;X-API-Key&gt;&quot;,\n    &quot;Content-Type&quot;: &quot;application\/json&quot;,\n  },\n  body: JSON.stringify({\n    &quot;message&quot;: {\n      &quot;msgId&quot;: &quot;7d0f9c1e-2b1a-4c3e-9f5a-0e6b2d7a8c41&quot;,\n      &quot;sender&quot;: &quot;SMSes_Agent&quot;,\n      &quot;receiver&quot;: &quot;34600123456&quot;,\n      &quot;channel&quot;: &quot;rbm&quot;,\n      &quot;body&quot;: {\n        &quot;textMessage&quot;: {\n          &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n        }\n      },\n      &quot;custom&quot;: {\n        &quot;orderId&quot;: &quot;4521&quot;\n      }\n    },\n    &quot;fallback&quot;: [\n      {\n        &quot;sender&quot;: &quot;SMSes&quot;,\n        &quot;receiver&quot;: &quot;34600123456&quot;,\n        &quot;channel&quot;: &quot;sms&quot;,\n        &quot;dcs&quot;: &quot;gsm&quot;,\n        &quot;body&quot;: {\n          &quot;textMessage&quot;: {\n            &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n          }\n        }\n      }\n    ]\n  }),\n});\nconsole.log(response.status, await response.text());<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"9-3\"><div class=\"sms-code\" data-lang=\"php\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>&lt;?php\n$ch = curl_init(&#x27;{{BASE}}\/v1\/messages&#x27;);\ncurl_setopt_array($ch, [\n  CURLOPT_CUSTOMREQUEST  =&gt; &#x27;POST&#x27;,\n  CURLOPT_RETURNTRANSFER =&gt; true,\n  CURLOPT_HTTPHEADER     =&gt; [\n    &#x27;Accept: application\/json&#x27;,\n    &#x27;X-API-Key: &lt;X-API-Key&gt;&#x27;,\n    &#x27;Content-Type: application\/json&#x27;,\n  ],\n  CURLOPT_POSTFIELDS     =&gt; &lt;&lt;&lt;&#x27;JSON&#x27;\n{\n  &quot;message&quot;: {\n    &quot;msgId&quot;: &quot;7d0f9c1e-2b1a-4c3e-9f5a-0e6b2d7a8c41&quot;,\n    &quot;sender&quot;: &quot;SMSes_Agent&quot;,\n    &quot;receiver&quot;: &quot;34600123456&quot;,\n    &quot;channel&quot;: &quot;rbm&quot;,\n    &quot;body&quot;: {\n      &quot;textMessage&quot;: {\n        &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n      }\n    },\n    &quot;custom&quot;: {\n      &quot;orderId&quot;: &quot;4521&quot;\n    }\n  },\n  &quot;fallback&quot;: [\n    {\n      &quot;sender&quot;: &quot;SMSes&quot;,\n      &quot;receiver&quot;: &quot;34600123456&quot;,\n      &quot;channel&quot;: &quot;sms&quot;,\n      &quot;dcs&quot;: &quot;gsm&quot;,\n      &quot;body&quot;: {\n        &quot;textMessage&quot;: {\n          &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n        }\n      }\n    }\n  ]\n}\nJSON,\n]);\n$response = curl_exec($ch);\necho curl_getinfo($ch, CURLINFO_HTTP_CODE) . PHP_EOL . $response;<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"9-4\"><div class=\"sms-code\" data-lang=\"go\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>package main\n\nimport (\n  &quot;fmt&quot;\n  &quot;io&quot;\n  &quot;net\/http&quot;\n  &quot;strings&quot;\n)\n\nfunc main() {\n  payload := strings.NewReader(`{\n  &quot;message&quot;: {\n    &quot;msgId&quot;: &quot;7d0f9c1e-2b1a-4c3e-9f5a-0e6b2d7a8c41&quot;,\n    &quot;sender&quot;: &quot;SMSes_Agent&quot;,\n    &quot;receiver&quot;: &quot;34600123456&quot;,\n    &quot;channel&quot;: &quot;rbm&quot;,\n    &quot;body&quot;: {\n      &quot;textMessage&quot;: {\n        &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n      }\n    },\n    &quot;custom&quot;: {\n      &quot;orderId&quot;: &quot;4521&quot;\n    }\n  },\n  &quot;fallback&quot;: [\n    {\n      &quot;sender&quot;: &quot;SMSes&quot;,\n      &quot;receiver&quot;: &quot;34600123456&quot;,\n      &quot;channel&quot;: &quot;sms&quot;,\n      &quot;dcs&quot;: &quot;gsm&quot;,\n      &quot;body&quot;: {\n        &quot;textMessage&quot;: {\n          &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n        }\n      }\n    }\n  ]\n}`)\n  req, _ := http.NewRequest(&quot;POST&quot;, &quot;{{BASE}}\/v1\/messages&quot;, payload)\n  req.Header.Add(&quot;Content-Type&quot;, &quot;application\/json&quot;)\n  req.Header.Add(&quot;Accept&quot;, &quot;application\/json&quot;)\n  req.Header.Add(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;)\n\n  res, err := http.DefaultClient.Do(req)\n  if err != nil {\n    panic(err)\n  }\n  defer res.Body.Close()\n  body, _ := io.ReadAll(res.Body)\n  fmt.Println(res.StatusCode, string(body))\n}<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"9-5\"><div class=\"sms-code\" data-lang=\"java\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>import java.net.URI;\nimport java.net.http.*;\n\nHttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n  .uri(URI.create(&quot;{{BASE}}\/v1\/messages&quot;))\n  .header(&quot;Accept&quot;, &quot;application\/json&quot;)\n  .header(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;)\n  .header(&quot;Content-Type&quot;, &quot;application\/json&quot;)\n  .method(&quot;POST&quot;, HttpRequest.BodyPublishers.ofString(&quot;&quot;&quot;\n{\n  &quot;message&quot;: {\n    &quot;msgId&quot;: &quot;7d0f9c1e-2b1a-4c3e-9f5a-0e6b2d7a8c41&quot;,\n    &quot;sender&quot;: &quot;SMSes_Agent&quot;,\n    &quot;receiver&quot;: &quot;34600123456&quot;,\n    &quot;channel&quot;: &quot;rbm&quot;,\n    &quot;body&quot;: {\n      &quot;textMessage&quot;: {\n        &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n      }\n    },\n    &quot;custom&quot;: {\n      &quot;orderId&quot;: &quot;4521&quot;\n    }\n  },\n  &quot;fallback&quot;: [\n    {\n      &quot;sender&quot;: &quot;SMSes&quot;,\n      &quot;receiver&quot;: &quot;34600123456&quot;,\n      &quot;channel&quot;: &quot;sms&quot;,\n      &quot;dcs&quot;: &quot;gsm&quot;,\n      &quot;body&quot;: {\n        &quot;textMessage&quot;: {\n          &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n        }\n      }\n    }\n  ]\n}\n&quot;&quot;&quot;))\n  .build();\nHttpResponse&lt;String&gt; response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.statusCode() + &quot; &quot; + response.body());<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"9-6\"><div class=\"sms-code\" data-lang=\"csharp\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Post, &quot;{{BASE}}\/v1\/messages&quot;);\nrequest.Headers.Add(&quot;Accept&quot;, &quot;application\/json&quot;);\nrequest.Headers.Add(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;);\nrequest.Content = new StringContent(&quot;&quot;&quot;\n{\n  &quot;message&quot;: {\n    &quot;msgId&quot;: &quot;7d0f9c1e-2b1a-4c3e-9f5a-0e6b2d7a8c41&quot;,\n    &quot;sender&quot;: &quot;SMSes_Agent&quot;,\n    &quot;receiver&quot;: &quot;34600123456&quot;,\n    &quot;channel&quot;: &quot;rbm&quot;,\n    &quot;body&quot;: {\n      &quot;textMessage&quot;: {\n        &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n      }\n    },\n    &quot;custom&quot;: {\n      &quot;orderId&quot;: &quot;4521&quot;\n    }\n  },\n  &quot;fallback&quot;: [\n    {\n      &quot;sender&quot;: &quot;SMSes&quot;,\n      &quot;receiver&quot;: &quot;34600123456&quot;,\n      &quot;channel&quot;: &quot;sms&quot;,\n      &quot;dcs&quot;: &quot;gsm&quot;,\n      &quot;body&quot;: {\n        &quot;textMessage&quot;: {\n          &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n        }\n      }\n    }\n  ]\n}\n&quot;&quot;&quot;, System.Text.Encoding.UTF8, &quot;application\/json&quot;);\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"9-7\"><div class=\"sms-code\" data-lang=\"ruby\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>require &quot;uri&quot;\nrequire &quot;json&quot;\nrequire &quot;net\/http&quot;\n\nurl = URI(&quot;{{BASE}}\/v1\/messages&quot;)\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[&quot;Accept&quot;] = &quot;application\/json&quot;\nrequest[&quot;X-API-Key&quot;] = &quot;&lt;X-API-Key&gt;&quot;\nrequest[&quot;Content-Type&quot;] = &quot;application\/json&quot;\nrequest.body = JSON.dump({&quot;message&quot;: {&quot;msgId&quot;: &quot;7d0f9c1e-2b1a-4c3e-9f5a-0e6b2d7a8c41&quot;, &quot;sender&quot;: &quot;SMSes_Agent&quot;, &quot;receiver&quot;: &quot;34600123456&quot;, &quot;channel&quot;: &quot;rbm&quot;, &quot;body&quot;: {&quot;textMessage&quot;: {&quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;}}, &quot;custom&quot;: {&quot;orderId&quot;: &quot;4521&quot;}}, &quot;fallback&quot;: [{&quot;sender&quot;: &quot;SMSes&quot;, &quot;receiver&quot;: &quot;34600123456&quot;, &quot;channel&quot;: &quot;sms&quot;, &quot;dcs&quot;: &quot;gsm&quot;, &quot;body&quot;: {&quot;textMessage&quot;: {&quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;}}}]})\n\nresponse = http.request(request)\nputs response.code, response.read_body<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"9-8\"><div class=\"sms-code\" data-lang=\"powershell\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>$headers = New-Object &quot;System.Collections.Generic.Dictionary[[String],[String]]&quot;\n$headers.Add(&quot;Accept&quot;, &quot;application\/json&quot;)\n$headers.Add(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;)\n$headers.Add(&quot;Content-Type&quot;, &quot;application\/json&quot;)\n\n$body = @&quot;\n{\n  &quot;message&quot;: {\n    &quot;msgId&quot;: &quot;7d0f9c1e-2b1a-4c3e-9f5a-0e6b2d7a8c41&quot;,\n    &quot;sender&quot;: &quot;SMSes_Agent&quot;,\n    &quot;receiver&quot;: &quot;34600123456&quot;,\n    &quot;channel&quot;: &quot;rbm&quot;,\n    &quot;body&quot;: {\n      &quot;textMessage&quot;: {\n        &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n      }\n    },\n    &quot;custom&quot;: {\n      &quot;orderId&quot;: &quot;4521&quot;\n    }\n  },\n  &quot;fallback&quot;: [\n    {\n      &quot;sender&quot;: &quot;SMSes&quot;,\n      &quot;receiver&quot;: &quot;34600123456&quot;,\n      &quot;channel&quot;: &quot;sms&quot;,\n      &quot;dcs&quot;: &quot;gsm&quot;,\n      &quot;body&quot;: {\n        &quot;textMessage&quot;: {\n          &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n        }\n      }\n    }\n  ]\n}\n&quot;@\n\n$response = Invoke-RestMethod &quot;{{BASE}}\/v1\/messages&quot; -Method &quot;POST&quot; -Headers $headers -Body $body\n$response | ConvertTo-Json -Depth 10<\/code><\/pre><\/div><\/div><\/div><div class=\"sms-side-t\">Response<\/div><div class=\"sms-code\" data-lang=\"json\"><div class=\"sms-code-t\">200<\/div><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;message&quot;: {\n    &quot;msgId&quot;: &quot;7d0f9c1e-2b1a-4c3e-9f5a-0e6b2d7a8c41&quot;,\n    &quot;channel&quot;: &quot;rbm&quot;,\n    &quot;hasFallbacks&quot;: true,\n    &quot;smsParts&quot;: {\n      &quot;total&quot;: 0\n    }\n  }\n}<\/code><\/pre><\/div><\/aside><\/div><nav class=\"sms-pager\"><a class=\"sms-pg sms-pg--prev\" href=\"#message-request\"><span>Previous<\/span><b>\u00ab Message Request<\/b><\/a><a class=\"sms-pg sms-pg--next\" href=\"#message-retrievers\"><span>Next<\/span><b>Inbound and Outbound message retrievers \u00bb<\/b><\/a><\/nav><\/article><article class=\"sms-view\" id=\"sms-v-message-retrievers\" data-view=\"message-retrievers\" data-title=\"Inbound and Outbound message retrievers\" hidden><nav class=\"sms-bc\"><a href=\"#omnichannel-overview\" class=\"sms-bc-home\" aria-label=\"Home\"><svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\"><path fill=\"currentColor\" d=\"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6a1 1 0 0 0-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z\"\/><\/svg><\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#omnichannel-overview\">Omnichannel<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#unifier-api\">Unifier API<\/a><span class=\"sms-bc-sep\">\u203a<\/span><span class=\"sms-bc-cur\">Inbound and Outbound message retrievers<\/span><\/nav>\n<div class=\"sms-md\">\n<h1>Inbound and Outbound message retrievers<\/h1>\n<p>Use <code>GET \/v1\/messages\/{msgId}<\/code> to look up a single message by its UUID and get its full details \u2014 sender, receiver, channel and body.<\/p>\n<p>It is useful to check a specific inbound or outbound message without waiting for its next notification event.<\/p>\n<div class=\"sms-cards\"><a class=\"sms-card\" href=\"#get-message\"><div class=\"sms-card-t\">\ud83d\udcc4\ufe0f Get the message based on the message&#x27;s ID<\/div><div class=\"sms-card-d\">Get the message based on the message&#8217;s ID<\/div><\/a><\/div>\n<\/div><nav class=\"sms-pager\"><a class=\"sms-pg sms-pg--prev\" href=\"#send-message\"><span>Previous<\/span><b>\u00ab Request to send a message that may include fallback messages to a receiver<\/b><\/a><a class=\"sms-pg sms-pg--next\" href=\"#get-message\"><span>Next<\/span><b>Get the message based on the message&#x27;s ID \u00bb<\/b><\/a><\/nav><\/article><article class=\"sms-view\" id=\"sms-v-get-message\" data-view=\"get-message\" data-title=\"Get the message based on the message&#x27;s ID\" hidden><nav class=\"sms-bc\"><a href=\"#omnichannel-overview\" class=\"sms-bc-home\" aria-label=\"Home\"><svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\"><path fill=\"currentColor\" d=\"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6a1 1 0 0 0-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z\"\/><\/svg><\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#omnichannel-overview\">Omnichannel<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#unifier-api\">Unifier API<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#message-retrievers\">Inbound and Outbound message retrievers<\/a><span class=\"sms-bc-sep\">\u203a<\/span><span class=\"sms-bc-cur\">Get the message based on the message&#x27;s ID<\/span><\/nav><div class=\"sms-api\"><div class=\"sms-api-main\"><h1>Get the message based on the message&#x27;s ID<\/h1><div class=\"sms-ep\"><span class=\"sms-m sms-m--get\">GET<\/span><span class=\"sms-ep-p\">\/v1\/messages\/{msgId}<\/span><\/div><hr><div class=\"sms-md\"><p>Get the message based on the message&#8217;s ID.<\/p><\/div><h2>Request<\/h2><details class=\"sms-schema\" open><summary><b>Path Parameters<\/b><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">msgId<\/span><span class=\"sms-pt\">uuid<\/span><span class=sms-req>required<\/span><\/div><\/div><\/details><h2>Responses<\/h2><div class=\"sms-tabs sms-tabs--resp\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab sms-rc sms-rc--2 is-on\" data-tab=\"14-0\">200<\/button><button type=\"button\" class=\"sms-tab sms-rc sms-rc--4\" data-tab=\"14-1\">401<\/button><button type=\"button\" class=\"sms-tab sms-rc sms-rc--4\" data-tab=\"14-2\">404<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"14-0\"><p class=\"sms-rdesc\">Return the message.<\/p><div class=\"sms-mime\">application\/json<\/div><div class=\"sms-tabs sms-tabs--box\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"12-0\">Example<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"12-1\">Schema<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"12-0\"><div class=\"sms-code\" data-lang=\"json\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;msgId&quot;: &quot;b1f6b8b2-6e7b-4a9a-9a3e-2f7e6a3c9b10&quot;,\n  &quot;sender&quot;: &quot;SMSes_Agent&quot;,\n  &quot;receiver&quot;: &quot;34600123456&quot;,\n  &quot;channel&quot;: &quot;rbm&quot;,\n  &quot;validityPeriod&quot;: 0,\n  &quot;body&quot;: {\n    &quot;textMessage&quot;: {\n      &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n    }\n  },\n  &quot;custom&quot;: {\n    &quot;orderId&quot;: &quot;4521&quot;\n  }\n}<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"12-1\"><details class=\"sms-schema\" open><summary><b>Schema<\/b><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">msgId<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">sender<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">Depends on the channel: RBM \u2014 agent ID; SMS \u2014 short code or alphanumeric sender ID; Telegram \u2014 bot username; WhatsApp \u2014 sender phone number.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">receiver<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">Depends on the channel: RBM, WhatsApp and SMS \u2014 phone number; Telegram \u2014 numeric user ID (not the username).<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">channel<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-enum\">Possible values: [<code>rbm<\/code>], [<code>sms<\/code>], [<code>telegram<\/code>], [<code>whatsApp<\/code>], [<code>email<\/code>], [<code>instagram<\/code>], [<code>facebook<\/code>]<\/div><div class=\"sms-pd\">Channel identifier (<code>rbm<\/code> is RCS Business Messaging).<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">validityPeriod<\/span><span class=\"sms-pt\">number<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">connectionCName<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-pd\">Only needed for SMS messages when no default omnichannel connection is whitelisted for the account.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">dcs<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>gsm<\/code>], [<code>unicode<\/code>], [<code>auto<\/code>]<\/div><div class=\"sms-pd\">Only needed for SMS messages, when the sender&#8217;s encoding is set to \u00abauto\u00bb.<\/div><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">body<\/span><span class=\"sms-pt\">oneOf<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-oneof\"><div class=\"sms-oneof-h\">oneOf<\/div><div class=\"sms-tabs sms-tabs--pill\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"10-0\">FileMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"10-1\">TextMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"10-2\">AudioMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"10-3\">PictureMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"10-4\">VideoMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"10-5\">LocationMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"10-6\">ContactMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"10-7\">TemplateMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"10-8\">EmailMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"10-9\">CardMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"10-10\">SuggestionsMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"10-11\">CarouselMessage<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"10-0\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">fileMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">fileType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">playingLength<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailMimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailSize<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"10-1\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">textMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">content<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"10-2\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">audioMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">playingLength<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"10-3\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">pictureMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailMimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailSize<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"10-4\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">videoMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">playingLength<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailMimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailSize<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"10-5\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">locationMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"10-6\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">contactMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">email<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">address<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">phone<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">firstName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">lastName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">country<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">language<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"10-7\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">WhatsApp template name.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">languageCode<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">components<\/span><span class=\"sms-pt\">TemplateComponent[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">type<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">subType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">index<\/span><span class=\"sms-pt\">integer<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">parameters<\/span><span class=\"sms-pt\">ComponentParameter[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-oneof\"><div class=\"sms-oneof-h\">oneOf<\/div><div class=\"sms-tabs sms-tabs--pill\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"11-0\">ComponentParameterCurrency<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"11-1\">ComponentParameterDateTime<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"11-2\">ComponentParameterDocument<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"11-3\">ComponentParameterImage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"11-4\">ComponentParameterVideo<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"11-0\"><div class=\"sms-prop\"><span class=\"sms-pn\">code<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">ISO 4217 currency code (e.g. USD, EUR, GBP, TRY, INR). Tells WhatsApp which currency format to use.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">amount1000<\/span><span class=\"sms-pt\">integer<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">Amount multiplied by 1000.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">fallbackValue<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-pd\">Text displayed if the device cannot localise the currency.<\/div><\/div><\/div><div class=\"sms-pane\" data-pane=\"11-1\"><div class=\"sms-prop\"><span class=\"sms-pn\">fallbackValue<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><div class=\"sms-pane\" data-pane=\"11-2\"><div class=\"sms-prop\"><span class=\"sms-pn\">link<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><div class=\"sms-pane\" data-pane=\"11-3\"><div class=\"sms-prop\"><span class=\"sms-pn\">link<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><div class=\"sms-pane\" data-pane=\"11-4\"><div class=\"sms-prop\"><span class=\"sms-pn\">link<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/div><\/div><div class=\"sms-arr\">]<\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"10-8\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">emailMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">subject<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">htmlContent<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">textContent<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"10-9\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">layout<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Rich card layout<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardOrientation<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>HORIZONTAL<\/code>], [<code>VERTICAL<\/code>]<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">imageAlignment<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>LEFT<\/code>], [<code>RIGHT<\/code>]<\/div><div class=\"sms-pd\">Required if cardOrientation is HORIZONTAL.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardWidth<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SMALL_WIDTH<\/code>], [<code>MEDIUM_WIDTH<\/code>]<\/div><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">content<\/span><span class=\"sms-pt\">object<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Content of a card message<\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">media<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Media elements<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">height<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SHORT_HEIGHT<\/code>], [<code>MEDIUM_HEIGHT<\/code>], [<code>TALL_HEIGHT<\/code>]<\/div><\/div><\/div><\/details><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">suggestions<\/span><span class=\"sms-pt\">Suggestion[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">replyWith<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">openUrl<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">dialNumber<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">composeMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">showMapLocation<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">label<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">createCalendarEvent<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">start<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">end<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"10-10\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">suggestions<\/span><span class=\"sms-pt\">Suggestion[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">replyWith<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">openUrl<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">dialNumber<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">composeMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">showMapLocation<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">label<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">createCalendarEvent<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">start<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">end<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"10-11\"><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">layout<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Rich card layout<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardOrientation<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>HORIZONTAL<\/code>], [<code>VERTICAL<\/code>]<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">imageAlignment<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>LEFT<\/code>], [<code>RIGHT<\/code>]<\/div><div class=\"sms-pd\">Required if cardOrientation is HORIZONTAL.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardWidth<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SMALL_WIDTH<\/code>], [<code>MEDIUM_WIDTH<\/code>]<\/div><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">content<\/span><span class=\"sms-pt\">MessageContentCard[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">media<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Media elements<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">height<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SHORT_HEIGHT<\/code>], [<code>MEDIUM_HEIGHT<\/code>], [<code>TALL_HEIGHT<\/code>]<\/div><\/div><\/div><\/details><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">suggestions<\/span><span class=\"sms-pt\">Suggestion[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">replyWith<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">openUrl<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">dialNumber<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">composeMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">showMapLocation<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">label<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">createCalendarEvent<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">start<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">end<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/div><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">custom<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Optional key-value map for client-specific metadata.<\/div><div class=\"sms-sch-empty\">object<\/div><\/div><\/details><\/div><\/details><\/div><\/div><\/div><div class=\"sms-pane\" data-pane=\"14-1\"><p class=\"sms-rdesc\">Unauthorized<\/p><\/div><div class=\"sms-pane\" data-pane=\"14-2\"><p class=\"sms-rdesc\">Not Found<\/p><div class=\"sms-mime\">application\/json<\/div><div class=\"sms-tabs sms-tabs--box\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"13-0\">Example<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"13-1\">Schema<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"13-0\"><div class=\"sms-code\" data-lang=\"json\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;error&quot;: {\n    &quot;code&quot;: &quot;string&quot;,\n    &quot;message&quot;: &quot;string&quot;,\n    &quot;description&quot;: &quot;string&quot;,\n    &quot;items&quot;: [\n      {\n        &quot;name&quot;: &quot;string&quot;,\n        &quot;message&quot;: &quot;string&quot;,\n        &quot;description&quot;: &quot;string&quot;\n      }\n    ]\n  }\n}<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"13-1\"><details class=\"sms-schema\" open><summary><b>Schema<\/b><\/summary><div class=\"sms-nest\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">error<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">code<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">message<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">items<\/span><span class=\"sms-pt\">object[]<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">message<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/details><\/div><\/details><\/div><\/div><\/div><\/div><\/div><aside class=\"sms-api-side\"><div class=\"sms-tabs sms-tabs--lang\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"15-0\">cURL<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"15-1\">Python<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"15-2\">Node.js<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"15-3\">PHP<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"15-4\">Go<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"15-5\">Java<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"15-6\">C#<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"15-7\">Ruby<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"15-8\">PowerShell<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"15-0\"><div class=\"sms-code\" data-lang=\"bash\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>curl -L -X GET &quot;{{BASE}}\/v1\/messages\/b1f6b8b2-6e7b-4a9a-9a3e-2f7e6a3c9b10&quot; \\\n  -H &quot;Accept: application\/json&quot; \\\n  -H &quot;X-API-Key: &lt;X-API-Key&gt;&quot;<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"15-1\"><div class=\"sms-code\" data-lang=\"python\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>import requests\n\nurl = &quot;{{BASE}}\/v1\/messages\/b1f6b8b2-6e7b-4a9a-9a3e-2f7e6a3c9b10&quot;\nheaders = {\n  &quot;Accept&quot;: &quot;application\/json&quot;,\n  &quot;X-API-Key&quot;: &quot;&lt;X-API-Key&gt;&quot;,\n}\n\nresponse = requests.get(url, headers=headers)\nprint(response.status_code)\nprint(response.text)<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"15-2\"><div class=\"sms-code\" data-lang=\"javascript\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>const response = await fetch(&quot;{{BASE}}\/v1\/messages\/b1f6b8b2-6e7b-4a9a-9a3e-2f7e6a3c9b10&quot;, {\n  method: &quot;GET&quot;,\n  headers: {\n    &quot;Accept&quot;: &quot;application\/json&quot;,\n    &quot;X-API-Key&quot;: &quot;&lt;X-API-Key&gt;&quot;,\n  },\n});\nconsole.log(response.status, await response.text());<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"15-3\"><div class=\"sms-code\" data-lang=\"php\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>&lt;?php\n$ch = curl_init(&#x27;{{BASE}}\/v1\/messages\/b1f6b8b2-6e7b-4a9a-9a3e-2f7e6a3c9b10&#x27;);\ncurl_setopt_array($ch, [\n  CURLOPT_CUSTOMREQUEST  =&gt; &#x27;GET&#x27;,\n  CURLOPT_RETURNTRANSFER =&gt; true,\n  CURLOPT_HTTPHEADER     =&gt; [\n    &#x27;Accept: application\/json&#x27;,\n    &#x27;X-API-Key: &lt;X-API-Key&gt;&#x27;,\n  ],\n]);\n$response = curl_exec($ch);\necho curl_getinfo($ch, CURLINFO_HTTP_CODE) . PHP_EOL . $response;<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"15-4\"><div class=\"sms-code\" data-lang=\"go\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>package main\n\nimport (\n  &quot;fmt&quot;\n  &quot;io&quot;\n  &quot;net\/http&quot;\n)\n\nfunc main() {\n  req, _ := http.NewRequest(&quot;GET&quot;, &quot;{{BASE}}\/v1\/messages\/b1f6b8b2-6e7b-4a9a-9a3e-2f7e6a3c9b10&quot;, nil)\n  req.Header.Add(&quot;Accept&quot;, &quot;application\/json&quot;)\n  req.Header.Add(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;)\n\n  res, err := http.DefaultClient.Do(req)\n  if err != nil {\n    panic(err)\n  }\n  defer res.Body.Close()\n  body, _ := io.ReadAll(res.Body)\n  fmt.Println(res.StatusCode, string(body))\n}<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"15-5\"><div class=\"sms-code\" data-lang=\"java\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>import java.net.URI;\nimport java.net.http.*;\n\nHttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n  .uri(URI.create(&quot;{{BASE}}\/v1\/messages\/b1f6b8b2-6e7b-4a9a-9a3e-2f7e6a3c9b10&quot;))\n  .header(&quot;Accept&quot;, &quot;application\/json&quot;)\n  .header(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;)\n  .method(&quot;GET&quot;, HttpRequest.BodyPublishers.noBody())\n  .build();\nHttpResponse&lt;String&gt; response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.statusCode() + &quot; &quot; + response.body());<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"15-6\"><div class=\"sms-code\" data-lang=\"csharp\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Get, &quot;{{BASE}}\/v1\/messages\/b1f6b8b2-6e7b-4a9a-9a3e-2f7e6a3c9b10&quot;);\nrequest.Headers.Add(&quot;Accept&quot;, &quot;application\/json&quot;);\nrequest.Headers.Add(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;);\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"15-7\"><div class=\"sms-code\" data-lang=\"ruby\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>require &quot;uri&quot;\nrequire &quot;json&quot;\nrequire &quot;net\/http&quot;\n\nurl = URI(&quot;{{BASE}}\/v1\/messages\/b1f6b8b2-6e7b-4a9a-9a3e-2f7e6a3c9b10&quot;)\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[&quot;Accept&quot;] = &quot;application\/json&quot;\nrequest[&quot;X-API-Key&quot;] = &quot;&lt;X-API-Key&gt;&quot;\n\nresponse = http.request(request)\nputs response.code, response.read_body<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"15-8\"><div class=\"sms-code\" data-lang=\"powershell\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>$headers = New-Object &quot;System.Collections.Generic.Dictionary[[String],[String]]&quot;\n$headers.Add(&quot;Accept&quot;, &quot;application\/json&quot;)\n$headers.Add(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;)\n\n$response = Invoke-RestMethod &quot;{{BASE}}\/v1\/messages\/b1f6b8b2-6e7b-4a9a-9a3e-2f7e6a3c9b10&quot; -Method &quot;GET&quot; -Headers $headers\n$response | ConvertTo-Json -Depth 10<\/code><\/pre><\/div><\/div><\/div><div class=\"sms-side-t\">Response<\/div><div class=\"sms-code\" data-lang=\"json\"><div class=\"sms-code-t\">200<\/div><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;msgId&quot;: &quot;b1f6b8b2-6e7b-4a9a-9a3e-2f7e6a3c9b10&quot;,\n  &quot;sender&quot;: &quot;SMSes_Agent&quot;,\n  &quot;receiver&quot;: &quot;34600123456&quot;,\n  &quot;channel&quot;: &quot;rbm&quot;,\n  &quot;validityPeriod&quot;: 0,\n  &quot;body&quot;: {\n    &quot;textMessage&quot;: {\n      &quot;content&quot;: &quot;Your order #4521 has shipped and arrives tomorrow.&quot;\n    }\n  },\n  &quot;custom&quot;: {\n    &quot;orderId&quot;: &quot;4521&quot;\n  }\n}<\/code><\/pre><\/div><\/aside><\/div><nav class=\"sms-pager\"><a class=\"sms-pg sms-pg--prev\" href=\"#message-retrievers\"><span>Previous<\/span><b>\u00ab Inbound and Outbound message retrievers<\/b><\/a><a class=\"sms-pg sms-pg--next\" href=\"#notifications\"><span>Next<\/span><b>Notifications \u00bb<\/b><\/a><\/nav><\/article><article class=\"sms-view\" id=\"sms-v-notifications\" data-view=\"notifications\" data-title=\"Notifications\" hidden><nav class=\"sms-bc\"><a href=\"#omnichannel-overview\" class=\"sms-bc-home\" aria-label=\"Home\"><svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\"><path fill=\"currentColor\" d=\"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6a1 1 0 0 0-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z\"\/><\/svg><\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#omnichannel-overview\">Omnichannel<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#unifier-api\">Unifier API<\/a><span class=\"sms-bc-sep\">\u203a<\/span><span class=\"sms-bc-cur\">Notifications<\/span><\/nav>\n<div class=\"sms-md\">\n<h1>Notifications<\/h1>\n<p>Use <code>GET \/v1\/updates<\/code> to get the latest notifications for the messages sent from your account. You can filter by message ID (<code>msgid<\/code>) or by event type (<code>event<\/code>), and order the results ascending or descending by date.<\/p>\n<p><b>Event types:<\/b> <code>message<\/code>, <code>isTyping<\/code>, <code>messageStatus<\/code>, <code>response<\/code>, <code>subscribed<\/code>, <code>unsubscribed<\/code>, <code>fallback<\/code>.<\/p>\n<p><b>Message statuses:<\/b> <code>pending<\/code>, <code>dispatched<\/code>, <code>sent<\/code>, <code>delivered<\/code>, <code>displayed<\/code>, <code>undelivered<\/code>, <code>rejected<\/code>, <code>redispatched<\/code>, <code>buffered<\/code>, <code>deleted<\/code>, <code>failed<\/code>.<\/p>\n<div class=\"sms-table\"><table><thead><tr><th>event<\/th><th>Description<\/th><\/tr><\/thead><tbody>\n<tr><td><code>message<\/code><\/td><td>Inbound message from an end user.<\/td><\/tr><tr><td><code>isTyping<\/code><\/td><td>The end user is typing.<\/td><\/tr><tr><td><code>messageStatus<\/code><\/td><td>Status update \/ DLR of an outbound message.<\/td><\/tr><tr><td><code>response<\/code><\/td><td>The end user replied to a suggestion (postback).<\/td><\/tr><tr><td><code>subscribed<\/code><\/td><td>The end user subscribed to the sender.<\/td><\/tr><tr><td><code>unsubscribed<\/code><\/td><td>The end user unsubscribed from the sender.<\/td><\/tr><tr><td><code>fallback<\/code><\/td><td>A fallback was triggered; see <code>fallbackMsgId<\/code>.<\/td><\/tr>\n<\/tbody><\/table><\/div>\n<p>Instead of polling, you can register a webhook URL; the platform pushes the same payloads to it as events happen. Each webhook call includes the <code>X-Msg-Api-Signature<\/code> header \u2014 a Base64-encoded SHA-512 hash of the payload and your verify token \u2014 so you can confirm the notification came from the platform.<\/p>\n<div class=\"sms-cards\">\n<a class=\"sms-card\" href=\"#get-updates\"><div class=\"sms-card-t\">\ud83d\udcc4\ufe0f Get list of latest notifications for every message send from the account<\/div><div class=\"sms-card-d\">Get list of latest notifications for every message send from the account<\/div><\/a>\n<a class=\"sms-card\" href=\"#receive-notification-webhook\"><div class=\"sms-card-t\">\ud83d\udcc4\ufe0f Receive message update notifications (customer webhook)<\/div><div class=\"sms-card-d\">Webhook endpoint that receives notifications forwarded by our platform.<\/div><\/a>\n<\/div>\n<\/div><nav class=\"sms-pager\"><a class=\"sms-pg sms-pg--prev\" href=\"#get-message\"><span>Previous<\/span><b>\u00ab Get the message based on the message&#x27;s ID<\/b><\/a><a class=\"sms-pg sms-pg--next\" href=\"#get-updates\"><span>Next<\/span><b>Get list of latest notifications for every message send from the account \u00bb<\/b><\/a><\/nav><\/article><article class=\"sms-view\" id=\"sms-v-get-updates\" data-view=\"get-updates\" data-title=\"Get list of latest notifications for every message send from the account\" hidden><nav class=\"sms-bc\"><a href=\"#omnichannel-overview\" class=\"sms-bc-home\" aria-label=\"Home\"><svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\"><path fill=\"currentColor\" d=\"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6a1 1 0 0 0-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z\"\/><\/svg><\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#omnichannel-overview\">Omnichannel<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#unifier-api\">Unifier API<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#notifications\">Notifications<\/a><span class=\"sms-bc-sep\">\u203a<\/span><span class=\"sms-bc-cur\">Get list of latest notifications for every message send from the account<\/span><\/nav><div class=\"sms-api\"><div class=\"sms-api-main\"><h1>Get list of latest notifications for every message send from the account<\/h1><div class=\"sms-ep\"><span class=\"sms-m sms-m--get\">GET<\/span><span class=\"sms-ep-p\">\/v1\/updates<\/span><\/div><hr><div class=\"sms-md\"><p>Get list of latest notifications for every message send from the account.<\/p><\/div><h2>Request<\/h2><details class=\"sms-schema\" open><summary><b>Query Parameters<\/b><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">order<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>asc<\/code>], [<code>desc<\/code>]<\/div><div class=sms-pd>Order the list based on date.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">msgid<\/span><span class=\"sms-pt\">string<\/span><div class=sms-pd>Return all notifications for a specific message ID (query name is lowercase <code>msgid<\/code>).<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">event<\/span><span class=\"sms-pt\">EventType<\/span><div class=\"sms-enum\">Possible values: [<code>message<\/code>], [<code>isTyping<\/code>], [<code>messageStatus<\/code>], [<code>response<\/code>], [<code>subscribed<\/code>], [<code>unsubscribed<\/code>], [<code>fallback<\/code>]<\/div><div class=sms-pd>Return all the notifications for a specific event. Update event type (values emitted by the platform for notifications).<\/div><\/div><\/div><\/details><h2>Responses<\/h2><div class=\"sms-tabs sms-tabs--resp\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab sms-rc sms-rc--2 is-on\" data-tab=\"20-0\">200<\/button><button type=\"button\" class=\"sms-tab sms-rc sms-rc--4\" data-tab=\"20-1\">401<\/button><button type=\"button\" class=\"sms-tab sms-rc sms-rc--4\" data-tab=\"20-2\">404<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"20-0\"><p class=\"sms-rdesc\">The response contains the list of messages received from the receiver, including events.<\/p><div class=\"sms-mime\">application\/json<\/div><div class=\"sms-tabs sms-tabs--box\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"18-0\">Example<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"18-1\">Schema<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"18-0\"><div class=\"sms-code\" data-lang=\"json\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;data&quot;: [\n    {\n      &quot;msgId&quot;: &quot;string&quot;,\n      &quot;receiver&quot;: &quot;string&quot;,\n      &quot;sender&quot;: &quot;string&quot;,\n      &quot;channel&quot;: &quot;rbm&quot;,\n      &quot;messageBody&quot;: {\n        &quot;textMessage&quot;: {\n          &quot;content&quot;: &quot;string&quot;\n        }\n      },\n      &quot;messageStatus&quot;: &quot;pending&quot;,\n      &quot;error&quot;: {\n        &quot;code&quot;: &quot;string&quot;,\n        &quot;message&quot;: &quot;string&quot;,\n        &quot;description&quot;: &quot;string&quot;\n      },\n      &quot;fallbackMsgId&quot;: &quot;string&quot;,\n      &quot;smsParts&quot;: {\n        &quot;total&quot;: 0,\n        &quot;receiveddlrs&quot;: 0\n      },\n      &quot;contact&quot;: {\n        &quot;firstName&quot;: &quot;string&quot;,\n        &quot;lastName&quot;: &quot;string&quot;,\n        &quot;name&quot;: &quot;string&quot;,\n        &quot;avatarUrl&quot;: &quot;string&quot;,\n        &quot;country&quot;: &quot;string&quot;,\n        &quot;city&quot;: &quot;string&quot;,\n        &quot;address&quot;: &quot;string&quot;,\n        &quot;language&quot;: &quot;string&quot;,\n        &quot;phone&quot;: &quot;string&quot;,\n        &quot;email&quot;: &quot;string&quot;,\n        &quot;birthday&quot;: &quot;string&quot;\n      },\n      &quot;createdAt&quot;: &quot;2026-11-09T14:02:11Z&quot;,\n      &quot;event&quot;: &quot;message&quot;\n    }\n  ]\n}<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"18-1\"><details class=\"sms-schema\" open><summary><b>Schema<\/b><\/summary><div class=\"sms-nest\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">data<\/span><span class=\"sms-pt\">Notification[]<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">msgId<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">receiver<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">sender<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">channel<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-enum\">Possible values: [<code>rbm<\/code>], [<code>sms<\/code>], [<code>telegram<\/code>], [<code>whatsApp<\/code>], [<code>email<\/code>], [<code>instagram<\/code>], [<code>facebook<\/code>]<\/div><div class=\"sms-pd\">Channel identifier (<code>rbm<\/code> is RCS Business Messaging).<\/div><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">messageBody<\/span><span class=\"sms-pt\">oneOf<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-oneof\"><div class=\"sms-oneof-h\">oneOf<\/div><div class=\"sms-tabs sms-tabs--pill\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"16-0\">FileMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"16-1\">TextMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"16-2\">AudioMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"16-3\">PictureMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"16-4\">VideoMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"16-5\">LocationMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"16-6\">ContactMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"16-7\">TemplateMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"16-8\">EmailMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"16-9\">CardMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"16-10\">SuggestionsMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"16-11\">CarouselMessage<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"16-0\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">fileMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">fileType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">playingLength<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailMimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailSize<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"16-1\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">textMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">content<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"16-2\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">audioMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">playingLength<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"16-3\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">pictureMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailMimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailSize<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"16-4\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">videoMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">playingLength<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailMimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailSize<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"16-5\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">locationMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"16-6\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">contactMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">email<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">address<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">phone<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">firstName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">lastName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">country<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">language<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"16-7\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">WhatsApp template name.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">languageCode<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">components<\/span><span class=\"sms-pt\">TemplateComponent[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">type<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">subType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">index<\/span><span class=\"sms-pt\">integer<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">parameters<\/span><span class=\"sms-pt\">ComponentParameter[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-oneof\"><div class=\"sms-oneof-h\">oneOf<\/div><div class=\"sms-tabs sms-tabs--pill\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"17-0\">ComponentParameterCurrency<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"17-1\">ComponentParameterDateTime<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"17-2\">ComponentParameterDocument<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"17-3\">ComponentParameterImage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"17-4\">ComponentParameterVideo<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"17-0\"><div class=\"sms-prop\"><span class=\"sms-pn\">code<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">ISO 4217 currency code (e.g. USD, EUR, GBP, TRY, INR). Tells WhatsApp which currency format to use.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">amount1000<\/span><span class=\"sms-pt\">integer<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">Amount multiplied by 1000.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">fallbackValue<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-pd\">Text displayed if the device cannot localise the currency.<\/div><\/div><\/div><div class=\"sms-pane\" data-pane=\"17-1\"><div class=\"sms-prop\"><span class=\"sms-pn\">fallbackValue<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><div class=\"sms-pane\" data-pane=\"17-2\"><div class=\"sms-prop\"><span class=\"sms-pn\">link<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><div class=\"sms-pane\" data-pane=\"17-3\"><div class=\"sms-prop\"><span class=\"sms-pn\">link<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><div class=\"sms-pane\" data-pane=\"17-4\"><div class=\"sms-prop\"><span class=\"sms-pn\">link<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/div><\/div><div class=\"sms-arr\">]<\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"16-8\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">emailMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">subject<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">htmlContent<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">textContent<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"16-9\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">layout<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Rich card layout<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardOrientation<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>HORIZONTAL<\/code>], [<code>VERTICAL<\/code>]<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">imageAlignment<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>LEFT<\/code>], [<code>RIGHT<\/code>]<\/div><div class=\"sms-pd\">Required if cardOrientation is HORIZONTAL.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardWidth<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SMALL_WIDTH<\/code>], [<code>MEDIUM_WIDTH<\/code>]<\/div><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">content<\/span><span class=\"sms-pt\">object<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Content of a card message<\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">media<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Media elements<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">height<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SHORT_HEIGHT<\/code>], [<code>MEDIUM_HEIGHT<\/code>], [<code>TALL_HEIGHT<\/code>]<\/div><\/div><\/div><\/details><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">suggestions<\/span><span class=\"sms-pt\">Suggestion[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">replyWith<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">openUrl<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">dialNumber<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">composeMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">showMapLocation<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">label<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">createCalendarEvent<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">start<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">end<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"16-10\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">suggestions<\/span><span class=\"sms-pt\">Suggestion[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">replyWith<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">openUrl<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">dialNumber<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">composeMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">showMapLocation<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">label<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">createCalendarEvent<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">start<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">end<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"16-11\"><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">layout<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Rich card layout<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardOrientation<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>HORIZONTAL<\/code>], [<code>VERTICAL<\/code>]<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">imageAlignment<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>LEFT<\/code>], [<code>RIGHT<\/code>]<\/div><div class=\"sms-pd\">Required if cardOrientation is HORIZONTAL.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardWidth<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SMALL_WIDTH<\/code>], [<code>MEDIUM_WIDTH<\/code>]<\/div><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">content<\/span><span class=\"sms-pt\">MessageContentCard[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">media<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Media elements<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">height<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SHORT_HEIGHT<\/code>], [<code>MEDIUM_HEIGHT<\/code>], [<code>TALL_HEIGHT<\/code>]<\/div><\/div><\/div><\/details><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">suggestions<\/span><span class=\"sms-pt\">Suggestion[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">replyWith<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">openUrl<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">dialNumber<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">composeMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">showMapLocation<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">label<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">createCalendarEvent<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">start<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">end<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/div><\/div><\/div><\/details><div class=\"sms-prop\"><span class=\"sms-pn\">messageStatus<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>pending<\/code>], [<code>dispatched<\/code>], [<code>sent<\/code>], [<code>rejected<\/code>], [<code>failed<\/code>], [<code>redispatched<\/code>], [<code>delivered<\/code>], [<code>displayed<\/code>], [<code>undelivered<\/code>], [<code>buffered<\/code>], [<code>deleted<\/code>]<\/div><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">error<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Present when a message failed or triggered a fallback.<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">code<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">message<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><div class=\"sms-prop\"><span class=\"sms-pn\">fallbackMsgId<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-pd\">On fallback events, the ID of the next message that will be sent.<\/div><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">smsParts<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">SMS part \/ DLR counters (<code>receiveddlrs<\/code> is the JSON field name in API responses).<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">total<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">receiveddlrs<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">contact<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">firstName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">lastName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">avatarUrl<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">country<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">city<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">address<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">language<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">phone<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">email<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">birthday<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><div class=\"sms-prop\"><span class=\"sms-pn\">createdAt<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">event<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-enum\">Possible values: [<code>message<\/code>], [<code>isTyping<\/code>], [<code>messageStatus<\/code>], [<code>response<\/code>], [<code>subscribed<\/code>], [<code>unsubscribed<\/code>], [<code>fallback<\/code>]<\/div><div class=\"sms-pd\">Update event type.<\/div><\/div><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/details><\/div><\/div><\/div><div class=\"sms-pane\" data-pane=\"20-1\"><p class=\"sms-rdesc\">Unauthorized<\/p><\/div><div class=\"sms-pane\" data-pane=\"20-2\"><p class=\"sms-rdesc\">Not Found<\/p><div class=\"sms-mime\">application\/json<\/div><div class=\"sms-tabs sms-tabs--box\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"19-0\">Example<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"19-1\">Schema<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"19-0\"><div class=\"sms-code\" data-lang=\"json\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;error&quot;: {\n    &quot;code&quot;: &quot;string&quot;,\n    &quot;message&quot;: &quot;string&quot;,\n    &quot;description&quot;: &quot;string&quot;,\n    &quot;items&quot;: [\n      {\n        &quot;name&quot;: &quot;string&quot;,\n        &quot;message&quot;: &quot;string&quot;,\n        &quot;description&quot;: &quot;string&quot;\n      }\n    ]\n  }\n}<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"19-1\"><details class=\"sms-schema\" open><summary><b>Schema<\/b><\/summary><div class=\"sms-nest\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">error<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">code<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">message<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">items<\/span><span class=\"sms-pt\">object[]<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">message<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/details><\/div><\/details><\/div><\/div><\/div><\/div><\/div><aside class=\"sms-api-side\"><div class=\"sms-tabs sms-tabs--lang\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"21-0\">cURL<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"21-1\">Python<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"21-2\">Node.js<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"21-3\">PHP<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"21-4\">Go<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"21-5\">Java<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"21-6\">C#<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"21-7\">Ruby<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"21-8\">PowerShell<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"21-0\"><div class=\"sms-code\" data-lang=\"bash\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>curl -L -X GET &quot;{{BASE}}\/v1\/updates?order=desc&quot; \\\n  -H &quot;Accept: application\/json&quot; \\\n  -H &quot;X-API-Key: &lt;X-API-Key&gt;&quot;<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"21-1\"><div class=\"sms-code\" data-lang=\"python\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>import requests\n\nurl = &quot;{{BASE}}\/v1\/updates?order=desc&quot;\nheaders = {\n  &quot;Accept&quot;: &quot;application\/json&quot;,\n  &quot;X-API-Key&quot;: &quot;&lt;X-API-Key&gt;&quot;,\n}\n\nresponse = requests.get(url, headers=headers)\nprint(response.status_code)\nprint(response.text)<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"21-2\"><div class=\"sms-code\" data-lang=\"javascript\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>const response = await fetch(&quot;{{BASE}}\/v1\/updates?order=desc&quot;, {\n  method: &quot;GET&quot;,\n  headers: {\n    &quot;Accept&quot;: &quot;application\/json&quot;,\n    &quot;X-API-Key&quot;: &quot;&lt;X-API-Key&gt;&quot;,\n  },\n});\nconsole.log(response.status, await response.text());<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"21-3\"><div class=\"sms-code\" data-lang=\"php\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>&lt;?php\n$ch = curl_init(&#x27;{{BASE}}\/v1\/updates?order=desc&#x27;);\ncurl_setopt_array($ch, [\n  CURLOPT_CUSTOMREQUEST  =&gt; &#x27;GET&#x27;,\n  CURLOPT_RETURNTRANSFER =&gt; true,\n  CURLOPT_HTTPHEADER     =&gt; [\n    &#x27;Accept: application\/json&#x27;,\n    &#x27;X-API-Key: &lt;X-API-Key&gt;&#x27;,\n  ],\n]);\n$response = curl_exec($ch);\necho curl_getinfo($ch, CURLINFO_HTTP_CODE) . PHP_EOL . $response;<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"21-4\"><div class=\"sms-code\" data-lang=\"go\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>package main\n\nimport (\n  &quot;fmt&quot;\n  &quot;io&quot;\n  &quot;net\/http&quot;\n)\n\nfunc main() {\n  req, _ := http.NewRequest(&quot;GET&quot;, &quot;{{BASE}}\/v1\/updates?order=desc&quot;, nil)\n  req.Header.Add(&quot;Accept&quot;, &quot;application\/json&quot;)\n  req.Header.Add(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;)\n\n  res, err := http.DefaultClient.Do(req)\n  if err != nil {\n    panic(err)\n  }\n  defer res.Body.Close()\n  body, _ := io.ReadAll(res.Body)\n  fmt.Println(res.StatusCode, string(body))\n}<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"21-5\"><div class=\"sms-code\" data-lang=\"java\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>import java.net.URI;\nimport java.net.http.*;\n\nHttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n  .uri(URI.create(&quot;{{BASE}}\/v1\/updates?order=desc&quot;))\n  .header(&quot;Accept&quot;, &quot;application\/json&quot;)\n  .header(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;)\n  .method(&quot;GET&quot;, HttpRequest.BodyPublishers.noBody())\n  .build();\nHttpResponse&lt;String&gt; response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.statusCode() + &quot; &quot; + response.body());<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"21-6\"><div class=\"sms-code\" data-lang=\"csharp\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Get, &quot;{{BASE}}\/v1\/updates?order=desc&quot;);\nrequest.Headers.Add(&quot;Accept&quot;, &quot;application\/json&quot;);\nrequest.Headers.Add(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;);\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"21-7\"><div class=\"sms-code\" data-lang=\"ruby\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>require &quot;uri&quot;\nrequire &quot;json&quot;\nrequire &quot;net\/http&quot;\n\nurl = URI(&quot;{{BASE}}\/v1\/updates?order=desc&quot;)\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[&quot;Accept&quot;] = &quot;application\/json&quot;\nrequest[&quot;X-API-Key&quot;] = &quot;&lt;X-API-Key&gt;&quot;\n\nresponse = http.request(request)\nputs response.code, response.read_body<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"21-8\"><div class=\"sms-code\" data-lang=\"powershell\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>$headers = New-Object &quot;System.Collections.Generic.Dictionary[[String],[String]]&quot;\n$headers.Add(&quot;Accept&quot;, &quot;application\/json&quot;)\n$headers.Add(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;)\n\n$response = Invoke-RestMethod &quot;{{BASE}}\/v1\/updates?order=desc&quot; -Method &quot;GET&quot; -Headers $headers\n$response | ConvertTo-Json -Depth 10<\/code><\/pre><\/div><\/div><\/div><div class=\"sms-side-t\">Response<\/div><div class=\"sms-code\" data-lang=\"json\"><div class=\"sms-code-t\">200<\/div><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;data&quot;: [\n    {\n      &quot;msgId&quot;: &quot;b1f6b8b2-6e7b-4a9a-9a3e-2f7e6a3c9b10&quot;,\n      &quot;receiver&quot;: &quot;34600123456&quot;,\n      &quot;sender&quot;: &quot;SMSes_Agent&quot;,\n      &quot;channel&quot;: &quot;rbm&quot;,\n      &quot;messageStatus&quot;: &quot;delivered&quot;,\n      &quot;createdAt&quot;: &quot;2026-11-09T14:02:11Z&quot;,\n      &quot;event&quot;: &quot;messageStatus&quot;\n    }\n  ]\n}<\/code><\/pre><\/div><\/aside><\/div><nav class=\"sms-pager\"><a class=\"sms-pg sms-pg--prev\" href=\"#notifications\"><span>Previous<\/span><b>\u00ab Notifications<\/b><\/a><a class=\"sms-pg sms-pg--next\" href=\"#receive-notification-webhook\"><span>Next<\/span><b>Receive message update notifications (customer webhook) \u00bb<\/b><\/a><\/nav><\/article><article class=\"sms-view\" id=\"sms-v-receive-notification-webhook\" data-view=\"receive-notification-webhook\" data-title=\"Receive message update notifications (customer webhook)\" hidden><nav class=\"sms-bc\"><a href=\"#omnichannel-overview\" class=\"sms-bc-home\" aria-label=\"Home\"><svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\"><path fill=\"currentColor\" d=\"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6a1 1 0 0 0-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z\"\/><\/svg><\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#omnichannel-overview\">Omnichannel<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#unifier-api\">Unifier API<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#notifications\">Notifications<\/a><span class=\"sms-bc-sep\">\u203a<\/span><span class=\"sms-bc-cur\">Receive message update notifications (customer webhook)<\/span><\/nav><div class=\"sms-api\"><div class=\"sms-api-main\"><h1>Receive message update notifications (customer webhook)<\/h1><div class=\"sms-ep\"><span class=\"sms-m sms-m--event\">EVENT<\/span><span class=\"sms-ep-p\">\/webhook\/notifications<\/span><\/div><hr><div class=\"sms-md\"><p>Webhook endpoint that receives notifications forwarded by our platform. This endpoint must be configured by the customer on their platform and is triggered when an inbound message is received, or on a DLR or another event. Each request contains <code>X-Msg-Api-Signature<\/code> (<code>base64(SHA512(body + verifyToken))<\/code>).<\/p><\/div><h2>Request<\/h2><details class=\"sms-schema\" open><summary><b>Header Parameters<\/b><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">X-Msg-Api-Signature<\/span><span class=\"sms-pt\">string<\/span><span class=sms-req>required<\/span><div class=sms-pd>The signature of each request: <code>base64encode(sha512(payload + verifyToken))<\/code>.<\/div><\/div><\/div><\/details><div class=\"sms-mime\">application\/json<\/div><div class=\"sms-tabs sms-tabs--box\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"24-0\">Example (auto)<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"24-1\">Body<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"24-0\"><div class=\"sms-code\" data-lang=\"json\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;msgId&quot;: &quot;string&quot;,\n  &quot;receiver&quot;: &quot;string&quot;,\n  &quot;sender&quot;: &quot;string&quot;,\n  &quot;channel&quot;: &quot;rbm&quot;,\n  &quot;messageBody&quot;: {\n    &quot;textMessage&quot;: {\n      &quot;content&quot;: &quot;string&quot;\n    }\n  },\n  &quot;messageStatus&quot;: &quot;pending&quot;,\n  &quot;error&quot;: {\n    &quot;code&quot;: &quot;string&quot;,\n    &quot;message&quot;: &quot;string&quot;,\n    &quot;description&quot;: &quot;string&quot;\n  },\n  &quot;fallbackMsgId&quot;: &quot;string&quot;,\n  &quot;smsParts&quot;: {\n    &quot;total&quot;: 0,\n    &quot;receiveddlrs&quot;: 0\n  },\n  &quot;contact&quot;: {\n    &quot;firstName&quot;: &quot;string&quot;,\n    &quot;lastName&quot;: &quot;string&quot;,\n    &quot;name&quot;: &quot;string&quot;,\n    &quot;avatarUrl&quot;: &quot;string&quot;,\n    &quot;country&quot;: &quot;string&quot;,\n    &quot;city&quot;: &quot;string&quot;,\n    &quot;address&quot;: &quot;string&quot;,\n    &quot;language&quot;: &quot;string&quot;,\n    &quot;phone&quot;: &quot;string&quot;,\n    &quot;email&quot;: &quot;string&quot;,\n    &quot;birthday&quot;: &quot;string&quot;\n  },\n  &quot;createdAt&quot;: &quot;2026-11-09T14:02:11Z&quot;,\n  &quot;event&quot;: &quot;message&quot;\n}<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"24-1\"><details class=\"sms-schema\" open><summary><b>Body<\/b><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">msgId<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">receiver<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">sender<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">channel<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-enum\">Possible values: [<code>rbm<\/code>], [<code>sms<\/code>], [<code>telegram<\/code>], [<code>whatsApp<\/code>], [<code>email<\/code>], [<code>instagram<\/code>], [<code>facebook<\/code>]<\/div><div class=\"sms-pd\">Channel identifier (<code>rbm<\/code> is RCS Business Messaging).<\/div><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">messageBody<\/span><span class=\"sms-pt\">oneOf<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-oneof\"><div class=\"sms-oneof-h\">oneOf<\/div><div class=\"sms-tabs sms-tabs--pill\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"22-0\">FileMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"22-1\">TextMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"22-2\">AudioMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"22-3\">PictureMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"22-4\">VideoMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"22-5\">LocationMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"22-6\">ContactMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"22-7\">TemplateMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"22-8\">EmailMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"22-9\">CardMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"22-10\">SuggestionsMessage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"22-11\">CarouselMessage<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"22-0\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">fileMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">fileType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">playingLength<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailMimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailSize<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"22-1\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">textMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">content<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"22-2\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">audioMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">playingLength<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"22-3\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">pictureMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailMimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailSize<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"22-4\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">videoMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">mimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">size<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">playingLength<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailMimeType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailSize<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"22-5\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">locationMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"22-6\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">contactMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">email<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">address<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">phone<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">firstName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">lastName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">country<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">language<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"22-7\"><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">WhatsApp template name.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">languageCode<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">components<\/span><span class=\"sms-pt\">TemplateComponent[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">type<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">subType<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">index<\/span><span class=\"sms-pt\">integer<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">parameters<\/span><span class=\"sms-pt\">ComponentParameter[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-oneof\"><div class=\"sms-oneof-h\">oneOf<\/div><div class=\"sms-tabs sms-tabs--pill\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"23-0\">ComponentParameterCurrency<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"23-1\">ComponentParameterDateTime<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"23-2\">ComponentParameterDocument<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"23-3\">ComponentParameterImage<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"23-4\">ComponentParameterVideo<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"23-0\"><div class=\"sms-prop\"><span class=\"sms-pn\">code<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">ISO 4217 currency code (e.g. USD, EUR, GBP, TRY, INR). Tells WhatsApp which currency format to use.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">amount1000<\/span><span class=\"sms-pt\">integer<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-pd\">Amount multiplied by 1000.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">fallbackValue<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-pd\">Text displayed if the device cannot localise the currency.<\/div><\/div><\/div><div class=\"sms-pane\" data-pane=\"23-1\"><div class=\"sms-prop\"><span class=\"sms-pn\">fallbackValue<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><div class=\"sms-pane\" data-pane=\"23-2\"><div class=\"sms-prop\"><span class=\"sms-pn\">link<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><div class=\"sms-pane\" data-pane=\"23-3\"><div class=\"sms-prop\"><span class=\"sms-pn\">link<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><div class=\"sms-pane\" data-pane=\"23-4\"><div class=\"sms-prop\"><span class=\"sms-pn\">link<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/div><\/div><div class=\"sms-arr\">]<\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"22-8\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">emailMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">subject<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">htmlContent<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">textContent<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"22-9\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">layout<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Rich card layout<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardOrientation<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>HORIZONTAL<\/code>], [<code>VERTICAL<\/code>]<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">imageAlignment<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>LEFT<\/code>], [<code>RIGHT<\/code>]<\/div><div class=\"sms-pd\">Required if cardOrientation is HORIZONTAL.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardWidth<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SMALL_WIDTH<\/code>], [<code>MEDIUM_WIDTH<\/code>]<\/div><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">content<\/span><span class=\"sms-pt\">object<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Content of a card message<\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">media<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Media elements<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">height<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SHORT_HEIGHT<\/code>], [<code>MEDIUM_HEIGHT<\/code>], [<code>TALL_HEIGHT<\/code>]<\/div><\/div><\/div><\/details><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">suggestions<\/span><span class=\"sms-pt\">Suggestion[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">replyWith<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">openUrl<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">dialNumber<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">composeMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">showMapLocation<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">label<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">createCalendarEvent<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">start<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">end<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"22-10\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">suggestions<\/span><span class=\"sms-pt\">Suggestion[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">replyWith<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">openUrl<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">dialNumber<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">composeMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">showMapLocation<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">label<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">createCalendarEvent<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">start<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">end<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><div class=\"sms-pane\" data-pane=\"22-11\"><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">layout<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Rich card layout<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardOrientation<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>HORIZONTAL<\/code>], [<code>VERTICAL<\/code>]<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">imageAlignment<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>LEFT<\/code>], [<code>RIGHT<\/code>]<\/div><div class=\"sms-pd\">Required if cardOrientation is HORIZONTAL.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">cardWidth<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SMALL_WIDTH<\/code>], [<code>MEDIUM_WIDTH<\/code>]<\/div><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">content<\/span><span class=\"sms-pt\">MessageContentCard[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">media<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Media elements<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">thumbnailUrl<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">height<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>SHORT_HEIGHT<\/code>], [<code>MEDIUM_HEIGHT<\/code>], [<code>TALL_HEIGHT<\/code>]<\/div><\/div><\/div><\/details><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">suggestions<\/span><span class=\"sms-pt\">Suggestion[]<\/span><span class=\"sms-req\">required<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">replyWith<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">postback<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">openUrl<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">dialNumber<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">composeMessage<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">number<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">text<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">showMapLocation<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">latitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">longitude<\/span><span class=\"sms-pt\">number&lt;double&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">label<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string&lt;uri&gt;<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">createCalendarEvent<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">title<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">start<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">end<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/div><\/div><\/div><\/details><div class=\"sms-prop\"><span class=\"sms-pn\">messageStatus<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>pending<\/code>], [<code>dispatched<\/code>], [<code>sent<\/code>], [<code>rejected<\/code>], [<code>failed<\/code>], [<code>redispatched<\/code>], [<code>delivered<\/code>], [<code>displayed<\/code>], [<code>undelivered<\/code>], [<code>buffered<\/code>], [<code>deleted<\/code>]<\/div><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">error<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">Present when a message failed or triggered a fallback.<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">code<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">message<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><div class=\"sms-prop\"><span class=\"sms-pn\">fallbackMsgId<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-pd\">On fallback events, the ID of the next message that will be sent.<\/div><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">smsParts<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\">SMS part \/ DLR counters (<code>receiveddlrs<\/code> is the JSON field name in API responses).<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">total<\/span><span class=\"sms-pt\">integer<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">receiveddlrs<\/span><span class=\"sms-pt\">integer<\/span><\/div><\/div><\/details><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">contact<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">firstName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">lastName<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">avatarUrl<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">country<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">city<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">address<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">language<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">phone<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">email<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">birthday<\/span><span class=\"sms-pt\">string<\/span><\/div><\/div><\/details><div class=\"sms-prop\"><span class=\"sms-pn\">createdAt<\/span><span class=\"sms-pt\">string&lt;date-time&gt;<\/span><span class=\"sms-req\">required<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">event<\/span><span class=\"sms-pt\">string<\/span><span class=\"sms-req\">required<\/span><div class=\"sms-enum\">Possible values: [<code>message<\/code>], [<code>isTyping<\/code>], [<code>messageStatus<\/code>], [<code>response<\/code>], [<code>subscribed<\/code>], [<code>unsubscribed<\/code>], [<code>fallback<\/code>]<\/div><div class=\"sms-pd\">Update event type.<\/div><\/div><\/div><\/details><\/div><\/div><h2>Responses<\/h2><div class=\"sms-tabs sms-tabs--resp\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab sms-rc sms-rc--2 is-on\" data-tab=\"25-0\">200<\/button><button type=\"button\" class=\"sms-tab sms-rc sms-rc--5\" data-tab=\"25-1\">500<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"25-0\"><p class=\"sms-rdesc\">Successful operation<\/p><\/div><div class=\"sms-pane\" data-pane=\"25-1\"><p class=\"sms-rdesc\">Internal problems, retry again<\/p><\/div><\/div><\/div><aside class=\"sms-api-side\"><div class=\"sms-side-t\">Signature verification<\/div><div class=\"sms-tabs sms-tabs--lang\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"26-0\">Node.js<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"26-1\">Python<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"26-2\">PHP<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"26-0\"><div class=\"sms-code\" data-lang=\"javascript\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>import express from &quot;express&quot;;\nimport crypto from &quot;node:crypto&quot;;\n\nconst app = express();\napp.post(&quot;\/webhook\/notifications&quot;, express.raw({ type: &quot;*\/*&quot; }), (req, res) =&gt; {\n  const raw = req.body.toString(&quot;utf8&quot;);\n  const expected = crypto.createHash(&quot;sha512&quot;)\n    .update(raw + process.env.VERIFY_TOKEN).digest(&quot;base64&quot;);\n  if (req.get(&quot;X-Msg-Api-Signature&quot;) !== expected) return res.sendStatus(401);\n  const notification = JSON.parse(raw);\n  \/\/ ... process notification\n  res.sendStatus(200);\n});\napp.listen(3000);<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"26-1\"><div class=\"sms-code\" data-lang=\"python\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>import base64, hashlib, hmac, os\nfrom flask import Flask, request, abort\n\napp = Flask(__name__)\n\n@app.post(&quot;\/webhook\/notifications&quot;)\ndef notifications():\n    raw = request.get_data()\n    expected = base64.b64encode(hashlib.sha512(raw + os.environ[&quot;VERIFY_TOKEN&quot;].encode()).digest()).decode()\n    if not hmac.compare_digest(request.headers.get(&quot;X-Msg-Api-Signature&quot;, &quot;&quot;), expected):\n        abort(401)\n    notification = request.get_json()\n    # ... process notification\n    return &quot;&quot;, 200<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"26-2\"><div class=\"sms-code\" data-lang=\"php\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>&lt;?php\n$raw = file_get_contents(&#x27;php:\/\/input&#x27;);\n$expected = base64_encode(hash(&#x27;sha512&#x27;, $raw . getenv(&#x27;VERIFY_TOKEN&#x27;), true));\nif (!hash_equals($expected, $_SERVER[&#x27;HTTP_X_MSG_API_SIGNATURE&#x27;] ?? &#x27;&#x27;)) {\n    http_response_code(401);\n    exit;\n}\n$notification = json_decode($raw, true);\n\/\/ ... process notification\nhttp_response_code(200);<\/code><\/pre><\/div><\/div><\/div><div class=\"sms-side-t\">Request body<\/div><div class=\"sms-code\" data-lang=\"json\"><div class=\"sms-code-t\">Notification<\/div><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;msgId&quot;: &quot;b1f6b8b2-6e7b-4a9a-9a3e-2f7e6a3c9b10&quot;,\n  &quot;receiver&quot;: &quot;34600123456&quot;,\n  &quot;sender&quot;: &quot;SMSes_Agent&quot;,\n  &quot;channel&quot;: &quot;rbm&quot;,\n  &quot;messageStatus&quot;: &quot;delivered&quot;,\n  &quot;createdAt&quot;: &quot;2026-11-09T14:02:11Z&quot;,\n  &quot;event&quot;: &quot;messageStatus&quot;\n}<\/code><\/pre><\/div><\/aside><\/div><nav class=\"sms-pager\"><a class=\"sms-pg sms-pg--prev\" href=\"#get-updates\"><span>Previous<\/span><b>\u00ab Get list of latest notifications for every message send from the account<\/b><\/a><a class=\"sms-pg sms-pg--next\" href=\"#senders\"><span>Next<\/span><b>Senders \u00bb<\/b><\/a><\/nav><\/article><article class=\"sms-view\" id=\"sms-v-senders\" data-view=\"senders\" data-title=\"Senders\" hidden><nav class=\"sms-bc\"><a href=\"#omnichannel-overview\" class=\"sms-bc-home\" aria-label=\"Home\"><svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\"><path fill=\"currentColor\" d=\"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6a1 1 0 0 0-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z\"\/><\/svg><\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#omnichannel-overview\">Omnichannel<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#unifier-api\">Unifier API<\/a><span class=\"sms-bc-sep\">\u203a<\/span><span class=\"sms-bc-cur\">Senders<\/span><\/nav>\n<div class=\"sms-md\">\n<h1>Senders<\/h1>\n<p>Use <code>GET \/v1\/senders<\/code> to get the list of senders available to your account. You can filter by one or more channel types with the optional <code>channelType<\/code> query parameter, as a comma-separated list such as <code>rbm,sms,whatsApp<\/code>. If omitted, the endpoint returns the senders configured for all channels.<\/p>\n<p>Depending on the channel, a sender is an RBM agent ID, an SMS short code or alphanumeric sender ID, a Telegram bot username or a WhatsApp phone number.<\/p>\n<div class=\"sms-cards\"><a class=\"sms-card\" href=\"#get-senders\"><div class=\"sms-card-t\">\ud83d\udcc4\ufe0f Get list of senders filtered by one or more channel types<\/div><div class=\"sms-card-d\">Get list of senders filtered by one or more channel types<\/div><\/a><\/div>\n<\/div><nav class=\"sms-pager\"><a class=\"sms-pg sms-pg--prev\" href=\"#receive-notification-webhook\"><span>Previous<\/span><b>\u00ab Receive message update notifications (customer webhook)<\/b><\/a><a class=\"sms-pg sms-pg--next\" href=\"#get-senders\"><span>Next<\/span><b>Get list of senders filtered by one or more channel types \u00bb<\/b><\/a><\/nav><\/article><article class=\"sms-view\" id=\"sms-v-get-senders\" data-view=\"get-senders\" data-title=\"Get list of senders filtered by one or more channel types\" hidden><nav class=\"sms-bc\"><a href=\"#omnichannel-overview\" class=\"sms-bc-home\" aria-label=\"Home\"><svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\"><path fill=\"currentColor\" d=\"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6a1 1 0 0 0-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z\"\/><\/svg><\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#omnichannel-overview\">Omnichannel<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#unifier-api\">Unifier API<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#senders\">Senders<\/a><span class=\"sms-bc-sep\">\u203a<\/span><span class=\"sms-bc-cur\">Get list of senders filtered by one or more channel types<\/span><\/nav><div class=\"sms-api\"><div class=\"sms-api-main\"><h1>Get list of senders filtered by one or more channel types<\/h1><div class=\"sms-ep\"><span class=\"sms-m sms-m--get\">GET<\/span><span class=\"sms-ep-p\">\/v1\/senders<\/span><\/div><hr><div class=\"sms-md\"><p>Get list of senders filtered by one or more channel types.<\/p><\/div><h2>Request<\/h2><details class=\"sms-schema\" open><summary><b>Query Parameters<\/b><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">channelType<\/span><span class=\"sms-pt\">string<\/span><div class=sms-pd>One or more channel types to filter senders by, as a comma-separated list (e.g. <code>channelType=rbm,sms,whatsApp<\/code>). Omit to return senders for all channels.<br><b>Example:<\/b> rbm,sms,whatsApp<\/div><\/div><\/div><\/details><h2>Responses<\/h2><div class=\"sms-tabs sms-tabs--resp\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab sms-rc sms-rc--2 is-on\" data-tab=\"30-0\">200<\/button><button type=\"button\" class=\"sms-tab sms-rc sms-rc--4\" data-tab=\"30-1\">400<\/button><button type=\"button\" class=\"sms-tab sms-rc sms-rc--4\" data-tab=\"30-2\">401<\/button><button type=\"button\" class=\"sms-tab sms-rc sms-rc--4\" data-tab=\"30-3\">404<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"30-0\"><p class=\"sms-rdesc\">List of senders for the specified channel type.<\/p><div class=\"sms-mime\">application\/json<\/div><div class=\"sms-tabs sms-tabs--box\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"27-0\">Example<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"27-1\">Schema<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"27-0\"><div class=\"sms-code\" data-lang=\"json\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;data&quot;: [\n    {\n      &quot;id&quot;: 101,\n      &quot;senderId&quot;: &quot;SMSes_Agent&quot;,\n      &quot;msisdn&quot;: &quot;&quot;,\n      &quot;name&quot;: &quot;SMS.es&quot;,\n      &quot;url&quot;: &quot;&quot;,\n      &quot;channel&quot;: &quot;rbm&quot;\n    },\n    {\n      &quot;id&quot;: 102,\n      &quot;senderId&quot;: &quot;SMSes&quot;,\n      &quot;msisdn&quot;: &quot;&quot;,\n      &quot;name&quot;: &quot;SMS.es&quot;,\n      &quot;url&quot;: &quot;&quot;,\n      &quot;channel&quot;: &quot;sms&quot;\n    },\n    {\n      &quot;id&quot;: 103,\n      &quot;senderId&quot;: &quot;34911222333&quot;,\n      &quot;msisdn&quot;: &quot;+34911222333&quot;,\n      &quot;name&quot;: &quot;SMS.es&quot;,\n      &quot;url&quot;: &quot;&quot;,\n      &quot;channel&quot;: &quot;whatsApp&quot;\n    }\n  ]\n}<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"27-1\"><details class=\"sms-schema\" open><summary><b>Schema<\/b><\/summary><div class=\"sms-nest\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">data<\/span><span class=\"sms-pt\">Sender[]<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">id<\/span><span class=\"sms-pt\">integer<\/span><div class=\"sms-pd\">Unique numeric identifier of the sender.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">senderId<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-pd\">Sender ID (e.g. agent ID for RBM).<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">msisdn<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-pd\">Sender MSISDN (E.164 phone number) or channel-specific address.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-pd\">Display name of the sender.<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">url<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-pd\">Optional URL associated with the sender (e.g. webhook or profile URL).<\/div><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">channel<\/span><span class=\"sms-pt\">string<\/span><div class=\"sms-enum\">Possible values: [<code>rbm<\/code>], [<code>sms<\/code>], [<code>telegram<\/code>], [<code>whatsApp<\/code>], [<code>email<\/code>], [<code>instagram<\/code>], [<code>facebook<\/code>]<\/div><div class=\"sms-pd\">Channel identifier (<code>rbm<\/code> is RCS Business Messaging).<\/div><\/div><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/details><\/div><\/div><\/div><div class=\"sms-pane\" data-pane=\"30-1\"><p class=\"sms-rdesc\">Invalid channel type<\/p><div class=\"sms-mime\">application\/json<\/div><div class=\"sms-tabs sms-tabs--box\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"28-0\">Example<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"28-1\">Schema<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"28-0\"><div class=\"sms-code\" data-lang=\"json\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;error&quot;: {\n    &quot;code&quot;: &quot;string&quot;,\n    &quot;message&quot;: &quot;string&quot;,\n    &quot;description&quot;: &quot;string&quot;,\n    &quot;items&quot;: [\n      {\n        &quot;name&quot;: &quot;string&quot;,\n        &quot;message&quot;: &quot;string&quot;,\n        &quot;description&quot;: &quot;string&quot;\n      }\n    ]\n  }\n}<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"28-1\"><details class=\"sms-schema\" open><summary><b>Schema<\/b><\/summary><div class=\"sms-nest\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">error<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">code<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">message<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">items<\/span><span class=\"sms-pt\">object[]<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">message<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/details><\/div><\/details><\/div><\/div><\/div><div class=\"sms-pane\" data-pane=\"30-2\"><p class=\"sms-rdesc\">Unauthorized<\/p><\/div><div class=\"sms-pane\" data-pane=\"30-3\"><p class=\"sms-rdesc\">Not Found<\/p><div class=\"sms-mime\">application\/json<\/div><div class=\"sms-tabs sms-tabs--box\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"29-0\">Example<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"29-1\">Schema<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"29-0\"><div class=\"sms-code\" data-lang=\"json\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;error&quot;: {\n    &quot;code&quot;: &quot;string&quot;,\n    &quot;message&quot;: &quot;string&quot;,\n    &quot;description&quot;: &quot;string&quot;,\n    &quot;items&quot;: [\n      {\n        &quot;name&quot;: &quot;string&quot;,\n        &quot;message&quot;: &quot;string&quot;,\n        &quot;description&quot;: &quot;string&quot;\n      }\n    ]\n  }\n}<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"29-1\"><details class=\"sms-schema\" open><summary><b>Schema<\/b><\/summary><div class=\"sms-nest\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">error<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">code<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">message<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">items<\/span><span class=\"sms-pt\">object[]<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">message<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/details><\/div><\/details><\/div><\/div><\/div><\/div><\/div><aside class=\"sms-api-side\"><div class=\"sms-tabs sms-tabs--lang\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"31-0\">cURL<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"31-1\">Python<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"31-2\">Node.js<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"31-3\">PHP<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"31-4\">Go<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"31-5\">Java<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"31-6\">C#<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"31-7\">Ruby<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"31-8\">PowerShell<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"31-0\"><div class=\"sms-code\" data-lang=\"bash\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>curl -L -X GET &quot;{{BASE}}\/v1\/senders?channelType=rbm,sms,whatsApp&quot; \\\n  -H &quot;Accept: application\/json&quot; \\\n  -H &quot;X-API-Key: &lt;X-API-Key&gt;&quot;<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"31-1\"><div class=\"sms-code\" data-lang=\"python\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>import requests\n\nurl = &quot;{{BASE}}\/v1\/senders?channelType=rbm,sms,whatsApp&quot;\nheaders = {\n  &quot;Accept&quot;: &quot;application\/json&quot;,\n  &quot;X-API-Key&quot;: &quot;&lt;X-API-Key&gt;&quot;,\n}\n\nresponse = requests.get(url, headers=headers)\nprint(response.status_code)\nprint(response.text)<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"31-2\"><div class=\"sms-code\" data-lang=\"javascript\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>const response = await fetch(&quot;{{BASE}}\/v1\/senders?channelType=rbm,sms,whatsApp&quot;, {\n  method: &quot;GET&quot;,\n  headers: {\n    &quot;Accept&quot;: &quot;application\/json&quot;,\n    &quot;X-API-Key&quot;: &quot;&lt;X-API-Key&gt;&quot;,\n  },\n});\nconsole.log(response.status, await response.text());<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"31-3\"><div class=\"sms-code\" data-lang=\"php\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>&lt;?php\n$ch = curl_init(&#x27;{{BASE}}\/v1\/senders?channelType=rbm,sms,whatsApp&#x27;);\ncurl_setopt_array($ch, [\n  CURLOPT_CUSTOMREQUEST  =&gt; &#x27;GET&#x27;,\n  CURLOPT_RETURNTRANSFER =&gt; true,\n  CURLOPT_HTTPHEADER     =&gt; [\n    &#x27;Accept: application\/json&#x27;,\n    &#x27;X-API-Key: &lt;X-API-Key&gt;&#x27;,\n  ],\n]);\n$response = curl_exec($ch);\necho curl_getinfo($ch, CURLINFO_HTTP_CODE) . PHP_EOL . $response;<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"31-4\"><div class=\"sms-code\" data-lang=\"go\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>package main\n\nimport (\n  &quot;fmt&quot;\n  &quot;io&quot;\n  &quot;net\/http&quot;\n)\n\nfunc main() {\n  req, _ := http.NewRequest(&quot;GET&quot;, &quot;{{BASE}}\/v1\/senders?channelType=rbm,sms,whatsApp&quot;, nil)\n  req.Header.Add(&quot;Accept&quot;, &quot;application\/json&quot;)\n  req.Header.Add(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;)\n\n  res, err := http.DefaultClient.Do(req)\n  if err != nil {\n    panic(err)\n  }\n  defer res.Body.Close()\n  body, _ := io.ReadAll(res.Body)\n  fmt.Println(res.StatusCode, string(body))\n}<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"31-5\"><div class=\"sms-code\" data-lang=\"java\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>import java.net.URI;\nimport java.net.http.*;\n\nHttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n  .uri(URI.create(&quot;{{BASE}}\/v1\/senders?channelType=rbm,sms,whatsApp&quot;))\n  .header(&quot;Accept&quot;, &quot;application\/json&quot;)\n  .header(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;)\n  .method(&quot;GET&quot;, HttpRequest.BodyPublishers.noBody())\n  .build();\nHttpResponse&lt;String&gt; response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.statusCode() + &quot; &quot; + response.body());<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"31-6\"><div class=\"sms-code\" data-lang=\"csharp\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Get, &quot;{{BASE}}\/v1\/senders?channelType=rbm,sms,whatsApp&quot;);\nrequest.Headers.Add(&quot;Accept&quot;, &quot;application\/json&quot;);\nrequest.Headers.Add(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;);\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"31-7\"><div class=\"sms-code\" data-lang=\"ruby\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>require &quot;uri&quot;\nrequire &quot;json&quot;\nrequire &quot;net\/http&quot;\n\nurl = URI(&quot;{{BASE}}\/v1\/senders?channelType=rbm,sms,whatsApp&quot;)\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[&quot;Accept&quot;] = &quot;application\/json&quot;\nrequest[&quot;X-API-Key&quot;] = &quot;&lt;X-API-Key&gt;&quot;\n\nresponse = http.request(request)\nputs response.code, response.read_body<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"31-8\"><div class=\"sms-code\" data-lang=\"powershell\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>$headers = New-Object &quot;System.Collections.Generic.Dictionary[[String],[String]]&quot;\n$headers.Add(&quot;Accept&quot;, &quot;application\/json&quot;)\n$headers.Add(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;)\n\n$response = Invoke-RestMethod &quot;{{BASE}}\/v1\/senders?channelType=rbm,sms,whatsApp&quot; -Method &quot;GET&quot; -Headers $headers\n$response | ConvertTo-Json -Depth 10<\/code><\/pre><\/div><\/div><\/div><div class=\"sms-side-t\">Response<\/div><div class=\"sms-code\" data-lang=\"json\"><div class=\"sms-code-t\">200<\/div><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;data&quot;: [\n    {\n      &quot;id&quot;: 101,\n      &quot;senderId&quot;: &quot;SMSes_Agent&quot;,\n      &quot;msisdn&quot;: &quot;&quot;,\n      &quot;name&quot;: &quot;SMS.es&quot;,\n      &quot;url&quot;: &quot;&quot;,\n      &quot;channel&quot;: &quot;rbm&quot;\n    },\n    {\n      &quot;id&quot;: 102,\n      &quot;senderId&quot;: &quot;SMSes&quot;,\n      &quot;msisdn&quot;: &quot;&quot;,\n      &quot;name&quot;: &quot;SMS.es&quot;,\n      &quot;url&quot;: &quot;&quot;,\n      &quot;channel&quot;: &quot;sms&quot;\n    },\n    {\n      &quot;id&quot;: 103,\n      &quot;senderId&quot;: &quot;34911222333&quot;,\n      &quot;msisdn&quot;: &quot;+34911222333&quot;,\n      &quot;name&quot;: &quot;SMS.es&quot;,\n      &quot;url&quot;: &quot;&quot;,\n      &quot;channel&quot;: &quot;whatsApp&quot;\n    }\n  ]\n}<\/code><\/pre><\/div><\/aside><\/div><nav class=\"sms-pager\"><a class=\"sms-pg sms-pg--prev\" href=\"#senders\"><span>Previous<\/span><b>\u00ab Senders<\/b><\/a><a class=\"sms-pg sms-pg--next\" href=\"#inbound-outbound-messages\"><span>Next<\/span><b>Inbound and Outbound messages \u00bb<\/b><\/a><\/nav><\/article><article class=\"sms-view\" id=\"sms-v-inbound-outbound-messages\" data-view=\"inbound-outbound-messages\" data-title=\"Inbound and Outbound messages\" hidden><nav class=\"sms-bc\"><a href=\"#omnichannel-overview\" class=\"sms-bc-home\" aria-label=\"Home\"><svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\"><path fill=\"currentColor\" d=\"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6a1 1 0 0 0-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z\"\/><\/svg><\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#omnichannel-overview\">Omnichannel<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#unifier-api\">Unifier API<\/a><span class=\"sms-bc-sep\">\u203a<\/span><span class=\"sms-bc-cur\">Inbound and Outbound messages<\/span><\/nav>\n<div class=\"sms-md\">\n<h1>Inbound and Outbound messages<\/h1>\n<p>Use <code>GET \/v1\/files\/{ID}<\/code> to download a media file sent by a mobile subscriber \u2014 a picture, audio, video or other attachment from an inbound message. The <code>ID<\/code> is the file identifier taken from the file URL of the inbound message.<\/p>\n<p>The request requires the <code>X-API-Key<\/code> header. The response is passed through from the channel provider, and its <code>Content-Type<\/code> header reflects the media type when known.<\/p>\n<div class=\"sms-cards\"><a class=\"sms-card\" href=\"#download-file\"><div class=\"sms-card-t\">\ud83d\udcc4\ufe0f Download a media file delivered by inbound message<\/div><div class=\"sms-card-d\">Streams the MO file referenced by the ID of the file.<\/div><\/a><\/div>\n<\/div><nav class=\"sms-pager\"><a class=\"sms-pg sms-pg--prev\" href=\"#get-senders\"><span>Previous<\/span><b>\u00ab Get list of senders filtered by one or more channel types<\/b><\/a><a class=\"sms-pg sms-pg--next\" href=\"#download-file\"><span>Next<\/span><b>Download a media file delivered by inbound message \u00bb<\/b><\/a><\/nav><\/article><article class=\"sms-view\" id=\"sms-v-download-file\" data-view=\"download-file\" data-title=\"Download a media file delivered by inbound message\" hidden><nav class=\"sms-bc\"><a href=\"#omnichannel-overview\" class=\"sms-bc-home\" aria-label=\"Home\"><svg viewBox=\"0 0 24 24\" width=\"16\" height=\"16\"><path fill=\"currentColor\" d=\"M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6a1 1 0 0 0-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z\"\/><\/svg><\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#omnichannel-overview\">Omnichannel<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#unifier-api\">Unifier API<\/a><span class=\"sms-bc-sep\">\u203a<\/span><a href=\"#inbound-outbound-messages\">Inbound and Outbound messages<\/a><span class=\"sms-bc-sep\">\u203a<\/span><span class=\"sms-bc-cur\">Download a media file delivered by inbound message<\/span><\/nav><div class=\"sms-api\"><div class=\"sms-api-main\"><h1>Download a media file delivered by inbound message<\/h1><div class=\"sms-ep\"><span class=\"sms-m sms-m--get\">GET<\/span><span class=\"sms-ep-p\">\/v1\/files\/{ID}<\/span><\/div><hr><div class=\"sms-md\"><p>Streams the MO file referenced by the file ID (e.g. from a file URL in an inbound message). Requires <code>X-API-Key<\/code>. The response is proxied from the channel provider; the <code>Content-Type<\/code> header reflects the media type when known.<\/p><\/div><h2>Request<\/h2><details class=\"sms-schema\" open><summary><b>Path Parameters<\/b><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">ID<\/span><span class=\"sms-pt\">uuid<\/span><span class=sms-req>required<\/span><div class=sms-pd>File identifier in UUID format.<\/div><\/div><\/div><\/details><h2>Responses<\/h2><div class=\"sms-tabs sms-tabs--resp\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab sms-rc sms-rc--2 is-on\" data-tab=\"34-0\">200<\/button><button type=\"button\" class=\"sms-tab sms-rc sms-rc--4\" data-tab=\"34-1\">401<\/button><button type=\"button\" class=\"sms-tab sms-rc sms-rc--4\" data-tab=\"34-2\">404<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"34-0\"><p class=\"sms-rdesc\">File bytes (binary stream).<\/p><div class=\"sms-mime\">*\/*<\/div><div class=\"sms-tabs sms-tabs--box\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"32-0\">Schema<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"32-0\"><details class=\"sms-schema\" open><summary><b>Schema<\/b><\/summary><div class=\"sms-nest\"><div class=\"sms-pd\"><code>*\/*<\/code> \u2014 string &lt;binary&gt;<\/div><div class=\"sms-sch-empty\">object<\/div><\/div><\/details><\/div><\/div><\/div><div class=\"sms-pane\" data-pane=\"34-1\"><p class=\"sms-rdesc\">Unauthorized<\/p><\/div><div class=\"sms-pane\" data-pane=\"34-2\"><p class=\"sms-rdesc\">File not found<\/p><div class=\"sms-mime\">application\/json<\/div><div class=\"sms-tabs sms-tabs--box\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"33-0\">Example<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"33-1\">Schema<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"33-0\"><div class=\"sms-code\" data-lang=\"json\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>{\n  &quot;error&quot;: {\n    &quot;code&quot;: &quot;string&quot;,\n    &quot;message&quot;: &quot;string&quot;,\n    &quot;description&quot;: &quot;string&quot;,\n    &quot;items&quot;: [\n      {\n        &quot;name&quot;: &quot;string&quot;,\n        &quot;message&quot;: &quot;string&quot;,\n        &quot;description&quot;: &quot;string&quot;\n      }\n    ]\n  }\n}<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"33-1\"><details class=\"sms-schema\" open><summary><b>Schema<\/b><\/summary><div class=\"sms-nest\"><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">error<\/span><span class=\"sms-pt\">object<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-prop\"><span class=\"sms-pn\">code<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">message<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><details class=\"sms-prop sms-prop--n\"><summary><span class=\"sms-pn\">items<\/span><span class=\"sms-pt\">object[]<\/span><\/summary><div class=\"sms-nest\"><div class=\"sms-arr\">Array [<\/div><div class=\"sms-prop\"><span class=\"sms-pn\">name<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">message<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-prop\"><span class=\"sms-pn\">description<\/span><span class=\"sms-pt\">string<\/span><\/div><div class=\"sms-arr\">]<\/div><\/div><\/details><\/div><\/details><\/div><\/details><\/div><\/div><\/div><\/div><\/div><aside class=\"sms-api-side\"><div class=\"sms-tabs sms-tabs--lang\" data-tabs><div class=\"sms-tabbar\"><button type=\"button\" class=\"sms-tab is-on\" data-tab=\"35-0\">cURL<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"35-1\">Python<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"35-2\">Node.js<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"35-3\">PHP<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"35-4\">Go<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"35-5\">Java<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"35-6\">C#<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"35-7\">Ruby<\/button><button type=\"button\" class=\"sms-tab\" data-tab=\"35-8\">PowerShell<\/button><\/div><div class=\"sms-pane is-on\" data-pane=\"35-0\"><div class=\"sms-code\" data-lang=\"bash\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>curl -L -X GET &quot;{{BASE}}\/v1\/files\/9a7c3e1b-4d2f-4b8a-b6e0-1c5d7f9a3e2b&quot; \\\n  -H &quot;Accept: application\/json&quot; \\\n  -H &quot;X-API-Key: &lt;X-API-Key&gt;&quot; \\\n  -o file.bin<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"35-1\"><div class=\"sms-code\" data-lang=\"python\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>import requests\n\nurl = &quot;{{BASE}}\/v1\/files\/9a7c3e1b-4d2f-4b8a-b6e0-1c5d7f9a3e2b&quot;\nheaders = {\n  &quot;Accept&quot;: &quot;application\/json&quot;,\n  &quot;X-API-Key&quot;: &quot;&lt;X-API-Key&gt;&quot;,\n}\n\nresponse = requests.get(url, headers=headers)\nwith open(&quot;file.bin&quot;, &quot;wb&quot;) as f:\n    f.write(response.content)<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"35-2\"><div class=\"sms-code\" data-lang=\"javascript\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>const response = await fetch(&quot;{{BASE}}\/v1\/files\/9a7c3e1b-4d2f-4b8a-b6e0-1c5d7f9a3e2b&quot;, {\n  method: &quot;GET&quot;,\n  headers: {\n    &quot;Accept&quot;: &quot;application\/json&quot;,\n    &quot;X-API-Key&quot;: &quot;&lt;X-API-Key&gt;&quot;,\n  },\n});\nawait require(&quot;fs\/promises&quot;).writeFile(&quot;file.bin&quot;, Buffer.from(await response.arrayBuffer()));<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"35-3\"><div class=\"sms-code\" data-lang=\"php\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>&lt;?php\n$ch = curl_init(&#x27;{{BASE}}\/v1\/files\/9a7c3e1b-4d2f-4b8a-b6e0-1c5d7f9a3e2b&#x27;);\ncurl_setopt_array($ch, [\n  CURLOPT_CUSTOMREQUEST  =&gt; &#x27;GET&#x27;,\n  CURLOPT_RETURNTRANSFER =&gt; true,\n  CURLOPT_HTTPHEADER     =&gt; [\n    &#x27;Accept: application\/json&#x27;,\n    &#x27;X-API-Key: &lt;X-API-Key&gt;&#x27;,\n  ],\n]);\nfile_put_contents(&#x27;file.bin&#x27;, curl_exec($ch));<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"35-4\"><div class=\"sms-code\" data-lang=\"go\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>package main\n\nimport (\n  &quot;fmt&quot;\n  &quot;io&quot;\n  &quot;net\/http&quot;\n)\n\nfunc main() {\n  req, _ := http.NewRequest(&quot;GET&quot;, &quot;{{BASE}}\/v1\/files\/9a7c3e1b-4d2f-4b8a-b6e0-1c5d7f9a3e2b&quot;, nil)\n  req.Header.Add(&quot;Accept&quot;, &quot;application\/json&quot;)\n  req.Header.Add(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;)\n\n  res, err := http.DefaultClient.Do(req)\n  if err != nil {\n    panic(err)\n  }\n  defer res.Body.Close()\n  body, _ := io.ReadAll(res.Body)\n  fmt.Println(res.StatusCode, string(body))\n}<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"35-5\"><div class=\"sms-code\" data-lang=\"java\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>import java.net.URI;\nimport java.net.http.*;\n\nHttpClient client = HttpClient.newHttpClient();\nHttpRequest request = HttpRequest.newBuilder()\n  .uri(URI.create(&quot;{{BASE}}\/v1\/files\/9a7c3e1b-4d2f-4b8a-b6e0-1c5d7f9a3e2b&quot;))\n  .header(&quot;Accept&quot;, &quot;application\/json&quot;)\n  .header(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;)\n  .method(&quot;GET&quot;, HttpRequest.BodyPublishers.noBody())\n  .build();\nHttpResponse&lt;String&gt; response = client.send(request, HttpResponse.BodyHandlers.ofString());\nSystem.out.println(response.statusCode() + &quot; &quot; + response.body());<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"35-6\"><div class=\"sms-code\" data-lang=\"csharp\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>var client = new HttpClient();\nvar request = new HttpRequestMessage(HttpMethod.Get, &quot;{{BASE}}\/v1\/files\/9a7c3e1b-4d2f-4b8a-b6e0-1c5d7f9a3e2b&quot;);\nrequest.Headers.Add(&quot;Accept&quot;, &quot;application\/json&quot;);\nrequest.Headers.Add(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;);\nvar response = await client.SendAsync(request);\nresponse.EnsureSuccessStatusCode();\nConsole.WriteLine(await response.Content.ReadAsStringAsync());<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"35-7\"><div class=\"sms-code\" data-lang=\"ruby\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>require &quot;uri&quot;\nrequire &quot;json&quot;\nrequire &quot;net\/http&quot;\n\nurl = URI(&quot;{{BASE}}\/v1\/files\/9a7c3e1b-4d2f-4b8a-b6e0-1c5d7f9a3e2b&quot;)\nhttp = Net::HTTP.new(url.host, url.port)\nhttp.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[&quot;Accept&quot;] = &quot;application\/json&quot;\nrequest[&quot;X-API-Key&quot;] = &quot;&lt;X-API-Key&gt;&quot;\n\nresponse = http.request(request)\nputs response.code, response.read_body<\/code><\/pre><\/div><\/div><div class=\"sms-pane\" data-pane=\"35-8\"><div class=\"sms-code\" data-lang=\"powershell\"><button type=\"button\" class=\"sms-copy\" aria-label=\"Copy\">Copy<\/button><pre><code>$headers = New-Object &quot;System.Collections.Generic.Dictionary[[String],[String]]&quot;\n$headers.Add(&quot;Accept&quot;, &quot;application\/json&quot;)\n$headers.Add(&quot;X-API-Key&quot;, &quot;&lt;X-API-Key&gt;&quot;)\n\n$response = Invoke-RestMethod &quot;{{BASE}}\/v1\/files\/9a7c3e1b-4d2f-4b8a-b6e0-1c5d7f9a3e2b&quot; -Method &quot;GET&quot; -Headers $headers -OutFile file.bin\n$response | ConvertTo-Json -Depth 10<\/code><\/pre><\/div><\/div><\/div><\/aside><\/div><nav class=\"sms-pager\"><a class=\"sms-pg sms-pg--prev\" href=\"#inbound-outbound-messages\"><span>Previous<\/span><b>\u00ab Inbound and Outbound messages<\/b><\/a><span><\/span><\/nav><\/article>\n      <footer class=\"sms-foot\">\u00a9 SMS.es \u00b7 G729 S.L. \u2014 Unifier API v1.0 \u00b7 <a href=\"mailto:info@sms.es\">info@sms.es<\/a><\/footer>\n    <\/main>\n  <\/div>\n<\/div>\n","protected":false},"excerpt":{"rendered":"<p>SMS.es Developers Omnichannel Omnichannel Overview Use Cases Unifier API Introduction Message Request Request to send a message that may include fallback messages to a receiverPOST Inbound and Outbound message retrievers Get the message based on the message&#x27;s IDGET Notifications Get list of latest notifications for every message send from the accountGET Receive message update notifications&#8230;<\/p>","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_kadence_starter_templates_imported_post":false,"_kad_post_transparent":"disable","_kad_post_title":"hide","_kad_post_layout":"fullwidth","_kad_post_sidebar_id":"","_kad_post_content_style":"unboxed","_kad_post_vertical_padding":"default","_kad_post_feature":"hide","_kad_post_feature_position":"","_kad_post_header":true,"_kad_post_footer":true,"_kad_post_classname":"","footnotes":""},"class_list":["post-448","page","type-page","status-publish","hentry"],"_hostinger_reach_plugin_has_subscription_block":false,"_hostinger_reach_plugin_is_elementor":false,"_links":{"self":[{"href":"https:\/\/sms.es\/en\/wp-json\/wp\/v2\/pages\/448","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/sms.es\/en\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/sms.es\/en\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/sms.es\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/sms.es\/en\/wp-json\/wp\/v2\/comments?post=448"}],"version-history":[{"count":1,"href":"https:\/\/sms.es\/en\/wp-json\/wp\/v2\/pages\/448\/revisions"}],"predecessor-version":[{"id":451,"href":"https:\/\/sms.es\/en\/wp-json\/wp\/v2\/pages\/448\/revisions\/451"}],"wp:attachment":[{"href":"https:\/\/sms.es\/en\/wp-json\/wp\/v2\/media?parent=448"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}