Skip to main content
GET
List conversations with cursor pagination

Autorizaciones

Authorization
string
header
requerido

Server-side tenant-scoped credential created from Build > API Keys.

Parámetros de consulta

limit
integer
predeterminado:50
Rango requerido: 1 <= x <= 200
cursor
string

Opaque nextCursor from the previous conversation-list response. Omit for the first page. Keep filters unchanged.

Maximum string length: 2048
view
enum<string>
predeterminado:all
Opciones disponibles:
all,
needs_reply,
handoff
replyState
enum<string>
predeterminado:all
Opciones disponibles:
all,
failed
policyStatus
enum<string>
predeterminado:all
Opciones disponibles:
all,
active,
archived,
blocked
responseMode
enum<string>
predeterminado:all
Opciones disponibles:
all,
ai,
manual,
frozen
optedOut
boolean

Filter conversations by the current contact opt-out state.

contactQuery
string
Required string length: 2 - 200
channel
enum<string>
Opciones disponibles:
all,
whatsapp,
instagram,
messenger,
webchat
owner
string
Maximum string length: 24
Pattern: ^(all|[a-fA-F0-9]{24})$

Respuesta

Conversation page with hasMore and optional nextCursor

conversations
object[]
requerido
needsReplyCount
integer
requerido
handoffCount
integer
requerido
hasMore
boolean
requerido
asOf
string<date-time>
requerido
version
integer
requerido
liveWindow
object
requerido
nextCursor
string