get https://api.talkdeskapp.com/conversations/interactions
Retrieves all interactions between a seven day interval, filtered according to the account id contained in the JWT token. The result list is paginated using a cursor.
Scope
interactions-public:read
Body Response - Schema
200 (successfully retrieved the interactions)
Paginated response with interactions containing the matched time period
| Parameter | Type | Description | Required |
|---|---|---|---|
| _embedded | object | Embedded object of a paginated response. Subdivides into: 1 - interactions (array[object]) 1.1 - id (string). The ID of the interaction. Example: 597a2201-9d7e-470e-a699-abc5ec114973 1.2 - customer_id (string). The ID of the customer. Example: e7a89c2e-4257-4e38-81f1-854dd94d6574. Required. 1.3 - started_at (string ). The datetime when the interaction started. Example: 2020-03-10T00:00:00.000000Z. Required. 1.4 - ended_at (string ). The date-time when the interaction ended. Example: 2020-03-10T00:04:00.000000Z. Required. 1.5 - direction (string). Required. 1.6 - ring_groups (array[string]). The ring groups of the user (agent). Only applicable to STT and DCE source_system. Required. 1.7 - messages (array[object]. Required. 1.7.1 - message_id (string). The original utterance ID. Required. 1.7.2 - text (string). The text of the transcription message. Required. 1.7.3 - channel (string). The channel that generated the message: VOICE (STT,VA), WEBCHAT (VA), CHAT (DCE), SMS (VA,DCE), DIGITAL_CONNECT (VA,DCE). Required." 1.7.4 - participant (string). Required. 1.7.5 - sentiment (string). 1.7.6 - intent (string). The intent associated with the message. 1.7.7 - intent_confidence_score (number). The confidence score of the intent. 1.7.8 - intent_is_fallback (boolean). Determines if it is a fallback intent. 1.7.9 - start_time (number) . The time position in seconds where the message appears in audio. Only applicable to STT source_system. 1.7.10 - end_time (number. The time position in seconds where the message stops in the audio. Only applicable to STT source_system. 1.7.11 - transcription_type (string) 1.7.12 - source_system (string). System in which the message was generated: STT, DCE, VA. Required. 1.7.13 - recording_index (number). Index that identifies the recording to which the message belongs. Only applicable to STT source_system. 1.7.14 - message_index (number) - Index identifying the message order within an interaction/recording. 1.7.15 - message_start_at (string) -The datetime when the message started. 1.7.16 - agent_id (string) - The ID of the agent. Example: 2cfc7d5a-7e89-403d-b257-891247b88829 1.7.17 - agent_name (string) - The name of the agent. It will be deprecated for STT and Digital Channel sources. Still applicable to VA (Autopilot). 1.8 - agents (array[object]) 1.8.1 - id (string) - The ID of the agent. Example: 2cfc7d5a-7e89-403d-b257-891247b88829. Required. 1.8.2 - name (string) - The name of the agent. It will be deprecated for STT and Digital Channel sources. Still applicable to VA (Autopilot). | yes |
| _links | object | The page links. Subdivides into: 1 - next (string) - The link to the next page. Required. 1.1 - href (string) - The hypertext reference describing this link. Example: https://conversations.talkdesk.com/interactions?cursor=Zc2pJPVrJFeH0fGPjDanmw==. Required. | yes |
400 (bad request), 401 (unauthorized), 403 (forbidden), 500 (unexpected error)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.