GET
/
deployments
/
{deployment_id}
/
calls
List Deployment 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<uuid>
required

ID of the deployment

Query Parameters

​
started_after
string<date-time>

Filter calls that started after this timestamp

​
ended_before
string<date-time>

Filter calls that ended before this timestamp

​
scheduled_after
string<date-time>

Filter calls scheduled after this timestamp

​
scheduled_before
string<date-time>

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

The response is of type object.