INinkbox
iMessage

List Messages

Changed on
get/api/v1/imessage/messages

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/imessage/messages
  • Auth
    • HTTP bearer
    • or API key in header X-API-Key

Query parameters

agent_identity_idstring uuid nullable
conversation_idstring uuid nullable
thread_idstring uuid nullable
include_groupsboolean
limitinteger
offsetinteger
is_readboolean nullable
is_blockedboolean nullable
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

provider_message_handlestring nullable
idstring uuid required
conversation_idstring uuid required
assignment_idstring uuid nullable required
reply_to_message_idstring uuid nullable

Visible native reply target, when resolved. Null does not prove the message is not a reply.

thread_idstring uuid nullable

Thread identifier when resolved, including standalone messages; does not imply replies exist.

thread_root_message_idstring uuid nullable

Visible thread root when resolved; a standalone message is its own root.

direction'inbound' | 'outbound' required
remote_numberstring nullable required
sender_numberstring nullable
participantsstring[] nullable
is_groupboolean
contentstring nullable
message_type'message' | 'carousel' required
service'imessage' | 'sms' | 'rcs' required
send_style'celebration' | 'shooting_star' | 'fireworks' | 'lasers' | 'love' | 'confetti' | 'balloons' | 'spotlight' | 'echo' | 'invisible' | 'gentle' | 'loud' | 'slam'
was_downgradedboolean nullable
status'registered' | 'pending' | 'queued' | 'accepted' | 'sent' | 'delivered' | 'declined' | 'error' | 'received'
error_codestring nullable
error_messagestring nullable
error_reasonstring nullable
error_detailstring nullable
is_readboolean required
is_blockedboolean
created_atstring date-time required
updated_atstring date-time required

Changes

  • 5cbaa42f14f7Revision changes
    • info

      added the new optional query request parameter thread_id

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status