INinteractly
Calls

List Calls

Changed on

This API will return the list of calls based on the filter criteria.

get/calls/v1/conversations

Request

  • Base URL
    https://api-qa.interactly.ai
  • URL
    https://api-qa.interactly.ai/calls/v1/conversations
  • Auth
    HTTP bearer

Query parameters

startDatestring date-time required
Example:2024-11-01T00:00:00.000Z

Filter the calls by start date. The date should be in ISO 8601 format, Ex: 2024-11-01T00:00:00.000Z

endDatestring date-time required
Example:2024-11-30T23:59:59.999Z

Filter the calls by end date. The date should be in ISO 8601 format, Ex: 2024-11-30T23:59:59.999Z

pageinteger
Example:1

To see the calls list of a particular page number.

sizeinteger
Example:10

Number of calls per page.

sort'startAt' | 'endAt' | 'status' | 'conversationId'
Example:startAt

Sort the calls by a field

mode'assist' | 'all'

assist lists only Agent Assist calls (a staff member on the call, coached by an assistant). all or omitted lists every call.

placedBy'me'

me lists only the Agent Assist calls the requesting team member placed. Omitted lists every team member's calls.

Response

Successful response

totalCountinteger

Total number of calls without applying pagination.

Example response

{
  "totalCount": 10,
  "conversations": [
    {
      "id": "a12f9c88-c155-461f-9771-4d240cdc9a04",
      "teamId": "1f7b1b1b1b1b1b1b1b1b1b1b",
      "assistantId": "3f7b1b1b1b1b1b1b1b1b1b1b",
      "callType": "web",
      "direction": "inbound",
      "startAt": "2020-10-05T00:00:00.000Z",
      "endAt": "2020-10-05T00:00:00.000Z",
      "userNumber": "+919867543210",
      "assistantNumber": "+19867543211",
      "status": "finished",
      "phoneCallStatus": "ringing",
      "callEndTriggerBy": "user",
      "monitor": {
        "controlUrl": "https://<domain>.interactly.ai/calls/v1/conversations/<random-id>/control"
      },
      "analysis": {
        "summary": "The user called Dentistry to schedule an appointment.",
        "successEvaluation": "success",
        "structuredData": {}
      },
      "postCallTranscript": {
        "provider": "deepgram",
        "model": "nova-3",
        "language": "en"
      }
    }
  ]
}

Changes

  • 9e52e60736bbRevision changes
    • info

      added the new optional query request parameter mode

    • info

      added the new optional query request parameter placedBy

    • info

      added the optional property // to the response with the status