WhatsApp Template Messages

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

Send business initiated messages using message templates beyond the 24 hour window to your customers. A message template can be text-based, media-based, or interactive. Note: Modify YourRegion in the URL to the right to reflect your tenant’s region. See Know your endpoint page.

🚧
Template API usage
The template should be registered and approved from Tools -> Templates section within imiconnect platform, before it can be used to send notification messages.

Error Codes

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

Body Params

deliverychannel

string

required

Defaults to whatsapp

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

appid

string

required

Contains the applicationid

destination

array of objects

required

Configure message recipient details as part of destination JSON object.

destination*

message

object

required

Template message configuration

correlationid

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.

callbackData

string

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

notifyurl

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.

channels

object

JSON object for configuring Channels

Headers

key

string

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

authorization

string

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

Responses

Language

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://yourregion.webexconnect.io/resources/v1/messaging/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "deliverychannel": "whatsapp"
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

🚧Template API usage

Error Codes

200200

400400

🚧
Template API usage