Sign in
messaging

Send whatsapp message

Sends a whatsapp message (broadcast) to a list of recipients

post/converged/whatsapp

Request body

messageContentstring required

UTF-8 encoded message content. May not exceed 10000 characters.

recipientAddressListinteger[] required

List of recipients (E164 formatted MSISDNs - see Wikipedia en.wikipedia.org/wiki/MSISDN) to whom the message should be sent. The list of recipients may contain a maximum of 1000 entries.

contentCategory'informational' | 'advertisement'

Optional. The content category that is used to categorize the message (used for blacklisting). The following content categories are supported: informational or advertisement. If no content category is provided, the default setting is used (may be changed inside the onlinesms web interface).

clientMessageIdstring

Optional. May contain a freely definable message id.

priorityinteger

Optional. Priority of the message. Must not exceed the value configured for the account used to send the message. For more information please contact our customer service.

testboolean

Optional. true: The transmission is only simulated, no Whatsapp message is sent. Depending on the number of recipients the status code 2000 or 2001 is returned. false (default): No simulation is done. The Whatsapp message is sent.

attachmentIdinteger

Optional. May contain an attachmentId. Attachments can be created by using POST /whatsapp/attachment

validityPeriodeinteger

Optional. Specifies the validity periode (in seconds) in which the message is tried to be delivered to the recipient. A minimum of 1 minute and a maximum of 3 days are allowed.

Example request

{
  "messageContent": "example message content",
  "contentCategory": "informational",
  "clientMessageId": "myUniqueId",
  "priority": 5,
  "attachmentId": 20,
  "validityPeriode": 300
}

Response

OK

Changes

No recorded changes to this endpoint across all 1 revision of this API.