Get a single message | Voicebip

Returns one message by id, scoped to your workspace. Used by the dashboard’s campaign recipient drill-down (an SMS/WhatsApp recipient’s latest send links here). A message that belongs to another workspace is indistinguishable from one that does not exist — both return 404.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

Message details

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

404

Get Message Request Not Found Error

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	}