post https://api.talkdeskapp.com/users//presence
Scope
presence-user:read
Body Response - Schema
200 (connection details)
Parameter | Type | Description | Required |
---|---|---|---|
url | string | the url for the broker | yes |
password | string | the password to access the broker | yes |
username | string | the username to access the broker | yes |
client_id | string | the client identification to the broker | yes |
topic | string | the topic to subscribe | yes |
403 (forbidden access), 404 (user not found)
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 Availability
The 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.
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.