Webex Calling administration APIs and scopes

See also

Sources

1. 1
   A Webex developer API reference page carries no publication timestamp anywhere in its embedded page state: documentation.entry is null on such a page and the apiReference object that holds its content carries an API version number and no time field.field report

   Reports: Detailed Call History — Get Detailed Call History · documentation.entry and apiReference of the embedded page state · Checked 2026-09-16
2. 2
   Cisco states that scopes beginning with spark-admin require a user with administrative access to the organisation and that requesting one does not elevate the authorizing user's role, and separately that the user authorizing an integration must have permission to perform the requested operations because granting an administrative scope does not give a non-administrator access to administrative functions.

   Webex for Developers — Integration Scopes · Integration Scopes guide, Select scopes and Administrative scopes · Checked 2026-09-16
3. 3
   Cisco states that scopes beginning with spark-compliance require an organisation compliance officer.

   Webex for Developers — Integration Scopes · Integration Scopes guide, Compliance scopes section · Checked 2026-09-16
4. 4
   Webex developer documentation pages carry a publication timestamp in the embedded page state at documentation.entry.publishDetails.time, an ISO 8601 value that differs between pages fetched in one pass: the webhooks guide reads 2026-09-10, and the provisioning and integration scopes guides read 2026-08-13.field report

   Webex for Developers — Webhooks · documentation.entry.publishDetails.time of the webhooks provisioning and integration scopes guides · Checked 2026-09-16
5. 5
   Cisco states that Webex adds the spark:kms scope to an integration's selected scopes so it can interact with encrypted content, that the generated authorization URL includes it, and that a developer who builds the authorization URL themselves must include spark:kms when the APIs they call require access to encrypted content.

   Webex for Developers — Integration Scopes · Integration Scopes guide, spark:kms section · Checked 2026-09-16
6. 6
   The local gateway configuration of an organisation is retrieved and modified through the Call Routing APIs, which Cisco describes as configuring dial plans, trunks and route groups, and which are the endpoints that manage routing between Webex Calling hosted users and on-premises private branch exchange users.

   Webex for Developers — Webex Calling Provisioning APIs · Provisioning APIs guide, Local Gateway APIs section · Checked 2026-09-16
7. 7
   The Webex Calling Provisioning APIs guide carries a live link whose address is an internal Cisco SharePoint path under a Developer Portal Blogs Draft folder with a help.webex.com address pasted after a tab character inside it, offered to the reader as the link for configuring a device.field report

   Webex for Developers — Webex Calling Provisioning APIs · Provisioning APIs guide, Workspace Calling and Device APIs, Device Call Settings bullet · Checked 2026-09-16
8. 8
   The Integration Scopes guide states the rules for selecting scopes and does not contain the scope list itself: its body is 2533 characters and places a ScopeList component where the catalogue would be, so the scopes are rendered from data rather than written in the document.field report

   Webex for Developers — Integration Scopes · Integration Scopes guide, Available scopes section · Checked 2026-09-16
9. 9
   The Webex Calling Provisioning APIs are grouped into 6 categories: user management, location settings, workspace calling and devices, phone numbers and service settings, local gateway, and calling features.

   Webex for Developers — Webex Calling Provisioning APIs · Provisioning APIs guide, Exploring the Provisioning APIs and its category headings · Checked 2026-09-16
10. 10
    Cisco describes the spark:all scope as granting access to Webex account features not covered by other user-level scopes, states that it does not include spark-admin privileges, notes that some Webex SDK calling features require it, and recommends that most integrations request narrower scopes.

    Webex for Developers — Integration Scopes · Integration Scopes guide, spark:all section · Checked 2026-09-16
11. 11
    Cisco organises the Webex Calling APIs into 3 pillars by when they act on a call: user-level Call Control APIs during active calls, the analytics and report APIs after calls are finished, and the administrator-level Provisioning APIs before calls happen.

    Webex for Developers — Webex Calling Provisioning APIs · Provisioning APIs guide, introduction · Checked 2026-09-16
12. 12
    Cisco lists 22 areas of individual user configuration reachable through the User Call Settings APIs: application services, barge-in, forwarding, intercept, call queue, recording, call waiting, caller identity, behaviours, do not disturb, executive assistant, hoteling, monitoring, permissions, phone numbers, answer endpoints, privacy, push-to-talk, receptionist client, schedules, shared-line appearance members and voicemail.field report

    Webex for Developers — Webex Calling Provisioning APIs · Provisioning APIs guide, User Management APIs, User Call Settings bullet · Checked 2026-09-16
13. 13
    The OAuth scopes published for Webex Calling administration include spark-admin:telephony_config_read and write, spark-admin:telephony_pstn_read and write, spark-admin:locations_read and write, spark-admin:workspace_locations_read and write, spark-admin:devices_read and write, spark-admin:workspaces_read, spark-admin:people_read and write, spark-admin:call_qualities_read, and spark-admin:calling_cdr_read.

    Webex for Developers — Webex Calling API reference · scopes.scopeItems array in the page's embedded window.__INITIAL_STATE__ · Checked 2026-09-04
14. 14
    Cisco publishes 1 concrete platform rate limit: most Webex REST APIs enforce a limit of around 300 requests per minute, with the people and messages APIs given a higher, dynamically adjusted quota, and Cisco states its rate-limiting policies are too complex to document exactly.

    Webex for Developers — Basics (Rate Limiting) · Upper Limits for API Requests · Checked 2026-09-04
15. 15
    The 300 requests per minute figure is likely to apply to the Webex Calling administration APIs, because the rate limiting section is shared boilerplate across the developer portal's documentation trees, but no Calling-specific rate limit is separately published.inferred

    Webex for Developers — Basics (Rate Limiting) · Rate Limiting section, applied by inference to the Calling admin tree · Checked 2026-09-04
16. 16
    Webex APIs support 3 authentication models: personal access tokens, Integrations using 3-legged OAuth 2.0 on behalf of an authorising user, and Service Apps bound to a machine account provisioned inside the customer organisation.

    Webex for Developers — Service Apps · Personal Access Tokens / Service Apps · Checked 2026-09-04
17. 17
    Both Detailed Call History endpoints are rate limited to 1 initial request per minute per user token, with up to 10 additional pagination requests per minute per user token.

    Reports: Detailed Call History — Get Detailed Call History · meta.info.description, rate limit sentence; identical sentence on cisco-dev-cdr-stream-detailed-call-history · Checked 2026-09-15
18. 18
    Retrieving Detailed Call History requires both a token carrying the spark-admin:calling_cdr_read scope and an authenticating user whose administrator role has Webex Calling Detailed Call History API access enabled.

    Reports: Detailed Call History — Get Detailed Call History · meta.info.description, access paragraph · Checked 2026-09-15

Documents

Cite this page

WarmTransfer. (2026, September 16). Webex Calling administration APIs and scopes. WarmTransfer. https://warmtransfer.net/knowledge/webex-calling-apis

@misc{warmtransfer-webex-calling-apis,
  title  = {Webex Calling administration APIs and scopes},
  author = {{WarmTransfer}},
  year   = {2026},
  url    = {https://warmtransfer.net/knowledge/webex-calling-apis},
  note   = {Verified 2026-09-16}
}