Sandbox - WhatsApp Message

Send WhatsApp Message V2

This method helps you to generate and send WhatsApp message to destination number in sandbox environment.

Callback Description

Callbacks requires the url to be filled on payload.

your-callback-url.com/callback

Example callback that we'll send

your-callback-url.com/callback?session_id=d0f5fb5c-2d50-4d3f-aea7-20018ab15806&status=1

To obtain the appropriate response, the payload input must adhere to the predetermined scenario. <br> Input other than the scenario will be considered an Invalid Scenario <br>

Response & Status Description

StatusDescriptionCondition
6282123060001Success Payload201 "Message sent successfully"
6282123060002Bad Request400 Validation error"
6282123060003Invalid Header401 "Authorization failed"
6282123060004insufficient quota403 "Quota insufficient"
6282123060005Blocked Msisdn409 "Msisdn invalid: msisdn has been blocked"
6282123060006Too Many Request429 "Too many request in the allowed time frame"
post/v2/whatsapp/message/send/sandbox

Request

  • Base URL
    https://api.verihubs.com
  • URL
    https://api.verihubs.com/v2/whatsapp/message/send/sandbox
  • Auth
    none declared. Required headers: App-ID, API-Key

Headers

App-IDstring required
API-Keystring required

Request body

msisdnstring required

Destination Phone Number. Scenario is the only valid msisdn to use. Any other msisdn format will be marked as Invalid.

contentstring[]

Optional. String that will replaced variable from Template. For example 'Hello {{1}}, thank you for your interest for our product. Contact us at {{2}} if you need additional help'. If you put Verihubs in payload array 1, it will change variable {{1}} to Verihubs.

lang_codestring

Optional. Language code to send in a different language (need to be approved first too)

callback_urlstring

Optional. This URL will be called by the server when the desired event will occur.

Example request

{
  "msisdn": "6282123060001",
  "content": [
    "Verihubs"
  ],
  "lang_code": "en",
  "callback_url": "https://your-url-callback.com"
}

Response

Successful Request

messagestring required

Message

msisdnstring required

destination number with international prefix country code

session_idstring required

Generated ID which associated with verification request

Example response

{
  "message": "Message sent successfully",
  "msisdn": "6282123060001",
  "session_id": "asddede-asdae234-34sfd3-fe234d"
}

Changes

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