Sign in

v64

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01176310978.7 KB
sessions

Get A Single Session By Id

get/api/v1/sessions/{session_id}

Path parameters

session_idstring required

Response

Successful Response

timestampstring date-time required

Timestamp of the session

session_idstring nullable

Internal ID of the session, generated based on interaction details

conversation_idstring nullable

ID of the conversation of which the session is a part

channel_manager_servicestring nullable

Name of the service used to facilitate the session

channel_manager_typestring nullable

Type of the service used to facilitate the session

channel_manager_sidstring nullable

Channel-manager-side ID of the session (different from session_id)

agent_idstring nullable

ID of the agent with which the session occurred

agent_namestring nullable

Name of the agent with which the session occurred

agent_typestring nullable

Type of the agent with which the session occurred

agent_timezonestring nullable

Timezone of the agent with which the session occurred

prompt_idstring nullable

ID of the prompt used by the agent with which the session occurred

prompt_namestring nullable

Name of the prompt used by the agent with which the session occurred

prompt_versionstring nullable

Legacy prompt version timestamp used by the agent with which the session occurred

prompt_version_numberinteger nullable

Prompt version number used by the agent with which the session occurred (new system)

durationnumber nullable

Duration of the session in seconds

session_label_idstring nullable

ID of the label (listing the quality of the session and any issues that occurred) associated with the session

sourcestring nullable

Source of the session (e.g., for an inbound session, the user's phone number/username/email)

targetstring nullable

The name of the channel target associated with the agent at the time of the session (see ChannelTargetResponse.target)

is_legacyboolean nullable

Whether the session occurred on the legacy Syllable system

is_testboolean nullable

Whether the session is a test session

is_outboundboolean nullable

Whether the session direction is outbound (true) or inbound (false).

user_terminatedboolean nullable

Whether the voice session was ended by the recipient (outbound) / caller (inbound). False if the user was transferred or there was an error. Unset if the session was not a voice session.

transfer_voicemail_detectedboolean nullable

Whether a voicemail was detected during the transfer leg of the session

Example response

{
  "channel_manager_service": "hedy",
  "channel_manager_type": "voice_sip_v1",
  "source": "+18042221111"
}