Platform DocumentationPlatform ChangelogAPI ReferencePush & In-App SDKsSDK Release Notes
API Reference
FAQsWebsite
Start typing to search…

WhatsApp HSMs-Text based proactive notification message(Deprecated)

post https://{YourRegion}.webexconnect.io/resources/v1/messaging/

Send business initiated messages using message templates beyond the 24 hour window to your customers. This message type includes text based templates without a header, footer or buttons. Note: Modify YourRegion in the URL to the right to reflect your tenant’s region. See Know your endpoint page.

❗️

HSM Message Deprecation Alert

WhatsApp has announced that they will be deprecating the HSM message type sometime in early 2022. We recommend you to use Template message type instead of HSM messages, and migrate any existing HSMs to Template Message type. Unlike HSM which was meant to be used only for text messages, Template message type can be used to configure template messages of multiple components including text.

🚧

Some of the below values such as namespace, element_name, etc. are not available on imiconnect platform UI and need to be taken from WhatsApp Business Manager by reaching out to your regional support team. However, you wouldn't need it as we now recommend you to use Template message type instead of HSM.

❗️

WhatsApp Language Policy Change

Please note that the fallback language policy has been deprecated and the deterministic language policy is now the default policy. Do not use 'fallback' language policy while sending HSMs as it may lead to message delivery failures.

Localizable Parameters

When sending a Message Template, the hsm object is required. To define Message Templates, you specify a namespace and an element_name pair that identify a template. Templates have parameters that will be dynamically incorporated into the message. For the example used in this document, the Message Template looks like this:

ParametersTypeMandatoryDescription
defaultStringYesDefault text if localization fails
currencycurrency objectNoIf the currency object is used, it contains required parameters currency_code and amount_1000.
date_timedate_time objectNoIf the date_time object is used, further definition of the date and time is required.

Error Codes

Refer to the below page https://developers.imiconnect.io/reference/channel-specific-status-codes-1#whatsapp

Body Params
string
Defaults to whatsapp

Channel used to send the message i.e., WhatsApp in this case.

string

Contains the application ID

destination
array of objects
required

Unique user id for the recipient of the message on Apple Messages for Business.

destination*
channels
object

Channels used for incoming messages

string

The CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event. This is configured as a part of the request.

string

Data that you have configured to receive on the notify Url. This is configured as a part of the request.

string

Configure a URL to get notifications on delivery reports for a WhatsApp message. This field accepts only a valid URL or a variable. If an invalid URL is passed in API request or via a variable, then such request will not be considered eligible for retries.

Headers
string

Applicable when you want to use service key for API authentication. Available under API tab within a service in your Webex Connect tenant.

string

JSON Web Token (JWT) for authentication (e.g. bearer ) used alternatively to Service Key.

Responses

Updated 7 months ago

Language
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago