Send a WhatsApp template message | Voicebip

Sends a pre-approved WhatsApp template message. Templates must be approved by Meta before use. Use this to initiate conversations outside the 24-hour window.

As with POST /v1/messages, the status field is sent (synchronous) or queued when the send is accepted onto the carrier-safe priority lane (paced within the sender’s daily conversation cap). A queued template is sent as soon as there is headroom; track delivery via message.* webhooks.

Sends a pre-approved WhatsApp template message. Templates must be approved by Meta before use. Use this to initiate conversations outside the 24-hour window. As with `POST /v1/messages`, the `status` field is `sent` (synchronous) or `queued` when the send is accepted onto the carrier-safe priority lane (paced within the sender's daily conversation cap). A `queued` template is sent as soon as there is headroom; track delivery via `message.*` webhooks.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

agent_idstringRequired

from_numberstringRequired

to_numberstringRequired

template_namestringRequired

language_codestringOptionalDefaults to en

parameterslist of stringsOptional

Response

Template message queued

message_idstring

conversation_idstring

agent_idstring

channelenum

directionenum

from_numberstring

to_numberstring

bodystring

statusenum

segmentsinteger

Number of SMS segments the message was split into. Populated for SMS channel only; null for WhatsApp.

created_atdatetime

is_sandboxboolean

True when the message was created with a pk_test_ (sandbox) API key. Omitted when false.

Errors

400

Send Template Request Bad Request Error

$	curl -X POST https://api.voicebip.com/v1/messages/template \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"agent_id": "agent_id",
>	"from_number": "from_number",
>	"to_number": "to_number",
>	"template_name": "template_name"
>	}'

1	{
2	"message_id": "message_id",
3	"conversation_id": "conversation_id",
4	"agent_id": "agent_id",
5	"channel": "sms",
6	"direction": "inbound",
7	"from_number": "from_number",
8	"to_number": "to_number",
9	"body": "body",
10	"status": "queued",
11	"segments": 1,
12	"created_at": "2024-01-15T09:30:00Z",
13	"is_sandbox": true
14	}