Skip to main content
GET
cURL

Authorizations

​
X-Auth-ID
string
header
required

Your Vobiz account Auth ID (MA_XXXXXXXX).

​
X-Auth-Token
string
header
required

Your Vobiz account Auth Token.

Path Parameters

​
id
string<uuid>
required

The conversation id (UUID), from GET /conversations or the conversationId on any message.

Query Parameters

​
limit
integer
default:50

Maximum number of messages to return, from 1 to 100. Defaults to 50; a value outside that range also returns 50.

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of messages to skip before the page starts, 0 or greater. Defaults to 0. Add the page size to it to load older messages.

Required range: x >= 0

Response

A page of messages.

​
id
string<uuid>

Unique identifier of the message (UUID). Use it with GET /messages/{id} and to match status events.

Example:

"9b2e1c40-8a3d-4f5e-9c1a-7d6b2e8f4a01"

​
accountId
string

Your Vobiz account ID (Auth ID), for example MA_XXXXXXXX.

Example:

"MA_XXXXXXXX"

​
direction
enum<string>

out for a message you sent, in for a message one of your numbers received.

Available options:
out,
in
​
channel
enum<string>

Channel the message actually used: sms, mms or rcs. It can differ from the one you requested, for example mms after an SMS with media to US or Canadian numbers, or sms after an RCS send fell back with failoverToSms.

Available options:
sms,
mms,
rcs
​
from
string

Sender. For outbound messages, your number in E.164 format or the senderName of your RCS sender; for inbound messages, the contact's number.

Example:

"+14155550100"

​
to
string

Recipient. For outbound messages, the contact's number in E.164 format; for inbound messages, your number.

Example:

"+14155550123"

​
text
string

Message body. An empty string when the message has no text, for example an MMS with media only.

Example:

"Your verification code is 482913"

​
mediaUrls
string<uri>[] | null

HTTPS URLs of the media attached to the message. null or an empty array when there is no media.

​
status
enum<string>

Where the message is in its lifecycle: scheduled (held for scheduledAt), sent (handed to the network), delivered (delivery confirmed), failed (see errorCode and errorMessage), received (inbound) or unknown (the network reported a status that maps to none of the others).

Available options:
scheduled,
sent,
delivered,
failed,
received,
unknown
​
errorCode
string

Error code reported for a failed message. Omitted when there is no error.

​
errorMessage
string

Human-readable reason a message failed. Omitted when there is no error; quote it to support when you need help with a failure.

​
tag
string

The label you set when sending, for filtering and reporting. Omitted when none was set.

​
conversationId
string<uuid>

UUID of the conversation the message belongs to. Use it with GET /conversations/{id}/messages to load the thread.

​
scheduledAt
string<date-time>

The time you asked the message to be held until (ISO 8601, UTC). Omitted for messages that were not scheduled.

​
createdAt
string<date-time>

When the message was created, as an RFC 3339 / ISO 8601 timestamp in UTC.

Example:

"2026-10-12T10:30:00Z"

​
updatedAt
string<date-time>

When the message last changed, for example on a status update (ISO 8601, UTC).

Example:

"2026-10-12T10:30:00Z"