Picking the Right Scopes with Webex Calling OAuth Integrations

When building an OAuth Integration, a scope is a mechanism that allows a user to grant limited access to their resources to a third-party application. Scopes specify what actions an application can perform on behalf of the user.

When a user is asked to grant access to their resources, they are shown the scopes that the application is requesting. The user can then decide whether to grant access to each scope.

For example, a social media application might request access to a user's public profile, friends list, and posts. Each of these actions could be represented by a separate scope, allowing the user to grant or deny access to each one individually. Scopes are an important security feature of OAuth because they allow users to control which parts of their resources are accessible to third-party applications.

Webex Scopes

Webex provides a range of APIs that can be used to build integrations and applications. These APIs can be used to create custom experiences and automate workflows within Webex.

When creating a Webex Integration on the Webex Developer Portal, you will be required to choose which scopes your integration needs.

Some of the key scope areas available for Webex APIs include:

• Meetings: These scopes allow you to create, update, and manage meetings within Webex.
• People: These scopes allow you to access and manage user data within Webex, such as user profiles and contact lists.
• Rooms: These scopes allow you to create, update, and manage rooms within Webex, including adding or removing participants.
• Messages: These scopes allow you to send and receive messages within Webex rooms.
• Teams: These scopes allow you to create, update, and manage teams within Webex.
• Devices: These scopes allow you to manage Webex devices, including retrieving device details, controlling device features, and managing device settings.
• Recordings: These scopes allow you to manage Webex meeting recordings, including retrieving and deleting recordings.
• Calling: These scopes allow you to manage Webex calls, provisioning, and reporting.

Webex Calling Scopes

To use the Webex Calling APIs, you will need to add one or more of the following scopes for your use case:

Calling Provisioning Scopes

These scopes encompass all types of Webex Calling provisioning that an administrator may require.

• spark-admin:devices_read - This scope allows you to read the details of Webex Calling devices.
• spark-admin:devices_write - This scope allows you to modify the details of Webex Calling devices.
• spark-admin:organizations_read - This scope allows you to read the details of organizations associated with Webex Calling.
• spark-admin:organizations_write - This scope allows you to modify the details of organizations associated with Webex Calling.
• spark-admin:people_read - This scope allows you to read the details of people associated with Webex Calling.
• spark-admin:people_write - This scope allows you to modify the details of people associated with Webex Calling.
• spark-admin:places_read - This scope allows you to read the details of places associated with Webex Calling.
• spark-admin:telephony_config_read - This scope allows you to read Webex Calling settings for a specific organization.
• spark-admin:telephony_config_write - This scope allows you to modify Webex Calling settings for a specific organization.
• spark-admin:workspaces_read - This scope allows you to read Webex Calling settings for a specific workspace within the organization.
• spark-admin:workspaces_write - This scope allows you to modify Webex Calling settings for a specific workspace within the organization.

Calling Controls Scopes

These scopes give access to perform actions on an individual's calls.

• spark:calls_read – This scope allows you to get call data, including voicemail and call details
• spark:calls_write – This scope allows you to control Webex calls like “dial” and “answer”

Calling Reporting and Analytics Scopes

These scopes allow reports to be created and run against Webex Calling data.

• spark-admin:calling_cdr_read - This scope allows you to retrieve detailed call history information.
• analytics:read_all - This scope allows you to

These scopes should help guide you with your Webex Calling integration.

Need Some Help? We Got You Covered!

We are excited to provide you with support for these features. If you need help, the Webex Developer Support Team is standing by and happy to assist. You can also start or join a conversation on the Webex for Developers Community Forum!