List Calls

List Calls

curl --request GET \
  --url https://api-prod.interactly.ai/calls/v1/conversations \
  --header 'Authorization: Bearer <token>'

{
  "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": {}
      }
    }
  ]
}

GET

calls

conversations

List Calls

curl --request GET \
  --url https://api-prod.interactly.ai/calls/v1/conversations \
  --header 'Authorization: Bearer <token>'

{
  "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": {}
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Retrieve your API Key from Dashboard API Keys Section.

Query Parameters

startDate

string<date-time>

required

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

Example:

"2024-11-01T00:00:00.000Z"

endDate

string<date-time>

required

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

Example:

"2024-11-30T23:59:59.999Z"

page

integer

default:1

To see the calls list of a particular page number.

Example:

1

size

integer

default:10

Number of calls per page.

Example:

10

sort

enum<string>

default:startAt

Sort the calls by a field

Available options:

startAt,

endAt,

status,

conversationId

Example:

"startAt"

Response

200 - application/json

Successful response

totalCount

integer

Total number of calls without applying pagination.

Example:

10

conversations

object[]

Show child attributes

conversations.id

string

Unique identifier of the call

Example:

"a12f9c88-c155-461f-9771-4d240cdc9a04"

conversations.teamId

string

Unique identifier of the team

Example:

"1f7b1b1b1b1b1b1b1b1b1b1b"

conversations.assistantId

string

Unique identifier of the assistant

Example:

"3f7b1b1b1b1b1b1b1b1b1b1b"

conversations.callType

enum<string>

This is the type of the call.

Available options:

web,

phone

Example:

"web"

conversations.direction

enum<string>

Available options:

inbound,

outbound

Example:

"inbound"

conversations.startAt

string<date-time>

This is the ISO 8601 date-time string indicating when the record was initiated.

Example:

"2020-10-05T00:00:00.000Z"

conversations.endAt

string<date-time>

This is the ISO 8601 date-time string of when the record was ended.

Example:

"2020-10-05T00:00:00.000Z"

conversations.userNumber

string

Phone number of the user

Example:

"+919867543210"

conversations.assistantNumber

string

Phone number of the assistant

Example:

"+19867543211"

conversations.status

enum<string>

This field indicates the status of the call.

Available options:

queued,

ongoing,

forwarded,

finished

Example:

"finished"

conversations.phoneCallStatus

enum<string>

Status of the phone call.

A call can have one of the following statuses:

trying: The call has been initiated.
early-media: The call is playing an early media message or tone.
ringing: The recipient's phone is ringing.
in-progress: The call is currently active.
busy: The recipient is unavailable to answer.
no-answer: The call was not answered.
failed: The call attempt was unsuccessful.
completed: The call has ended.

Available options:

trying,

early-media,

ringing,

in-progress,

busy,

no-answer,

failed,

completed

Example:

"ringing"

conversations.callEndTriggerBy

enum<string>

This is the trigger of the call end.

Available options:

user,

assistant

Example:

"user"

conversations.monitor

object

To monitor and control the conversation

Show child attributes

conversations.monitor.controlUrl

string

The URL to control the conversation

Example:

"https://<domain>.interactly.ai/calls/v1/conversations/<random-id>/control"

conversations.analysis

object

Show child attributes

conversations.analysis.summary

string

This is the summary of the call. Customize by setting assistant.analysis.summary.

Example:

"The user called Dentistry to schedule an appointment."

conversations.analysis.successEvaluation

string

This is the evaluation of the call. Customize by setting assistant.analysis.successEvaluation.prompt and/or assistant.analysis.successEvaluation.rubric.

Example:

"success"

conversations.analysis.structuredData

object

This is the structured data extracted from the call. Customize by setting assistant.analysis.structuredData.promptand/or assistant.analysisPlan.structuredData.schema.

Example:

{}

API Keys Create Call

⌘I

Getting Started

APIs

Campaigns

Authorizations

Query Parameters

Response