Scopes
Adding a Scope
When a scope is added to an OAuth client via Talkdesk Builder™, it may take a few minutes for the scope to be effective.
The scope won’t be available instantly: a
401error message is displayed when requesting a token.
Scopes on General Availability
Scopes constrain the endpoints to which you have access, and whether you have read or write access to an endpoint.
The scopes required for each API are also identified on the corresponding API individual page.
| API | Scopes |
|---|---|
| Accounts API (information about a Talkdesk account) | account:read |
| Apps API (information about a specific installation of a partner app in a Talkdesk customer's instance) | apps:readapps:write |
| Attributes API (allows the configuration of attributes and corresponding proficiency levels for each contact center agent) | attributes:readattributes:write |
| Callback API (places a caller in queue without him having to wait on hold) | callback:write |
| Contacts API (allows getting and editing a contact's information) | contacts:readcontacts:write |
| Do Not Call Lists (DNCL) API (allows retrieving, creating and modifying DNCL for Outbound Dialer) | do-not-call-lists:manage |
| Explore API (provides historical data reports) | data-reports:writedata-reports:read |
| Events API (exposes events that happen inside Talkdesk as webhook calls, allowing to subscribe to events around an app's lifecycle) | events:write |
| Flows API (starts an interaction that executes the published version of a given Studio flow) | flows-interactions:start |
| Guardian Cases API (allows access to the list of cases detected while analyzing Talkdesk platform agents' behavior) | guardian-cases:read |
| Guardian Sessions API (allows to easily access sessions’ data from the Talkdesk platform agents) | guardian-session:read |
| Guardian Users API (provides all the information Guardian has about the users of an account - name, role, ring groups, creation place, user activation and status) | guardian-users:read |
| Guardian Call Quality API - provides all the information Guardian has on the users’ call quality from the previous 30 days. | guardian-call-quality:read |
| Live API (provides live data in real-time) | live-queries:readlive-subscriptions:readlive-subscriptions:write |
| Phone Validation API | identity-phone-validation:read |
| Recordings API (allows recording conversations automatically) | recordings:read |
| Record Lists API (allows the creation, deletion and cataloging of record lists) | record-lists:manage |
| Reporting API (provides historical data reports) | reports:writereports:read |
| Ring Groups API (facilitates the ring groups management) | ring-groups:readuser-ring-groups:read |
| Time Off API (allows importing agents' time-off information) | wfm-aion-public:write |
| Users API (information about users) | users:read |
| Usage-Manage API (information about wallet and bucket configurations) | account-wallets:readbucket-configurations:read |
| Voice Biometrics Opt-In API (allows the opt-in of contacts enrolled in voice biometrics) | voicebiometrics-consent:writevoicebiometrics-consent:read |
| Voice Biometrics Opt-Out API (allows the opt-out of contacts enrolled in voice biometrics) | voicebiometrics-enroll:write |
Updated 10 days ago