📘

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 401 error 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.

APIScopes
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:read

apps:write
Attributes API (allows the configuration of attributes and corresponding proficiency levels for each contact center agent)attributes:read

attributes: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:read

contacts: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:write

data-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:read

live-subscriptions:read

live-subscriptions:write
Phone Validation APIidentity-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:write

reports:read
Ring Groups API (facilitates the ring groups management)ring-groups:read

user-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:read
bucket-configurations:read
Voice Biometrics Opt-In API (allows the opt-in of contacts enrolled in voice biometrics)voicebiometrics-consent:write

voicebiometrics-consent:read
Voice Biometrics Opt-Out API (allows the opt-out of contacts enrolled in voice biometrics)voicebiometrics-enroll:write