Get a call

{
  "id": "call_00000000-0000-0000-0000-000000000000",
  "status": "SCHEDULED",
  "call_time": "2024-01-15T09:30:00Z",
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "call_direction": "INBOUND",
  "phone_number": "string",
  "to_number": "string",
  "from_number": "string",
  "call_start_time": "2024-01-15T09:30:00Z",
  "call_end_time": "2024-01-15T09:30:00Z",
  "call_type": "string",
  "load_id": "load_00000000-0000-0000-0000-000000000000",
  "organization_id": "org_00000000-0000-0000-0000-000000000000",
  "created_by_id": "usr_00000000-0000-0000-0000-000000000000",
  "recording_status": "string",
  "load_number": "string"
}

Get details for a specific phone call.

Authentication: Supports API key and bearer token authentication.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

call_idstringRequiredformat: "uuid"

Response

Successful Response

idstringformat: "^call_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

statusenum

call_timedatetime

created_atdatetime

updated_atdatetime

call_directionenum or nullOptional

phone_numberstring or nullOptional

Customer phone number (derived from direction)

to_numberstring or nullOptional

from_numberstring or nullOptional

call_start_timedatetime or nullOptional

call_end_timedatetime or nullOptional

call_typestring or nullOptional

load_idstringOptionalformat: "^load_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

organization_idstringOptionalformat: "^org_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

created_by_idstringOptionalformat: "^usr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"

recording_statusstring or nullOptional

load_numberstring or nullOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

$	curl https://tryenvoy.ai/api/v1/calls/call_id \
>	-H "Authorization: Bearer <token>"

Authentication

Path parameters

Headers

Response

Errors