Sign in

v1

latestOpenAPI 3.0.22026-07-2432112226.7 KB
WhatsApp Bulk Message

Send WhatsApp Bulk Message V2

This method allows you to broadcast WhatsApp message to multiple destination numbers. Maximum 5000 msisdn per bulk send.<br>

API Update Notice: This V2 endpoint is the recommended version, replacing the previous V1 endpoint. We recommend migrating to V2 immediately for a better experience.<br>

Benefits of V2:

  • Decreased processing time for API requests and responses
  • Improved features: Blocking Request, Spam Check, and Blocked Numbers
  • Increased RPS (from 30 RPS to 50 RPS)
  • Better developer environment to support future developments
  • Improved logging and monitoring
  • Improved dependencies and service stability<br>

A rate limit of 50 RPS is applied to WhatsApp services. Verihubs also applies rate limits divided into several categories based on product. For more details, see Rate Limit.

post/v2/whatsapp/message/bulk

Headers

App-IDstring required
API-Keystring required

Request body

msisdnstring[] required

Destination phone number array, you must include international prefix number.

template_namestring required

Template name to be used.

lang_codestring required

Language code of the template to be used.

callback_urlstring

This URL will be called by Verihubs' server when an event occurs.

Example request

{
  "msisdn": [
    "6282244356345",
    "628221253465"
  ],
  "content": [
    {
      "header_params": [
        "https://mystoragebucket.com/image.png"
      ],
      "body_params": [
        "John",
        "Our Website"
      ],
      "button_param": {
        "url_param": "content/promotion/244"
      }
    },
    {
      "header_params": [
        "https://mystoragebucket.com/image.png"
      ],
      "body_params": [
        "Doe",
        "Our Website"
      ],
      "button_param": {
        "url_param": "content/promotion/243"
      }
    }
  ],
  "template_name": "transaction_daily_update",
  "lang_code": "en",
  "callback_url": "http://yourcallbackurl.com"
}

Response

Successful Response

code201

Code (to be deleted on November 30, 2022)

status201

Status (to be deleted on November 30, 2022)

messagestring

Message

msisdnstring[]

destination number list with international prefix country code

Example response

{
  "code": 201,
  "status": 201,
  "message": "Bulk message sent successfully",
  "msisdn": [
    "6282244356345",
    "628221253465"
  ]
}