Skip to main content
GET
Retrieve Call

Authorizations

x-api-key
string
header
required

Your Beyond Presence API Key.

Path Parameters

id
string
required

Call ID.

Response

Requested Call

Response model for a call.

id
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.

status
ToStartCallStatus · object
required

Status for call that has not yet started.

user_name
string | null

Name of the user.

user_email
string | null

Email of the user.

tags
Tags · object

Tags for the call