Sign in

v2

latestOpenAPI 3.1.02026-07-313981108.2 KB
Calls

Get Call

Get Call By ID. This API will return the call details along with the messages.

get/calls/v1/conversations/{id}

Path parameters

idstring required

Unique identifier of the call

Response

Successful response

idstring

Unique identifier of the call

teamIdstring

Unique identifier of the team

assistantIdstring

Unique identifier of the assistant

callType'web' | 'phone'

This is the type of the call.

direction'inbound' | 'outbound'
startAtstring date-time

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

endAtstring date-time

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

userNumberstring

Phone number of the user

assistantNumberstring

Phone number of the assistant

status'queued' | 'ongoing' | 'forwarded' | 'finished'

This field indicates the status of the call.

phoneCallStatus'trying' | 'early-media' | 'ringing' | 'in-progress' | 'busy' | 'no-answer' | 'failed' | 'completed'

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.
callEndTriggerBy'user' | 'assistant'

This is the trigger of the call end.

Example response

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