Get a single message

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_idstringOptional
conversation_idstringOptional
agent_idstringOptional
channelenumOptional
directionenumOptional
from_numberstringOptional
to_numberstringOptional
bodystringOptional
statusenumOptional
segmentsintegerOptional

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

created_atdatetimeOptional
is_sandboxbooleanOptional

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

Errors

404
Get Message Request Not Found Error