Send a message

Caution

For security reasons, please contact your Account Manager to provide you with an API host.

The host https://api.example.com not is a real endpoint.

POST

/wab

This endpoint allows you to send a message via Whatsapp Business API. You can send text messages, media messages, and more.

External Documentation Note: This documentation is currently under migration. Please refer to the previous documentation for more details.

Authorizations

BasicAuth

Use HTTP Basic Authentication to authorize requests.

The password is your API key, not your web portal password.

Example: Authorization: Basic WU9VUl9VU0VSTkFNRV9IRVJFOllPVVJfQVBJX1RPS0VOX0hFUkU=

(Where “YOUR_USERNAME_HERE:YOUR_API_TOKEN_HERE” is Base64-encoded)

Request Body ^required

Payload containing the message and recipient information.

One of:

Template

Template

Payload for sending a template message via Whatsapp Business API. This variant is used when you want to send a pre-defined template message.

object

agent

required

string

5215512345678

number

required

string

525512345679

type

required

Allowed values: template

language

required

string

Allowed values: en es fr de it pt

es

templateName

required

string

welcome_utility

templateData

required

object

body

object

placeholders

Array<string>

[
  "John Doe",
  "john@doe.com"
]

header

object

placeholders

Array<string>

<= 1 items

[
  "John Doe"
]

Text

Text

Payload for sending a text message via Whatsapp Business API. This variant is used when you want to send a simple text message.

object

agent

required

string

5215512345678

number

required

string

525512345679

type

required

Allowed values: text

message

required

string

This is a text message sent via Whatsapp Business API.

Image

Image

Payload for sending an image message via Whatsapp Business API. This variant is used when you want to send an image.

object

agent

required

string

5215512345678

number

required

string

525512345679

type

required

Allowed values: image

caption

required

string

sample01.jpg

url

required

string

https://www.buildquickbots.com/whatsapp/media/sample/jpg/sample01.jpg

File

File

Payload for sending a file message via Whatsapp Business API. This variant is used when you want to send a file (e.g., PDF, DOCX).

object

agent

required

string

5215512345678

number

required

string

525512345679

type

required

Allowed values: image

filename

required

string

sample01.pdf

url

required

string

https://www.buildquickbots.com/whatsapp/media/sample/pdf/sample01.pdf

Audio

Audio

Payload for sending an audio message via Whatsapp Business API. This variant is used when you want to send an audio file.

object

agent

required

string

5215512345678

number

required

string

525512345679

type

required

Allowed values: audio

url

required

string

https://www.buildquickbots.com/whatsapp/media/sample/audio/sample02.mp3

Video

Video

Payload for sending a video message via Whatsapp Business API. This variant is used when you want to send a video file.

object

agent

required

string

5215512345678

number

required

string

525512345679

type

required

Allowed values: video

url

required

string

https://www.buildquickbots.com/whatsapp/media/sample/video/sample01.mp4

Responses

200

Message sent successfully

object

error

boolean

code

integer

200

message

string

Message enqueued successfully

Example

{
  "error": false,
  "code": 200,
  "message": "Message enqueued successfully"
}

304

Agent field must be specified to send WAB message

object

error

boolean

true

code

integer

304

message

string

Agent field must be specified to send WAB message

Example

{
  "error": true,
  "code": 304,
  "message": "Agent field must be specified to send WAB message"
}

305

Number field must be specified to send WAB message

object

error

boolean

true

code

integer

305

message

string

Number field must be specified to send WAB message

Example

{
  "error": true,
  "code": 305,
  "message": "Number field must be specified to send WAB message"
}

306

Please user number in E.164 format

object

error

boolean

true

code

integer

306

message

string

Please user number in E.164 format

Example

{
  "error": true,
  "code": 306,
  "message": "Please user number in E.164 format"
}

307

Type field must be specified to send WAB message

object

error

boolean

true

code

integer

307

message

string

Type field must be specified to send WAB message

Example

{
  "error": true,
  "code": 307,
  "message": "Type field must be specified to send WAB message"
}

400

Agent or User are invalid

object

error

boolean

true

code

integer

400

message

string

Agent or User are invalid

Example

{
  "error": true,
  "code": 400,
  "message": "Agent or User are invalid"
}

404

Whatsapp agent isn’t valid or not found

object

error

boolean

true

code

integer

404

message

string

Whatsapp agent isn't valid or not found

Example

{
  "error": true,
  "code": 404,
  "message": "Whatsapp agent isn't valid or not found"
}

500

Error enqueuing message

object

error

boolean

true

code

integer

500

message

string

Error enqueuing message

Example

{
  "error": true,
  "code": 500,
  "message": "Error enqueuing message"
}

Examples

Useful for guiding users to view code examples in different developer languages.

Bash

developer@developer:~#

curl -X POST "https://api.example.com/wab" \
    -H "Accept: application/json" \
  -H "Connection: keep-alive" \
  -H "Content-Type: application/json" \
  -H "Authorization: Basic <base64-encoded-credentials>" \
  -d '{}'

Node.js

example.js

  const fetch = require('node-fetch');

  fetch("https://api.example.com/wab", {
    method: "POST",
    headers: {
  "Accept": "application/json",
  "Connection": "keep-alive",
  "Content-Type": "application/json",
  "Authorization": "Basic <base64-encoded-credentials>"
},
    body: JSON.stringify({})
  })
    .then(res => res.json())
    .then(console.log)
    .catch(console.error);

PHP

example.php

  <?php
  $curl = curl_init();

  curl_setopt_array($curl, [
    CURLOPT_URL => "https://api.example.com/wab",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
    "Accept: application/json",
    "Connection: keep-alive",
    "Content-Type: application/json",
    "Authorization: Basic <base64-encoded-credentials>"
    ],
    CURLOPT_POSTFIELDS => json_encode({})
  ]);

  $response = curl_exec($curl);
  curl_close($curl);
  echo $response;
  ?>

C-Sharp

example.cs

  using System.Net.Http;
  using System.Text;
  using System.Threading.Tasks;

  var client = new HttpClient();
  var request = new HttpRequestMessage(HttpMethod.POST, "https://api.example.com/wab") {
    Content = new StringContent("{}", Encoding.UTF8, "application/json")
  };
  request.Headers.Add("Accept", "application/json");
request.Headers.Add("Connection", "keep-alive");
request.Headers.Add("Content-Type", "application/json");
request.Headers.Add("Authorization", "Basic <base64-encoded-credentials>");
  var response = await client.SendAsync(request);
  var responseBody = await response.Content.ReadAsStringAsync();
  Console.WriteLine(responseBody);

Python

example.py

  import requests
  import json

  url = "https://api.example.com/wab"
  headers = {
    "Accept": "application/json",
  "Connection": "keep-alive",
  "Content-Type": "application/json",
  "Authorization": "Basic <base64-encoded-credentials>"
  }
  data = {}

  response = requests.post(url, headers=headers, json=data)
  print(response.text)

Java

example.java

  import java.io.OutputStream;
  import java.net.HttpURLConnection;
  import java.net.URL;
  import java.nio.charset.StandardCharsets;

  public class ApiExample {
    public static void main(String[] args) throws Exception {
      URL url = new URL("https://api.example.com/wab");
      HttpURLConnection conn = (HttpURLConnection) url.openConnection();
      conn.setRequestMethod("POST");
      conn.setDoOutput(true);
      conn.setRequestProperty("Accept", "application/json");
    conn.setRequestProperty("Connection", "keep-alive");
    conn.setRequestProperty("Content-Type", "application/json");
    conn.setRequestProperty("Authorization", "Basic <base64-encoded-credentials>");

      String jsonInputString = "{}";
      try(OutputStream os = conn.getOutputStream()) {
          byte[] input = jsonInputString.getBytes(StandardCharsets.UTF_8);
          os.write(input, 0, input.length);
      }

      int code = conn.getResponseCode();
      System.out.println("Response code: " + code);
    }
  }