INinkbox
Text Messages

Search Texts

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

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/phone/numbers/{phone_number_id}/texts/search
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Path parameters

phone_number_idstring uuid required

Query parameters

qstring required
limitinteger
is_blockedboolean nullable

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 recorded changes to this operation across all 38 revisions of this API.