Skip to main content
POST
/
messages
Send a message
curl --request POST \
  --url https://api.example.com/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "text",
  "to": "<string>",
  "text": "<string>"
}
'
import requests

url = "https://api.example.com/messages"

payload = {
"type": "text",
"to": "<string>",
"text": "<string>"
}
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({type: 'text', to: '<string>', text: '<string>'})
};

fetch('https://api.example.com/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.example.com/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([
'type' => 'text',
'to' => '<string>',
'text' => '<string>'
]),
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.example.com/messages"

payload := strings.NewReader("{\n \"type\": \"text\",\n \"to\": \"<string>\",\n \"text\": \"<string>\"\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.example.com/messages")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"text\",\n \"to\": \"<string>\",\n \"text\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/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 \"type\": \"text\",\n \"to\": \"<string>\",\n \"text\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "message": {
      "id": "68505cb92a11ea971d9df894",
      "providerId": "wamid.HBgLMTIzNDU2Nzg5FQIAERgSMzQ1Q0Y5QkE=",
      "contact": "68505cb92a11ea971d9df894",
      "content": "Hello! How can I help?",
      "role": "assistant",
      "status": "unsent",
      "error": "Rate limit exceeded"
    }
  }
}
{
"error": "Validation failed",
"details": {
"body.text": "Text is required"
}
}
{
"error": "contact_not_found"
}
{
"error": "something_went_wrong"
}

Authorizations

Authorization
string
header
required

Use Authorization: Bearer <api_key>.

Body

application/json
type
enum<string>
required
Available options:
text
to
string
required

Conversation/contact ID.

Minimum string length: 1
text
string
required

Message text.

Minimum string length: 1

Response

Message sent

data
object
required