Send a message (SMS or WhatsApp)

POST

/v1/messages

Sends an SMS or free-form WhatsApp message. Returns 201 with the Message object; you track delivery via the message.* webhooks you already receive.

The status field reflects how the send was handled:

sent — handed to the carrier/provider synchronously (default).
queued — accepted onto the carrier-safe priority lane (the platform paces sends within per-carrier limits) and sent as soon as there is headroom. SMS uses this paced path; WhatsApp free-form sends are always synchronous. The returned message_id is the id the message is sent under, but a queued message is briefly un-queryable via GET /v1/messages/{message_id} until it dispatches (sub-second), and its conversation_id is assigned then.

Sends an SMS or free-form WhatsApp message. Returns `201` with the `Message` object; you track delivery via the `message.*` webhooks you already receive. The `status` field reflects how the send was handled: - `sent` — handed to the carrier/provider synchronously (default). - `queued` — accepted onto the carrier-safe priority lane (the platform paces sends within per-carrier limits) and sent as soon as there is headroom. SMS uses this paced path; WhatsApp free-form sends are always synchronous. The returned `message_id` is the id the message is sent under, but a `queued` message is briefly un-queryable via `GET /v1/messages/{message_id}` until it dispatches (sub-second), and its `conversation_id` is assigned then.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

agent_idstringRequired

channelenumRequired

Allowed values:

from_numberstringRequired

to_numberstringRequired

bodystringRequired

phone_number_idstringOptional

WhatsApp business phone number ID (required for WhatsApp channel)

message_typeenumOptionalDefaults to text

Message type. Defaults to text for SMS.

media_urlstringOptional

URL to media file (required for non-text message_type)

media_captionstringOptional

Optional caption for images and videos

Response

Message accepted. status is sent (synchronous) or queued (accepted onto the paced priority lane — delivery via message.* webhooks).

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.

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

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	}