Retrieve Call

curl --request GET \
  --url https://api.example.com/v1/calls/{id} \
  --header 'x-api-key: <api-key>'

{
  "id": "<string>",
  "agent_id": "<string>",
  "started_at": "<string>",
  "ended_at": "<string>",
  "tags": {}
}

GET

calls

{id}

Retrieve Call

curl --request GET \
  --url https://api.example.com/v1/calls/{id} \
  --header 'x-api-key: <api-key>'

{
  "id": "<string>",
  "agent_id": "<string>",
  "started_at": "<string>",
  "ended_at": "<string>",
  "tags": {}
}

x-api-key

string

header

required

Your Beyond Presence API Key.

string

required

Call ID.

Requested Call

Response model for a call.

string

required

Unique identifier of the object in the database.

Example:

"01234567-89ab-cdef-0123-456789abcdef"

agent_id

string

required

ID of agent managing the call.

started_at

string

required

Start time in ISO 8601 format.

ended_at

string | null

required

End time in ISO 8601 format. If null, call might still be ongoing.

Documentation Index