Send Whatsapp Interactive Media Message

Sends an interactive message with an image, video or document header and reply buttons or a URL button.

Before you call

  • from (your connected WhatsApp number) is required, plus to (customer's phone number with country code) or customerId. groupId is not supported.
  • content.mediaUrl (a valid URL) and content.mediaType (image, video or document) are required. content.fileName is optional for documents.
  • content.body is required, up to 1024 characters.
  • Send exactly one of content.buttons (reply buttons, each with a unique id and a title) or content.ctaButton (one URL button).
  • ctaButton.display_text is up to 20 characters. ctaButton.url must start with http:// or https://.
  • content.footer is optional, up to 60 characters.
  • messageId is optional. If you send it, it must be a UUID v4. If you don't, DoubleTick generates one.

How it works

  • DoubleTick reads the media's content type from mediaUrl, so the URL must be publicly reachable.
  • The message is queued for sending. The response contains recipient, status (SENT or FAILED, with errorMessage) and messageId.
  • Use the messageId with Get Message Status to check delivery and read status.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 10 and 15

The phone number from which the message is sent, with the country code

string
required
length between 10 and 15

The phone number to which the message is sent, with the country code

string
length between 36 and 36

Message ID (UUID v4) to be used for the message. If not provided, a random UUID v4 will be generated

content
required

Interactive media message to be sent

Responses
201

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json