Send WhatsApp Message

cURL

curl --request POST \
  --url https://api.buildwithchirp.com/v1/whatsapp/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "+15551234567",
  "to": "+15559876543",
  "type": "text",
  "replyTo": "msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI"
}
'

import requests

url = "https://api.buildwithchirp.com/v1/whatsapp/messages"

payload = {
    "from": "+15551234567",
    "to": "+15559876543",
    "type": "text",
    "replyTo": "msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    from: '+15551234567',
    to: '+15559876543',
    type: 'text',
    replyTo: 'msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI'
  })
};

fetch('https://api.buildwithchirp.com/v1/whatsapp/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.buildwithchirp.com/v1/whatsapp/messages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'from' => '+15551234567',
    'to' => '+15559876543',
    'type' => 'text',
    'replyTo' => 'msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.buildwithchirp.com/v1/whatsapp/messages"

	payload := strings.NewReader("{\n  \"from\": \"+15551234567\",\n  \"to\": \"+15559876543\",\n  \"type\": \"text\",\n  \"replyTo\": \"msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.buildwithchirp.com/v1/whatsapp/messages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"from\": \"+15551234567\",\n  \"to\": \"+15559876543\",\n  \"type\": \"text\",\n  \"replyTo\": \"msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.buildwithchirp.com/v1/whatsapp/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"from\": \"+15551234567\",\n  \"to\": \"+15559876543\",\n  \"type\": \"text\",\n  \"replyTo\": \"msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "from": "<string>",
  "to": "<string>",
  "type": "text",
  "status": "queued",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "The phone number \"+1abc\" is not in E.164 format.",
    "code": "invalid_phone_number",
    "doc_url": "https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number",
    "param": "from",
    "provider": {
      "source": "meta",
      "code": 123,
      "message": "<string>",
      "fbtrace_id": "<string>",
      "health_status": {
        "can_send_message": "AVAILABLE",
        "entities": [
          {
            "entity_type": "PHONE_NUMBER",
            "id": "<string>",
            "can_send_message": "AVAILABLE",
            "can_receive_call_sip": "AVAILABLE",
            "errors": [
              {
                "error_code": 123,
                "error_description": "<string>",
                "possible_solution": "<string>"
              }
            ]
          }
        ]
      }
    },
    "additional_info": [
      "<string>"
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "The phone number \"+1abc\" is not in E.164 format.",
    "code": "invalid_phone_number",
    "doc_url": "https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number",
    "param": "from",
    "provider": {
      "source": "meta",
      "code": 123,
      "message": "<string>",
      "fbtrace_id": "<string>",
      "health_status": {
        "can_send_message": "AVAILABLE",
        "entities": [
          {
            "entity_type": "PHONE_NUMBER",
            "id": "<string>",
            "can_send_message": "AVAILABLE",
            "can_receive_call_sip": "AVAILABLE",
            "errors": [
              {
                "error_code": 123,
                "error_description": "<string>",
                "possible_solution": "<string>"
              }
            ]
          }
        ]
      }
    },
    "additional_info": [
      "<string>"
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "The phone number \"+1abc\" is not in E.164 format.",
    "code": "invalid_phone_number",
    "doc_url": "https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number",
    "param": "from",
    "provider": {
      "source": "meta",
      "code": 123,
      "message": "<string>",
      "fbtrace_id": "<string>",
      "health_status": {
        "can_send_message": "AVAILABLE",
        "entities": [
          {
            "entity_type": "PHONE_NUMBER",
            "id": "<string>",
            "can_send_message": "AVAILABLE",
            "can_receive_call_sip": "AVAILABLE",
            "errors": [
              {
                "error_code": 123,
                "error_description": "<string>",
                "possible_solution": "<string>"
              }
            ]
          }
        ]
      }
    },
    "additional_info": [
      "<string>"
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "The phone number \"+1abc\" is not in E.164 format.",
    "code": "invalid_phone_number",
    "doc_url": "https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number",
    "param": "from",
    "provider": {
      "source": "meta",
      "code": 123,
      "message": "<string>",
      "fbtrace_id": "<string>",
      "health_status": {
        "can_send_message": "AVAILABLE",
        "entities": [
          {
            "entity_type": "PHONE_NUMBER",
            "id": "<string>",
            "can_send_message": "AVAILABLE",
            "can_receive_call_sip": "AVAILABLE",
            "errors": [
              {
                "error_code": 123,
                "error_description": "<string>",
                "possible_solution": "<string>"
              }
            ]
          }
        ]
      }
    },
    "additional_info": [
      "<string>"
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "The phone number \"+1abc\" is not in E.164 format.",
    "code": "invalid_phone_number",
    "doc_url": "https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number",
    "param": "from",
    "provider": {
      "source": "meta",
      "code": 123,
      "message": "<string>",
      "fbtrace_id": "<string>",
      "health_status": {
        "can_send_message": "AVAILABLE",
        "entities": [
          {
            "entity_type": "PHONE_NUMBER",
            "id": "<string>",
            "can_send_message": "AVAILABLE",
            "can_receive_call_sip": "AVAILABLE",
            "errors": [
              {
                "error_code": 123,
                "error_description": "<string>",
                "possible_solution": "<string>"
              }
            ]
          }
        ]
      }
    },
    "additional_info": [
      "<string>"
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "The phone number \"+1abc\" is not in E.164 format.",
    "code": "invalid_phone_number",
    "doc_url": "https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number",
    "param": "from",
    "provider": {
      "source": "meta",
      "code": 123,
      "message": "<string>",
      "fbtrace_id": "<string>",
      "health_status": {
        "can_send_message": "AVAILABLE",
        "entities": [
          {
            "entity_type": "PHONE_NUMBER",
            "id": "<string>",
            "can_send_message": "AVAILABLE",
            "can_receive_call_sip": "AVAILABLE",
            "errors": [
              {
                "error_code": 123,
                "error_description": "<string>",
                "possible_solution": "<string>"
              }
            ]
          }
        ]
      }
    },
    "additional_info": [
      "<string>"
    ]
  }
}

POST

messages

cURL

curl --request POST \
  --url https://api.buildwithchirp.com/v1/whatsapp/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "+15551234567",
  "to": "+15559876543",
  "type": "text",
  "replyTo": "msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI"
}
'

import requests

url = "https://api.buildwithchirp.com/v1/whatsapp/messages"

payload = {
    "from": "+15551234567",
    "to": "+15559876543",
    "type": "text",
    "replyTo": "msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    from: '+15551234567',
    to: '+15559876543',
    type: 'text',
    replyTo: 'msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI'
  })
};

fetch('https://api.buildwithchirp.com/v1/whatsapp/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.buildwithchirp.com/v1/whatsapp/messages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'from' => '+15551234567',
    'to' => '+15559876543',
    'type' => 'text',
    'replyTo' => 'msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.buildwithchirp.com/v1/whatsapp/messages"

	payload := strings.NewReader("{\n  \"from\": \"+15551234567\",\n  \"to\": \"+15559876543\",\n  \"type\": \"text\",\n  \"replyTo\": \"msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.buildwithchirp.com/v1/whatsapp/messages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"from\": \"+15551234567\",\n  \"to\": \"+15559876543\",\n  \"type\": \"text\",\n  \"replyTo\": \"msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.buildwithchirp.com/v1/whatsapp/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"from\": \"+15551234567\",\n  \"to\": \"+15559876543\",\n  \"type\": \"text\",\n  \"replyTo\": \"msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "from": "<string>",
  "to": "<string>",
  "type": "text",
  "status": "queued",
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "The phone number \"+1abc\" is not in E.164 format.",
    "code": "invalid_phone_number",
    "doc_url": "https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number",
    "param": "from",
    "provider": {
      "source": "meta",
      "code": 123,
      "message": "<string>",
      "fbtrace_id": "<string>",
      "health_status": {
        "can_send_message": "AVAILABLE",
        "entities": [
          {
            "entity_type": "PHONE_NUMBER",
            "id": "<string>",
            "can_send_message": "AVAILABLE",
            "can_receive_call_sip": "AVAILABLE",
            "errors": [
              {
                "error_code": 123,
                "error_description": "<string>",
                "possible_solution": "<string>"
              }
            ]
          }
        ]
      }
    },
    "additional_info": [
      "<string>"
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "The phone number \"+1abc\" is not in E.164 format.",
    "code": "invalid_phone_number",
    "doc_url": "https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number",
    "param": "from",
    "provider": {
      "source": "meta",
      "code": 123,
      "message": "<string>",
      "fbtrace_id": "<string>",
      "health_status": {
        "can_send_message": "AVAILABLE",
        "entities": [
          {
            "entity_type": "PHONE_NUMBER",
            "id": "<string>",
            "can_send_message": "AVAILABLE",
            "can_receive_call_sip": "AVAILABLE",
            "errors": [
              {
                "error_code": 123,
                "error_description": "<string>",
                "possible_solution": "<string>"
              }
            ]
          }
        ]
      }
    },
    "additional_info": [
      "<string>"
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "The phone number \"+1abc\" is not in E.164 format.",
    "code": "invalid_phone_number",
    "doc_url": "https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number",
    "param": "from",
    "provider": {
      "source": "meta",
      "code": 123,
      "message": "<string>",
      "fbtrace_id": "<string>",
      "health_status": {
        "can_send_message": "AVAILABLE",
        "entities": [
          {
            "entity_type": "PHONE_NUMBER",
            "id": "<string>",
            "can_send_message": "AVAILABLE",
            "can_receive_call_sip": "AVAILABLE",
            "errors": [
              {
                "error_code": 123,
                "error_description": "<string>",
                "possible_solution": "<string>"
              }
            ]
          }
        ]
      }
    },
    "additional_info": [
      "<string>"
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "The phone number \"+1abc\" is not in E.164 format.",
    "code": "invalid_phone_number",
    "doc_url": "https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number",
    "param": "from",
    "provider": {
      "source": "meta",
      "code": 123,
      "message": "<string>",
      "fbtrace_id": "<string>",
      "health_status": {
        "can_send_message": "AVAILABLE",
        "entities": [
          {
            "entity_type": "PHONE_NUMBER",
            "id": "<string>",
            "can_send_message": "AVAILABLE",
            "can_receive_call_sip": "AVAILABLE",
            "errors": [
              {
                "error_code": 123,
                "error_description": "<string>",
                "possible_solution": "<string>"
              }
            ]
          }
        ]
      }
    },
    "additional_info": [
      "<string>"
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "The phone number \"+1abc\" is not in E.164 format.",
    "code": "invalid_phone_number",
    "doc_url": "https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number",
    "param": "from",
    "provider": {
      "source": "meta",
      "code": 123,
      "message": "<string>",
      "fbtrace_id": "<string>",
      "health_status": {
        "can_send_message": "AVAILABLE",
        "entities": [
          {
            "entity_type": "PHONE_NUMBER",
            "id": "<string>",
            "can_send_message": "AVAILABLE",
            "can_receive_call_sip": "AVAILABLE",
            "errors": [
              {
                "error_code": 123,
                "error_description": "<string>",
                "possible_solution": "<string>"
              }
            ]
          }
        ]
      }
    },
    "additional_info": [
      "<string>"
    ]
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "message": "The phone number \"+1abc\" is not in E.164 format.",
    "code": "invalid_phone_number",
    "doc_url": "https://docs.buildwithchirp.com/api_reference/error-codes#invalid_phone_number",
    "param": "from",
    "provider": {
      "source": "meta",
      "code": 123,
      "message": "<string>",
      "fbtrace_id": "<string>",
      "health_status": {
        "can_send_message": "AVAILABLE",
        "entities": [
          {
            "entity_type": "PHONE_NUMBER",
            "id": "<string>",
            "can_send_message": "AVAILABLE",
            "can_receive_call_sip": "AVAILABLE",
            "errors": [
              {
                "error_code": 123,
                "error_description": "<string>",
                "possible_solution": "<string>"
              }
            ]
          }
        ]
      }
    },
    "additional_info": [
      "<string>"
    ]
  }
}

Authorizations

Authorization

string

header

required

App API key (format: sk_live_app_* or sk_test_app_*) for app-level operations

Body

application/json

from

string

required

WhatsApp phone number to send from (must be assigned to your app)

Example:

"+15551234567"

string

required

WhatsApp phone number to send to

Example:

"+15559876543"

type

enum<string>

required

Type of message to send

Available options:

text,

image,

video,

audio,

document,

sticker,

location,

contacts,

reaction,

template,

interactive

Example:

"text"

text

object

Text message content. Required when type is 'text'

Show child attributes

media

object

Media content. Required when type is 'image', 'video', 'audio', or 'document'. Media must be uploaded first via POST /v1/media.

Show child attributes

sticker

object

Sticker content. Required when type is 'sticker'. Stickers must be uploaded first via POST /v1/media.

Show child attributes

location

object

Location content. Required when type is 'location'

Show child attributes

contacts

object

Contacts content. Required when type is 'contacts'

Show child attributes

reaction

object

Reaction content. Required when type is 'reaction'. Reacts to an existing message with an emoji.

Show child attributes

template

object

Template content. Required when type is 'template'

Show child attributes

interactive

object

Interactive message content. Required when type is 'interactive'

Show child attributes

replyTo

string

Chirp message ID (msg_wa_) to reply to. Creates a contextual reply that displays the original message. Meta IDs (wamid.) are not accepted.

Minimum string length: 1

Example:

"msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Response

Message queued successfully

string

required

Unique identifier for a WhatsApp Message. Format: msg_wa_[test_]{ksuid}

Pattern: ^msg_wa_(?:test_)?[a-zA-Z0-9]{27}$

Example:

"msg_wa_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

from

string

required

string

required

type

enum<string>

required

Available options:

text,

image,

video,

audio,

document,

sticker,

location,

contacts,

reaction,

template,

interactive

status

enum<string>

required

Available options:

queued

timestamp

string<date-time>

required

API Reference

Application APIs

Administration APIs

Send WhatsApp Message

Authorizations

Body

Response