Send a voice_call interactive message button

Sends a ‘Call on WhatsApp’ button. Only works during an open CSW (24h window). Requires WhatsApp 2.24.1+.

POST/v1/calls/voice-call-button

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

body_textstringrequired

Message body text

min length 1

channel_idstringrequired

Channel ID

min length 1

conversation_idstring

Inbox conversation ID — when set, message is stored in transcript

display_textstring

Button display text (max 20 chars, default 'Call Now')

max length 20

payloadstring

Tracking payload (max 512 chars, echoed as cta_payload)

max length 512

tostringrequired

Recipient phone number

min length 1

ttl_minutesinteger<int64>

Button TTL in minutes (1-43200, default 10080 = 7 days)

min 1 · max 43200

Responses

200OK

statusstringrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/calls/voice-call-button" \
  -H "Content-Type: application/json" \
  -d '{
  "body_text": "string",
  "channel_id": "string",
  "conversation_id": "string",
  "display_text": "string",
  "payload": "string",
  "to": "string",
  "ttl_minutes": 0
}'

const response = await fetch("/v1/calls/voice-call-button", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "body_text": "string",
  "channel_id": "string",
  "conversation_id": "string",
  "display_text": "string",
  "payload": "string",
  "to": "string",
  "ttl_minutes": 0
})
});

import requests

response = requests.post(
    "/v1/calls/voice-call-button",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "body_text": "string",
  "channel_id": "string",
  "conversation_id": "string",
  "display_text": "string",
  "payload": "string",
  "to": "string",
  "ttl_minutes": 0
},
)

Response

{
  "status": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}