WhatsApp Location Message

post

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

Share location as a message on WhatsApp to your customers. This message type can be sent within 24 hour window after a customer initiated message. 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

Contains the applicationid

destination

array of objects

required

Unique user id for the recipient of the message on whatsapp.

destination*

channels

object

Channels used for incoming messages

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.

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