Calls

The Calls API and Call Memberships API described in this guide are currently pre-release features which are not available to all Webex Teams users. If you have any questions, or if you need help, please contact the Webex Developer Support team at devsupport@webex.com.

Overview

With the Webex Teams calling features, connecting with people is easier than ever. Calls can take place in both 1-to-1 and group spaces. The Call and Call Memberships APIs can be used to retrieve information about active and past calls, and participants of calls. When combined with Webhooks, your applications can be directly notified when activity related to calls or the memberships occurs.

What's possible with Calls and Call Memberships?

  • Build custom call rosters in your applications
  • Create reports for past call activity
  • Receive notifications for new incoming calls or meetings that have started

Calls

Webex Teams users can make calls, receive calls, and join meetings directly in the Webex Teams clients or via SDKs and Widgets. The Calls API provides access to information about these calls, including their current state, which room it's taking place in, and the duration. Information about past calls can also be retrieved via the API to collect information about call usage for a specific user or an entire organization.

Authorization Scopes

Authorization scopes are required to read call information. Note that in order to use a spark-admin scope you will need to be an administrator for your organization in the Webex Teams Control Hub. For instructions on how to add these scopes to your app and for a full list of all available authorization scopes see the Integrations/OAuth Guide.

Scope Usage
spark:calls_read Read calls for rooms you're in
spark-admin:calls_read Access to read calls in your user's organization

Call Memberships

Call participant information is available via the Call Memberships API. Call Memberships represent any user that is involved in a call. These users may be active participants of the call or invited participants who haven't joined. You can also find out more about a participant's status, such as whether or not they joined the call, if they were notified about the call, or if they are no longer in the call.

Authorization Scopes

Authorization scopes are required to read call membership information. Note that in order to use a spark-admin scope you will need to be an administrator for your organization in the Webex Teams Control Hub. For instructions on how to add these scopes to your app and for a full list of all available authorization scopes see the Integrations/OAuth Guide.

Scope Usage
spark:call_memberships_read Read call memberships for calls you're in
spark-admin:call_memberships_read Access to read call memberships for all calls in your user's organization

Webhooks

Webhook events for calls and call memberships are available to notify external services for events such as calls starting, memberships changing, etc. For more information about the webhook events that are available, please see the Resources, Events, & Filters section of Webhooks Explained.