WhatsApp Text Message

post

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

Used for responding to an incoming customer message, or follow-up messages within the 24-hour reply window as per WhatsApp's messaging guidelines. Note: Modify YourRegion in the URL to the right to reflect your tenant’s region. See Know your endpoint page.

📘
Note
It is recommended to use a valid authorization ID; the failure of notification won’t be logged in Debug Logs.
The notify URL should be filled with the proper URL format; otherwise, it would be considered an invalid URL.
The notify URL should be provided with proper spacing of the URL; when space is provided in front of the URL or at the end of the URL, it would be considered an invalid URL.

Error Codes

Refer to the Apple Messages for Business section.

Body Params

deliverychannel

string

required

Defaults to whatsapp

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

appid

string

required

Refers to WhatsApp app id. You can obtain this from the Apps page on the platform.

destination

array of objects

required

Configure message recipient(s) details as part of destination JSON object.

destination*

channels

object

required

Channels used for incoming messages

options

array of objects

JSON Object

options

corelationid

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

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

notifyurlAuthId

string

Unique Authentication ID.

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

📘Note

Error Codes

200200

400400

📘
Note