STstuut
sms

List Sms Conversations

List SMS Conversations

Returns a paginated list of SMS conversations, each the messages exchanged between one organization number and one customer number, summarized by the latest message. Drafts are excluded. List a conversation's messages with /sms/messages/{latest_message_id}/conversation.

get/v2/sms/conversations

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number, 0 indexed.

limitinteger

Number of records per page.

sort_by'latest_message_at' | 'partner_name'
sort_order'asc' | 'desc'
partner_id__instring[] nullable

Filter to conversations with any message of the partners, or whose customer number is a partner's or one of its contacts' phone.

assignee_id__instring[] nullable

Filter by the assignee of the conversation's latest message's partner.

business_unit_id__instring[] nullable

Filter by business unit IDs.

searchstring nullable

Search the partner name, or any message body when the organization does not vault SMS.

Response

Successful Response

current_pageinteger required

The current page.

total_recordsinteger nullable required

Total number of records.

next_pageinteger nullable required

The next page number, if one exists.

Changes

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