Skip to main content
GET
An iMessage conversation represents a stateful session between an external phone number / Apple ID and an agent identity.

Query Parameters

string
Filter conversations by specific agent identity ID or handle.
string
Filter conversations by status: active, disconnected, or expired.
integer
default:"50"
Maximum number of conversations to return (1–100).
string
Opaque cursor for pagination.

Response Fields

array
List of iMessage conversation objects.
string
Cursor for retrieving the next page of results, or null if at the end.

Disconnecting a Conversation

To explicitly terminate an active conversation session and end routing to the agent: