INinkbox
Text Messages

List Texts

get/api/v1/phone/numbers/{phone_number_id}/texts

Request

Path parameters

phone_number_idstring uuid required

Query parameters

limitinteger
offsetinteger
is_readboolean nullable

Filter by read state: true for read, false for unread, omit for all.

is_blockedboolean nullable

Filter by blocked state: true for only blocked, false for only non-blocked, omit for all. Agent-scoped callers never see blocked rows regardless of this filter.

start_datetimestring nullable

Filter created_at >= this date/datetime. Bare date => whole day in tz.

end_datetimestring nullable

Filter created_at <= this date/datetime. Bare date => whole day inclusive.

tzstring nullable

IANA zone (e.g. America/New_York) for zone-less values; default UTC.

Response

Successful Response

idstring uuid required
direction'inbound' | 'outbound' required
local_phone_numberstring required
remote_phone_numberstring nullable
textstring nullable required
type'sms' | 'mms' required
is_readboolean required
delivery_status'queued' | 'sent' | 'delivered' | 'delivery_failed' | 'delivery_unconfirmed' | 'sending_failed' | 'blocked_spam_filter'
origin'user_initiated' | 'auto_reply'
error_codestring nullable
error_detailstring nullable
sent_atstring date-time nullable
delivered_atstring date-time nullable
failed_atstring date-time nullable
conversation_idstring uuid nullable
sender_phone_numberstring nullable
is_blockedboolean
created_atstring date-time required
updated_atstring date-time required

Changes

No operation changes recorded.