Supported Regions and Base URLs
Access and RegistrationAuthentication
Scope
presence-user:read
Body Response - Schema
200 (user presence)
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string<uuidv4> | a unique ID for the event | yes |
| account_id | string | the ID of the account | yes |
| status | string | The user current status. Allowed values: "available", "away", "offline", "hidden" | yes |
| custom_status | string | the user current custom status | yes |
| custom_status_id | string | the user current custom status ID | yes |
| occupancy | integer | the user occupancy level | yes |
| channels | array[object] | "channels" subdivides into: "name" (string) - the name of the channel (required) "devices (array[string]) - the list of device IDs belonging to the channel (required) "occupancy" (integer) - the channel occupancy level | yes |
| devices | array[object] | The list of devices available. "devices" subdivides into: "id" (string) - the ID of the device (required) | yes |
| interactions | array[object] | The list of ongoing interactions. "interactions" subdivides into: "id" (string) - the ID of the interaction (required) "channel_name" (string) - the name of the channel (required) "device_id" (string) - the ID of the device (not required) "cost" (integer) - the cost of the interaction (required) | yes |
| updated_by | string | n/a | yes |
| updated_at | string<date-time> | the time the last status was updated | yes |
| _links | object | The defined links. The list of ongoing interactions. "interactions" subdivides into: "self" (object) - the URI of the main resource being exposed (not required) | no |
403 (forbidden access), 404 (user not found), 406 (accept format mime type not supported)
| 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) |
API AvailabilityThe Presence API is only available for customers enrolled in Talkdesk's Early Access (EA) program.
To enter the EA program, contact a Customer Success Manager.
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.