List Deployment Calls

GET

deployments

{deployment_id}

calls

curl --request GET \
  --url https://web.inquira.app/api/v1/deployments/{deployment_id}/calls \
  --header 'x-api-key: <api-key>'

{
  "calls": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "scheduled_for": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "to_phone_number": "<string>",
      "end_reason": "user_rejected",
      "scheduling_status": "success",
      "transcript": [
        {
          "role": "assistant",
          "content": "Hello, how can I help you today?",
          "tools": null
        },
        {
          "role": "user",
          "content": "I'd like to schedule an appointment.",
          "tools": null
        }
      ],
      "ai_collectors": [
        "<any>"
      ],
      "ai_analysers": [
        "<any>"
      ]
    }
  ],
  "total_count": 123,
  "page": 123,
  "per_page": 123
}

Authorizations

x-api-key

string

header

required

API key for authentication

Path Parameters

deployment_id

string

required

ID of the deployment

Query Parameters

started_after

string

Filter calls that started after this timestamp

ended_before

string

Filter calls that ended before this timestamp

scheduled_after

string

Filter calls scheduled after this timestamp

scheduled_before

string

Filter calls scheduled before this timestamp

end_reason

enum<string>

Defines the reason why a call ended.

Available options:

user_rejected,

user_unavailable,

normal

schedule_status

enum<string>

Defines the scheduling status of a call.

Available options:

success,

in_progress,

failed,

cancelled

page

string

default:1

Page number

per_page

string

default:10

Items per page

Response

200

application/json

List of calls for the deployment

calls

object[]

required

Array of call records

calls.id

string

required

Unique identifier for the call

calls.scheduled_for

string | null

required

ISO timestamp for when the call was scheduled

calls.started_at

string | null

required

ISO timestamp when the call started

calls.ended_at

string | null

required

ISO timestamp when the call ended

calls.to_phone_number

string

required

Phone number in E.164 format that received the call

calls.end_reason

enum<string> | null

required

Reason why the call ended. Always normal for inbound calls

Available options:

user_rejected,

user_unavailable,

normal

calls.scheduling_status

enum<string> | null

required

Status of the call scheduling. Always null for inbound calls.

Available options:

success,

in_progress,

failed,

cancelled

calls.transcript

object[] | null

required

Call transcript

Example:

[
  {
    "role": "assistant",
    "content": "Hello, how can I help you today?",
    "tools": null
  },
  {
    "role": "user",
    "content": "I'd like to schedule an appointment.",
    "tools": null
  }
]

calls.ai_collectors

any[] | null

required

Data collected during the call

calls.ai_analysers

any[] | null

required

AI analysis results

total_count

number

required

Total number of calls

page

number

required

Current page number

per_page

number

required

Number of items per page

Get Deployment Details Add Users To Deployment

curl --request GET \
  --url https://web.inquira.app/api/v1/deployments/{deployment_id}/calls \
  --header 'x-api-key: <api-key>'

{
  "calls": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "scheduled_for": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "to_phone_number": "<string>",
      "end_reason": "user_rejected",
      "scheduling_status": "success",
      "transcript": [
        {
          "role": "assistant",
          "content": "Hello, how can I help you today?",
          "tools": null
        },
        {
          "role": "user",
          "content": "I'd like to schedule an appointment.",
          "tools": null
        }
      ],
      "ai_collectors": [
        "<any>"
      ],
      "ai_analysers": [
        "<any>"
      ]
    }
  ],
  "total_count": 123,
  "page": 123,
  "per_page": 123
}

API Documentation

Deployments

Workflows

Authorizations

Path Parameters

Query Parameters

Response