Components
Session
A session is a building block of a conversation.
Example Usage
Fields
Field | Type | Required | Description | Example |
---|---|---|---|---|
timestamp | Date | TRUE | Timestamp of the session | |
sessionId | string | FALSE | Internal ID of the session, generated based on interaction details | |
conversationId | string | FALSE | ID of the conversation of which the session is a part | |
channelManagerService | string | FALSE | Name of the service used to facilitate the session | hedy |
channelManagerType | string | FALSE | Type of the service used to facilitate the session | voice_sip_v1 |
channelManagerSid | string | FALSE | Channel-manager-side ID of the session (different from session_id) | |
agentId | string | FALSE | ID of the agent with which the session occurred | |
agentName | string | FALSE | Name of the agent with which the session occurred | |
agentType | string | FALSE | Type of the agent with which the session occurred | |
agentTimezone | string | FALSE | Timezone of the agent with which the session occurred | |
promptId | string | FALSE | ID of the prompt used by the agent with which the session occurred | |
promptName | string | FALSE | Name of the prompt used by the agent with which the session occurred | |
promptVersion | string | FALSE | Version of the prompt used by the agent with which the session occurred | |
duration | number | FALSE | Duration of the session in seconds | |
sessionLabelId | string | FALSE | ID of the label (listing the quality of the session and any issues that occurred) associated with the session | |
source | string | FALSE | Source of the session (e.g., for an inbound session, the user’s phone number/username/email) | +18042221111 |
target | string | FALSE | The name of the channel target associated with the agent at the time of the session (see ChannelTargetResponse.target) | |
isLegacy | boolean | FALSE | Whether the session occurred on the legacy Syllable system | |
isTest | boolean | FALSE | Whether the session is a test session |