Sign in
Conversation

List conversations

Retrieve a paginated list of conversations for the authenticated subscriber

get/v1/conversation

Query parameters

createdAfterstring

Only include conversations created on or after this date

createdBeforestring

Only include conversations created on or before this date

channel'voice' | 'chat' | 'email' | 'sms' | 'whatsapp'
cursorstring

Opaque cursor for the next page of results

limitnumber

Maximum number of conversations to return. Defaults to 50.

Response

nextCursorobject nullable required

Cursor for the next page of results, if available

Example response

{
  "conversations": [
    {
      "createdAt": "2024-01-15T10:00:00Z",
      "updatedAt": "2024-01-15T10:05:00Z",
      "transcript": "Customer at Mon, 01 Jan 2024 10:00:00 GMT:\nHello, I need help\n\nAgent at Mon, 01 Jan 2024 10:01:00 GMT:\nHow can I assist you?",
      "customAttributes": {
        "attribute1": true,
        "attribute2": "AGENT"
      },
      "callRecordingLink": "https://example.com/call-recording.mp4",
      "callDuration": 120000,
      "summary": "This is a summary of the conversation. This field is asynchronously generated after the conversation ends.",
      "customer": {
        "email": "john.doe@example.com",
        "name": "John Doe",
        "phoneNumber": "+61400000000"
      },
      "tags": [
        "refund",
        "escalated"
      ],
      "csatScore": 4
    }
  ]
}

Changes