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.
Supported Regions and Base URLs
Access and RegistrationAuthentication
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.1 - id (string). The ID of the interaction. Example: 1.2 - customer_id (string). The ID of the customer. 1.3 - started_at (string <date-time>). The datetime when the interaction started. Example: 2020-03-10T00:00:00.000000Z. Required. 1.4 - ended_at (string <date-time>). 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.8 - agents (array[object]) | 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) |
TroubleshootingIf 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.