Sign in
iMessage

List Messages

get/api/v1/imessage/messages

Query parameters

agent_identity_idstring uuid nullable
conversation_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.

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.

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.

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
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

No recorded changes to this endpoint across all 1 revision of this API.