Skip to content
Changelog

Report a bug

Webex integration: operations for AI agents

Webex connects to Type.com as an integration. This page lists the 1912 operations documented for Claude and Codex in Type.com: 935 read, 428 write, 549 destructive.

About Webex

Webex is a Cisco-powered video conferencing and collaboration platform offering online meetings, webinars, screen sharing, and team messaging

Categories: Communication & Meetings

How to connect Webex to Type.com

Access
Organization connection: one shared account for the workspace.
MCP
Selected AI voice-generation operations are not available through Type’s MCP server. Other operations remain available through MCP, subject to your connection’s permissions. These MCP restrictions do not apply within Type.

To add the connection, follow the steps in Space connections.

Documented operations

1912 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

1912 operations listed.

Attachment Actions

  • Read

    Get Attachment Action Details

    Shows details for a attachment action, by ID. Specify the attachment action ID in the id URI parameter.

  • Write

    Create an Attachment Action

    Create a new attachment action.

ECM folder linking

  • Read

    List ECM folder

    Lists the ECM folder of a room specified by the roomId query parameter.

  • Read

    Get ECM Folder Details

    Get details for a room ECM folder with the specified folder id.

  • Write

    Create an ECM folder configuration

    Adds an existing ECM folder to a room as (default or reference) file storage. There is no data validation happening for the request. Please ensure the correct driveId and itemId. These can be collected from the MS Graph API.

  • Destructive

    Update an ECM Linked Folder

    Updates the configuration of the specified Room folder. There is no data validation happening for the request. Please ensure the correct driveId and itemId. These can be collected from the MS Graph API. The contentUrl and displayName are used only for user convenience.

Events

  • Read

    List Events

    List events in your organization. Several query parameters are available to filter the events returned in the response. Long result sets will be split into pages.

  • Read

    Get Event Details

    Shows details for an event, by event ID. Specify the event ID in the eventId parameter in the URI.

  • Read

    List Event Specifications

    List the event types available for use in eventflows[]. Each entry describes the event name, payload schema, and any contextual metadata bound when the event fires. Scope: cjp:configread

Hybrid Data Security

  • Read

    Get organization details

    Retrieve details for an Hybrid Data Security organization, such as the organization name, type of organization. To obtain the Organization ID needed for this API, use the Organizations API

  • Read

    List clusters for an Hybrid Data Security organization

    Retrieve a list of all clusters for a specific Hybrid Data Security organization, including cluster status, release channel, and upgrade schedule details. To obtain the Organization ID needed for this API, use the Organizations API

  • Read

    Get cluster details

    Retrieve details for a specific Hybrid Data Security cluster, such as the cluster name, cluster status, upgrade schedule, and Hybrid Data Security nodes in the cluster. To obtain the Cluster ID needed for this API, use the Get organization details API

  • Read

    List nodes for an Hybrid Data Security cluster

    Retrieve a list of all nodes for a specific Hybrid Data Security cluster, including availability, proxy details, deployment type, and release version. To obtain the Cluster ID needed for this API, use the List clusters for an Hybrid Data Security organization API

  • Read

    Get node details

    Retrieve details for a specific Hybrid Data Security node, such as host name, release version, proxy details, deployment and build type, availability details, etc. To obtain the Node ID needed for this API, use the Get cluster details API

  • Read

    Get database details for the Hybrid Data Security organization

    Retrieve details of database information for an Hybrid Data Security organization, such as database type and version used. To obtain the Organization ID needed for this API, use the Organizations API

  • Read

    Get Multi-Tenant Hybrid Data Security organization details

    Retrieve details of Multi-Tenant Hybrid Data Security organization such as Organization Name and ID, CMK state and state of Tenants Organizations. To obtain the Organization ID needed for this API, use the Organizations API

  • Read

    Get alarms for an Hybrid Data Security node

    Returns the alarm details for a single Hybrid Data Security node for the provided time range (last 24 hours). To obtain the Node ID needed for this API, use the List nodes for an Hybrid Data Security cluster API

  • Read

    Get test results for Hybrid Data Security node

    Get the latest results of the network tests triggered for a single Hybrid Data Security node. The test results are generated as part of the Network Test execution on the node. The network tests include the Bandwidth Test, DNS Resolution Test, and HTTPS Connectivity Test.

  • Read

    Get resource usage for an Hybrid Data Security node

    Retrieve CPU, memory, and disk resource usage details for a specific Hybrid Data Security node over the requested time range. To obtain the Node ID needed for this API, use the List nodes for an Hybrid Data Security cluster API

  • Read

    Get availability details for Hybrid Data Security cluster

    Get the availability details for an Hybrid Data Security cluster, where each segment specifies the start and end times, as well as the number of online, offline, and total nodes within that segment.

Memberships

  • Read

    List Memberships

    Lists all room memberships. By default, lists memberships for rooms to which the authenticated user belongs. Use query parameters to filter the response. Use roomId to list memberships for a room, by ID.

  • Read

    Get Membership Details

    Get details for a membership by ID. Specify the membership ID in the membershipId URI parameter.

  • Write

    Create a Membership

    Add someone to a room by Person ID or email address, optionally making them a moderator. Compliance Officers cannot add people to empty (team) spaces.

  • Destructive

    Update a Membership

    Updates properties for a membership by ID. Specify the membership ID in the membershipId URI parameter.

  • Destructive

    Delete a Membership

    Deletes a membership by ID. Specify the membership ID in the membershipId URI parameter. The membership for the last moderator of a Team's General space may not be deleted; promote another user to team moderator first.

Messages

  • Read

    List Messages

    Lists all messages in a room. Each message will include content attachments if present. The list sorts the messages in descending order by creation date. Long result sets will be split into pages.

  • Read

    List Direct Messages

    List all messages in a 1:1 (direct) room. Use the personId or personEmail query parameter to specify the room. Each message will include content attachments if present. The list sorts the messages in descending order by creation date.

  • Read

    Get Message Details

    Show details for a message, by message ID. Specify the message ID in the messageId parameter in the URI.

  • Write

    Create a Message

    Post a plain text or rich text message, and optionally, a file attachment attachment, to a room. The files parameter is an array, which accepts multiple values to allow for future expansion, but currently only one file may be included with the message.

  • Destructive

    Edit a Message

    Update a message you have posted not more than 10 times. Specify the messageId of the message you want to edit. Edits of messages containing files or attachments are not currently supported.

  • Destructive

    Delete a Message

    Delete a message, by message ID. Specify the message ID in the messageId parameter in the URI.

  • Destructive

    Delete a Meeting Message

    Deletes a Meeting Message from the In Meeting Chat, using its ID. This ID can be retrieved by a Compliance Officer using the events API filtering on the meetingMessages resource type. NOTE: When viewing the response from the events API, there are 2 id fields.

People

  • Read

    List People

    List people in your organization. For most users, either the email or displayName parameter is required. Admin users can omit these fields and list all users in their organization.

  • Read

    Get Person Details

    Shows details for a person, by ID. Response properties associated with a user's presence status, such as status or lastActivity, will only be displayed for people within your organization or an organization you manage.

  • Read

    Get My Own Details

    Get profile details for the authenticated user. This is the same as GET /people/{personId} using the Person ID associated with your Auth token. Admin users can include Webex Calling (BroadCloud) user details in the response by specifying callingData parameter as true.

  • Write

    Create a Person

    Create a new user account for a given organization. Only an admin can create a new user account. At least one of the following body parameters is required to create a new user: displayName, firstName, lastName.

  • Destructive

    Update a Person

    Update details for a person, by ID. Specify the person ID in the personId parameter in the URI. Only an admin can update a person details. Include all details for the person. This action expects all user details to be present in the request.

  • Destructive

    Delete a Person

    Remove a person from the system. Required Administrator Roles: The following administrators have permission to use this API: Customer Organization: - Full administrator - User administrator Partner/External Access: - External full administrator Note: External read-only administr…

Room Tabs

  • Read

    List Room Tabs

    Lists all Room Tabs of a room specified by the roomId query parameter.

  • Read

    Get Room Tab Details

    Get details for a Room Tab with the specified room tab ID.

  • Write

    Create a Room Tab

    Add a tab with a specified URL to a room.

  • Destructive

    Update a Room Tab

    Updates the content URL of the specified Room Tab ID.

  • Destructive

    Delete a Room Tab

    Deletes a Room Tab with the specified ID.

Rooms

  • Read

    List Rooms

    List rooms to which the authenticated user belongs to. The title of the room for 1:1 rooms will be the display name of the other person. Please use the memberships API to list the people in the space. Long result sets will be split into pages.

  • Read

    Get Room Details

    Shows details for a room, by ID. The title of the room for 1:1 rooms will be the display name of the other person. When a Compliance Officer lists 1:1 rooms, the "other" person cannot be determined.

  • Read

    Get Room Meeting Details

    The meetingInfo API is deprecated and will be EOL on Jan 31, 2025. Meetings in the WSMP must be scheduled and licensed via the meetings backend. The Create a Meeting endpoint will provide the SIP address for the meeting to call.

  • Write

    Create a Room

    Creates a room. The authenticated user is automatically added as a member of the room. See the Memberships API to learn how to add more people to the room.

  • Destructive

    Update a Room

    Updates details for a room, by ID. Specify the room ID in the roomId parameter in the URI. A space can only be put into announcement mode when it is locked. Any space participant or compliance officer can convert a space from public to private.

  • Destructive

    Delete a Room

    Deletes a room, by ID. Deleted rooms cannot be recovered. As a security measure to prevent accidental deletion, when a non moderator deletes the room they are removed from the room instead. Deleting a room that is part of a team will archive the room instead.

Team Memberships

  • Read

    List Team Memberships

    Lists all team memberships for a given team, specified by the teamId query parameter. Use query parameters to filter the response.

  • Read

    Get Team Membership Details

    Shows details for a team membership, by ID. Specify the team membership ID in the membershipId URI parameter.

  • Write

    Create a Team Membership

    Add someone to a team by Person ID or email address, optionally making them a moderator.

  • Destructive

    Update a Team Membership

    Updates a team membership, by ID. Specify the team membership ID in the membershipId URI parameter.

  • Destructive

    Delete a Team Membership

    Deletes a team membership, by ID. Specify the team membership ID in the membershipId URI parameter. The team membership for the last moderator of a team may not be deleted; promote another user to team moderator first.

Teams

  • Read

    List Teams

    Lists teams to which the authenticated user belongs.

  • Read

    Get Team Details

    Shows details for a team, by ID. Specify the team ID in the teamId parameter in the URI.

  • Write

    Create a Team

    Creates a team. The authenticated user is automatically added as a member of the team. See the Team Memberships API to learn how to add more people to the team.

  • Destructive

    Update a Team

    Updates details for a team, by ID. Specify the team ID in the teamId parameter in the URI.

  • Destructive

    Delete a Team

    Deletes a team, by ID. Specify the team ID in the teamId parameter in the URI.

Webhooks

  • Read

    List Webhooks

    List all of your webhooks.

  • Read

    Get Webhook Details

    Shows details for a webhook, by ID. Specify the webhook ID in the webhookId parameter in the URI.

  • Write

    Create a Webhook

    Creates a webhook. To learn more about how to create and use webhooks, see The Webhooks Guide.

  • Destructive

    Update a Webhook

    Updates a webhook, by ID. You cannot use this call to deactivate a webhook, only to activate a webhook that was auto deactivated. The fields that can be updated are name, targetURL, secret and status. All other fields, if supplied, are ignored.

  • Destructive

    Delete a Webhook

    Deletes a webhook, by ID. Specify the webhook ID in the webhookId parameter in the URI.

Chats

  • Read

    List Meeting Chats

    Lists the meeting chats of a finished meeting instance specified by meetingId. You can set a maximum number of chats to return. Use this operation to list the chats of a finished meeting instance when they are ready.

  • Destructive

    Delete Meeting Chats

    Deletes the meeting chats of a finished meeting instance specified by meetingId. Use this operation to delete the chats of a finished meeting instance when they are ready. Please note that only meeting instances in state ended are supported for meetingId.

Closed Captions

  • Read

    List Meeting Closed Captions

    Lists closed captions of a finished meeting instance specified by meetingId. Closed captions are ready 15 minutes after the meeting is finished. Only meeting instances in state ended are supported for meetingId.

  • Read

    List Meeting Closed Caption Snippets

    Lists snippets of a meeting closed caption specified by closedCaptionId.

  • Read

    Download Meeting Closed Caption Snippets

    Download meeting closed caption snippets from the meeting closed caption specified by closedCaptionId formatted either as a Video Text Track (.vtt) file or plain text (.txt) file.

Invitees

  • Read

    List Meeting Invitees

    Lists meeting invitees for a meeting with a specified meetingId. You can set a maximum number of invitees to return. This operation can be used for meeting series, scheduled meetings, and ended or ongoing meeting instance objects.

  • Read

    Get a Meeting Invitee

    Retrieve details for a meeting invitee identified by a meetingInviteeId in the URI.

  • Write

    Create a Meeting Invitee

    Invite a person to attend a meeting. Identify the invitee in the request body, by email address. The sendEmail parameter is true by default and the meeting emails will be sent to the invitee's email. Please set sendEmail to false to prevent the invitee from receiving emails.

  • Write

    Create Meeting Invitees

    Invite people to attend a meeting in bulk. Identify each invitee by the email address of each item in the items of the request body. Each invitee should have a unique email. This API limits the maximum size of items in the request body to 100.

  • Destructive

    Update a Meeting Invitee

    Update details for a meeting invitee identified by a meetingInviteeId in the URI.

  • Destructive

    Delete a Meeting Invitee

    Removes a meeting invitee identified by a meetingInviteeId specified in the URI. The deleted meeting invitee cannot be recovered. If the meeting invitee is associated with a meeting series, the invitee will be removed from the entire meeting series.

Participants

  • Read

    List Meeting Participants

    List all participants in an in-progress meeting or an ended meeting. The meetingId parameter is required, which is the unique identifier for the meeting.

  • Read

    Query Meeting Participants with Email

    Query participants in a live meeting, or after the meeting, using participant's email. The meetingId parameter is the unique identifier for the meeting and is required.

  • Read

    Get Meeting Participant Details

    Get a meeting participant details of a live or post meeting. The participantId is required to identify the meeting and the participant.

  • Write

    Admit Participants

    To admit participants into a live meeting or its breakout sessions in bulk. If breakoutSessionId is null for all the requested participants, they are admitted into the main session of the meeting.

  • Write

    Call Out a SIP Participant

    Initiate a call to a SIP participant to join a meeting. If a user invoking the API is not a Service App, the user must join the meeting before invoking the API. If a user is a Service App, the service app can invoke the API without joining the meeting.

  • Destructive

    Update a Participant

    Mute, un-mute, expel, or admit a participant in a live meeting. The participantId is required to identify the meeting and the participant. Notes: The owner of the OAuth token calling this API needs to be the meeting host or co-host.

  • Destructive

    Cancel Calling Out a SIP Participant

    Cancel the call to a SIP participant before the ringing on the invited SIP device stops. The ringing on the invited SIP device stops in 30 seconds if there is no response. If a user invoking the API is not a Service App, the user must join the meeting before invoking the API.

Meeting Polls

  • Read

    List Meeting Polls

    Lists all the polls and the poll questions in a meeting when ready. Only meeting instances in state ended or inProgress are supported for meetingId. No pagination for this API because we don't expect a large number of questions for each meeting.

  • Read

    Get Meeting PollResults

    List the meeting polls, the poll's questions, and answers from the meeting when ready. Only meeting instances in state ended or inProgress are supported for meetingId. Long result sets will be split into pages.

  • Read

    List Respondents of a Question

    Lists the respondents to a specific questions in a poll. Only meeting instances in state ended or inProgress are supported for meetingId. Long result sets are split into pages. The list of poll respondents are available within 15 minutes following the meeting.

Preferences

  • Read

    Get Meeting Preference Details

    Retrieves meeting preferences for the authenticated user.

  • Read

    Get Personal Meeting Room Options

    Retrieves the Personal Meeting Room options for the authenticated user.

  • Read

    Get Audio Options

    Retrieves audio options for the authenticated user.

  • Read

    Get Video Options

    Retrieves video options for the authenticated user.

  • Read

    Get Scheduling Options

    Retrieves scheduling options for the authenticated user.

  • Read

    Get Site List

    Retrieves the list of Webex sites that the authenticated user is set up to use. When the admin tries to get the site list via userEmail, if siteUrl is not specified, the API searches the user ID from the admin's default site.

  • Write

    Insert Delegate Emails

    Insert delegate emails for the authenticated user.

  • Write

    Batch Refresh Personal Meeting Room ID

    Refreshes personal room IDs automatically according to the current personal room ID rule of the target site or by the values specified by the admin user.

  • Destructive

    Update Personal Meeting Room Options

    Updates Personal Meeting Room options for the authenticated user.

  • Destructive

    Update Audio Options

    Updates audio options for the authenticated user.

  • Destructive

    Update Video Options

    Updates video options for the authenticated user.

  • Destructive

    Update Scheduling Options

    Updates scheduling options for the authenticated user. If delegateEmails is null or not specified, the user's delegate emails are not changed. If delegateEmails is specified and not empty, the user's delegate emails are updated with the specified emails.

  • Destructive

    Delete Delegate Emails

    Delete delegate emails for the authenticated user.

  • Destructive

    Update Default Site

    Updates the default site for the authenticated user.

Meeting Q and A

  • Read

    List Meeting Q and A

    Lists questions and answers from a meeting, when ready. Notes: Only meeting instances in state ended or inProgress are supported for meetingId. Long result sets will be split into pages.

  • Read

    List Answers of a Question

    Lists the answers to a specific question asked in a meeting. Only meeting instance in state ended or inProgress are supported for meetingId. Long result sets will be split into pages.

Meeting Qualities

  • Read

    Get Meeting Qualities

    Get quality data for a meeting, by meetingId. Only organization administrators can retrieve meeting quality data.

Session Types

  • Read

    List Site Session Types

    List session types for a specific site.

  • Read

    List User Session Type

    List session types for a specific user.

  • Destructive

    Update User Session Types

    Assign session types to specific users. At least one of the following body parameters is required to update a specific user session type: personId, email.

Summaries

  • Read

    Get Summary by Meeting ID

    Get the summary of an ended meeting instance by the meeting ID.

  • Read

    Get Summary For Compliance Officer

    Lists available or deleted summaries of an ended meeting instance by meeting ID. This API can only be accessed by compliance officers.

  • Destructive

    Delete a Summary

    Removes a summary with a specified summary ID. The deleted summary cannot be recovered. A deleted summary can not be accessed by regular users, i.e. host or attendees, but can be access by compliance officers

Transcripts

  • Read

    List Meeting Transcripts

    Lists available transcripts of an ended meeting instance. Use this operation to list transcripts of an ended meeting instance when they are ready. Please note that only meeting instances in state ended are supported for meetingId.

  • Read

    List Meeting Transcripts For Compliance Officer

    Lists available or deleted transcripts of an ended meeting instance for a specific site. The returned list is sorted in descending order by the date and time that the transcript was created. Request Header timezone: Time zone in conformance with the IANA time zone database.

  • Read

    Download a Meeting Transcript

    Download a meeting transcript from the meeting transcript specified by transcriptId.

  • Read

    List Snippets of a Meeting Transcript

    Lists snippets of a meeting transcript specified by transcriptId. Use this operation to list snippets of a meeting transcript when they are ready.

  • Read

    Get a Transcript Snippet

    Retrieves details for a transcript snippet specified by snippetId from the meeting transcript specified by transcriptId.

  • Destructive

    Update a Transcript Snippet

    Updates details for a transcript snippet specified by snippetId from the meeting transcript specified by transcriptId.

  • Destructive

    Delete a Transcript

    Removes a transcript with a specified transcript ID. The deleted transcript cannot be recovered.

Meetings Summary Report

  • Read

    List Meeting Usage Reports

    List meeting usage reports of all the users on the specified site by an admin. You can specify a date range and the maximum number of meeting usage reports to return. The list returned is sorted in descending order by the date and time the meetings were started.

  • Read

    List Meeting Attendee Reports

    Lists of meeting attendee reports by a date range, the maximum number of meeting attendee reports, a meeting ID, a meeting number or a meeting title.

Meetings

  • Read

    Get a Meeting By an Admin

    Retrieves details for a meeting with a specified meeting ID by an admin.

  • Read

    List Meetings By an Admin

    Retrieves details for meetings by an admin with a specified meeting number or web link. Please note that there are various products in the Webex Suite such as Meetings and Events.

  • Read

    List Group Meetings

    List group meetings with a specified meeting number or web link by a service app which has group meeting access. You can specify the personId parameter or hostEmail header of whom the meetings will be retrieved.

  • Read

    List Meetings

    The previous List Meetings of a Meeting Series API is merged into the List Meetings API. Retrieves details for meetings with a specified meeting number, web link, meeting type, etc. Please note that there are various products in the Webex Suite such as Meetings and Events.

  • Read

    Get a Meeting

    Retrieves details for a meeting with a specified meeting ID. If the meetingId value specified is for a meeting series and current is true, the operation returns details for the current scheduled meeting of the series, i.e.

  • Read

    List Meeting Templates

    Retrieves the list of meeting templates that is available for the authenticated user. There are separate lists of meeting templates for different templateType, locale and siteUrl.

  • Read

    Get a Meeting Template

    Retrieves details for a meeting template with a specified meeting template ID. Request Header timezone: Time zone for time stamps in response body, defined in conformance with the IANA time zone database. The default value is UTC if not specified.

  • Read

    Get Meeting Control Status

    Get the meeting control of a live meeting, which is consisted of meeting control status on "locked" and "recording" to reflect whether the meeting is currently locked and there is recording in progress.

  • Read

    List Meeting Session Types

    List all the meeting session types enabled for a given user.

  • Read

    Get a Meeting Session Type

    Retrieves details for a meeting session type with a specified session type ID.

  • Read

    Get registration form for a meeting

    Get a meeting's registration form to understand which fields are required.

  • Read

    List Meeting Registrants

    Meeting's host and cohost can retrieve the list of registrants for a meeting with a specified meeting Id.

  • Read

    Get Detailed Information for a Meeting Registrant

    Retrieves details for a meeting registrant with a specified registrant Id.

  • Read

    Query Meeting Registrants

    Meeting's host and cohost can query the list of registrants for a meeting with a specified meeting ID and registrants email.

  • Read

    List Meeting Interpreters

    Lists meeting interpreters for a meeting with a specified meetingId. This operation can be used for meeting series, scheduled meeting and ended or ongoing meeting instance objects.

  • Read

    Get a Meeting Interpreter

    Retrieves details for a meeting interpreter identified by meetingId and interpreterId in the URI.

  • Read

    List Meeting Breakout Sessions

    Lists meeting breakout sessions for a meeting with a specified meetingId. This operation can be used for meeting series, scheduled meeting and ended or ongoing meeting instance objects. See the Webex Meetings guide for more information about the types of meetings.

  • Read

    Get a Meeting Survey

    Retrieves details for a meeting survey identified by meetingId. Request Header hostEmail: Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes.

  • Read

    List Meeting Survey Results

    Retrieves results for a meeting survey identified by meetingId. Request Header timezone: Time zone for time stamps in response body, defined in conformance with the IANA time zone database. The default value is UTC if not specified. hostEmail: Email address for the meeting host.

  • Read

    List Invitation Sources

    Lists invitation sources for a meeting. Request Header hostEmail: Email address for the meeting host. This parameter is only used if the user or application calling the API has the admin on-behalf-of scopes.

  • Read

    List Meeting Tracking Codes

    Lists tracking codes on a site by a meeting host. The result indicates which tracking codes and what options can be used to create or update a meeting on the specified site. The options here differ from those in the site-level tracking codes and the user-level tracking codes.

  • Write

    Patch a Group Meeting

    Patches details for a group meeting with a specified meeting ID by a service app which has group meeting access. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances.

  • Write

    Update Group Meeting Control Status

    Update meeting recording control status by a service app which has group meeting access. The service app can use this API to start, stop, pause, or resume meeting recording by providing an action value.

  • Write

    Create a Meeting

    Creates a new meeting. Regular users can schedule up to 100 meetings in 24 hours and admin users up to 3000 overall or 800 for a single user. Please note that the failed requests are also counted toward the limits. The spark:all scope is required when roomId is specified.

  • Write

    Patch a Meeting

    If only guests are waiting in the lobby and the host or cohost has not started the meeting, the meeting state remains inProgress for 5 minutes after the last guest leaves. The meeting cannot be patched during this time.

  • Write

    Join a Meeting

    Retrieves links for a meeting with a specified meetingId, meetingNumber, or webLink that allow users to start or join the meeting directly without logging in and entering a password.

  • Write

    Register a Meeting Registrant

    Register a new registrant for a meeting. When a meeting or webinar is created, this API can only be used if Registration is checked on the page or the registration attribute is specified through the Create a Meeting API.

  • Write

    Batch register Meeting Registrants

    Bulk register new registrants for a meeting. When a meeting or webinar is created, this API can only be used if Registration is checked on the page or the registration attribute is specified through the Create a Meeting API.

  • Write

    Batch Approve Meeting Registrants

    Batch approve a set of registrants for a meeting by the meeting host or cohost.

  • Write

    Batch Reject Meeting Registrants

    Batch reject a set of registrants for a meeting by the meeting host or cohost.

  • Write

    Batch Cancel Meeting Registrants

    Batch cancel a set of registrants for a meeting by the meeting host or cohost.

  • Write

    Batch Delete Meeting Registrants

    Batch delete a set of registrants for a meeting by the meeting host or cohost.

  • Write

    Create a Meeting Interpreter

    Assign an interpreter to a bi-directional simultaneous interpretation language channel for a meeting.

  • Write

    Create Invitation Sources

    Creates one or more invitation sources for a meeting.

  • Write

    Reassign Meetings to a New Host

    Reassigns a list of meetings to a new host by an admin user. All the meetings of meetingIds should belong to the same site, which is the siteUrl in the request header, if specified, or the admin user's preferred site, if not specified.

  • Write

    End a Meeting

    Ends a meeting with a specified meeting ID. This operation applies to meeting series, scheduled meetings, and in-progress meetings. Only the meeting host, cohost, or compliance officer can end a meeting with this API.

  • Destructive

    Update a Meeting

    The PUT method is still supported and behaves the same as before, will be deprecated in the future. Use the PATCH method instead.

  • Destructive

    Delete a Meeting

    If only guests are waiting in the lobby and the host or cohost has not started the meeting, the meeting state remains inProgress for 5 minutes after the last guest leaves. The meeting cannot be deleted during this time.

  • Destructive

    Update Meeting Control Status

    To start, pause, resume, or stop a meeting recording; To lock or unlock an on-going meeting.

  • Destructive

    Update Meeting Registration Form

    Enable or update a registration form for a meeting.

  • Destructive

    Delete Meeting Registration Form

    Disable the registration form for a meeting.

  • Destructive

    Delete a Meeting Registrant

    Meeting's host or cohost can delete a registrant with a specified registrant ID.

  • Destructive

    Update Meeting Simultaneous interpretation

    Updates simultaneous interpretation options of a meeting with a specified meeting ID. This operation applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances.

  • Destructive

    Update a Meeting Interpreter

    Updates details for a meeting interpreter identified by meetingId and interpreterId in the URI.

  • Destructive

    Delete a Meeting Interpreter

    Removes a meeting interpreter identified by meetingId and interpreterId in the URI. The deleted meeting interpreter cannot be recovered.

  • Destructive

    Update Meeting Breakout Sessions

    Updates breakout sessions of a meeting with a specified meeting ID in the pre-meeting state. This operation applies to meeting series and scheduled meetings.

  • Destructive

    Delete Meeting Breakout Sessions

    Deletes breakout sessions with a specified meeting ID. The deleted breakout sessions cannot be recovered. The value of enabledBreakoutSessions attribute is set to false automatically. This operation applies to meeting series and scheduled meetings.

Tracking Codes

  • Read

    List Tracking Codes

    Lists tracking codes on a site by an admin user. If siteUrl is specified, tracking codes of the specified site will be listed; otherwise, tracking codes of the user's preferred site will be listed.

  • Read

    Get a Tracking Code

    Retrieves details for a tracking code by an admin user. If siteUrl is specified, the tracking code is retrieved from the specified site; otherwise, the tracking code is retrieved from the user's preferred site.

  • Read

    Get User Tracking Codes

    Lists user's tracking codes by an admin user. At least one parameter, either personId, or email is required. personId must come before email if both are specified. Please note that email is specified in the request header.

  • Write

    Create a Tracking Code

    Create a new tracking code by an admin user. The siteUrl is required. The operation creates a tracking code for the specified site. All or a user's available Webex sites can be retrieved by the Get Site List API.

  • Destructive

    Update a Tracking Code

    Updates details for a tracking code by an admin user. The siteUrl is required. The operation updates a tracking code for the specified site. All of a user's available Webex sites can be retrieved by the Get Site List API.

  • Destructive

    Delete a Tracking Code

    Deletes a tracking code by an admin user. The siteUrl is required. The operation deletes a tracking code for the specified site. All of a user's available Webex sites can be retrieved by the Get Site List API.

  • Destructive

    Update User Tracking Codes

    Updates tracking codes for a specified user by an admin user. The siteUrl is required. The operation updates a user's tracking code on the specified site. All a user's available Webex sites can be retrieved by the Get Site List API.

Recording Report

  • Read

    List of Recording Audit Report Summaries

    Lists of recording audit report summaries. You can specify a date range and the maximum number of recording audit report summaries to return. Only recording audit report summaries of meetings hosted by or shared with the authenticated user will be listed.

  • Read

    Get Recording Audit Report Details

    Retrieves details for a recording audit report with a specified recording ID. Only recording audit report details of meetings hosted by or shared with the authenticated user may be retrieved. Request Header timezone: Time zone in conformance with the IANA time zone database.

  • Read

    List Meeting Archive Summaries

    Lists of meeting archive summaries. You can specify a date range and the maximum number of meeting archive summaries to return. Meeting archive summaries are only available to full administrators, not even the meeting host.

  • Read

    Get Meeting Archive Details

    Retrieves details for a meeting archive report with a specified archive ID, which contains recording metadata. Meeting archive details are only available to full administrators, not even the meeting host.

Recordings

  • Read

    List Recordings

    This API is still supported and behaves the same as before, but will be deprecated in the future. Due to limited support for special characters when filtering recordings by topic, it is recommended to use the new Query Recordings API instead. Lists recordings.

  • Read

    Query Recordings

    Queries recordings with filters in the request body. You can specify a date range, a parent meeting ID, the maximum number of recordings to return, and additional filters such as siteUrl, integrationTag, hostEmail, topic, format, serviceType, and status.

  • Read

    List Recordings For an Admin or Compliance Officer

    This API is still supported and behaves the same as before, but will be deprecated in the future. Due to limited support for special characters when filtering recordings by topic, it is recommended to use the new Query Recordings For an Admin or Compliance Officer API instead.

  • Read

    Query Recordings For an Admin or Compliance Officer

    Queries recordings for an admin or compliance officer with filters in the request body. You can specify a date range, a parent meeting ID, the maximum number of recordings to return, and additional filters such as siteUrl, integrationTag, topic, format, serviceType, and status.

  • Read

    Get Recording Details

    Retrieves details for a recording with a specified recording ID. Only recordings of meetings hosted by or shared with the authenticated user may be retrieved. Request Header timezone: Time zone in conformance with the IANA time zone database.

  • Read

    List Group Recordings

    List group recordings for a service app which has group recording access. You can specify a date range, the maximum number of recordings to return, and personId or hostEmail of whom the recordings will be retrieved.

  • Read

    Get Group Recording Details

    Retrieves details for a group recording for a service app which has group recording access. Only recordings which are in the available status and not shared by others can be listed. Those in the deleted or purged status or shared by others can't be listed.

  • Write

    Move Recordings into the Recycle Bin

    Move recordings into the recycle bin with recording IDs. Recordings in the recycle bin can be recovered by Restore Recordings from Recycle Bin API.

  • Write

    Restore Recordings from Recycle Bin

    Restore all or some recordings from the recycle bin. Only recordings of meetings hosted by the authenticated user can be restored from recycle bin. If restoreAll is true, recordingIds should be empty.

  • Write

    Share a Recording

    Share or unshare a recording with other users by recording ID and email addresses.

  • Destructive

    Delete a Recording By an Admin

    Removes a recording with a specified recording ID by an admin. The deleted recording cannot be recovered. It will be inaccessible to regular users (host, attendees and shared) or an admin, but it will be still available to the Compliance Officer.

  • Destructive

    Delete a Recording

    Removes a recording with a specified recording ID. The deleted recording cannot be recovered.

  • Destructive

    Purge Recordings from Recycle Bin

    Purge recordings from recycle bin with recording IDs or purge all the recordings that are in the recycle bin. Only recordings of meetings hosted by the authenticated user can be purged from recycle bin. If purgeAll is true, recordingIds should be empty.

Site

  • Read

    Get Meeting Common Settings Configuration

    Site administrators can use this API to get a list of functions, options, and privileges that are configured for their Webex service sites.

  • Read

    List Site(s)

    Retrieve a list of Site(s) in a given organization.

  • Read

    Get specific Site by ID

    Retrieve an existing Site by ID in a given organization.

  • Read

    List references for a specific Site

    Retrieve a list of all entities that have reference to an existing Site by ID in a given organization.

  • Read

    List Site(s)

    Retrieve a list of Site(s) in a given organization.

  • Write

    Update Meeting Common Settings Configuration

    Site administrators can use this API to update the option of features, options and privileges that are configured for their WebEx service sites.

  • Write

    Create a new Site

    Create a new Site in a given organization.

  • Write

    Bulk save Site(s)

    Create, Update or delete Site(s) in bulk in a given organization.

  • Destructive

    Purge inactive Site(s)

    Purge inactive Site(s) older than the configured interval for a given organization.

  • Destructive

    Update specific Site by ID

    Update an existing Site by ID in a given organization.

  • Destructive

    Delete specific Site by ID

    Delete an existing Site by ID in a given organization.

Slido Secure Premium

  • Read

    List Compliance Events

    Lists events representing actions that occurred during a Slido Secure Premium session (creating a poll, modifying a poll, activating a poll, posting an answer, etc.) Events capture who performed the action and on what resource.

Video Mesh

  • Read

    List Clusters Availability

    Returns the availability details for all Video Mesh clusters in an organization.

  • Read

    Get Cluster Availability

    Returns the availability details of a single Video Mesh cluster in an organization.

  • Read

    List Node Availability

    Returns the availability details of all nodes in a Video Mesh cluster.

  • Read

    Get Node Availability

    Returns the availability details of a single node in a Video Mesh cluster.

  • Read

    List Media Health Monitoring Tool Test results V2

    Returns the test results of the Media Health Monitoring Tool tests for an organization. Changes in V2: On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes.

  • Read

    Get Media Health Monitoring Tool Test results for clusters V2

    Returns the test results of the Media Health Monitoring Tool tests for a single Video Mesh cluster. Changes in V2: On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes.

  • Read

    Get Media Health Monitoring Tool Test results for node V2

    Returns the test results of the Media Health Monitoring Tool tests for a single Video Mesh node. Changes in V2: On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes.

  • Read

    List Overflow to Cloud details

    Returns details of overflows to the cloud in an organization.

  • Read

    List Cluster Redirect details

    Returns the redirect details of all Video Mesh clusters in an organization.

  • Read

    Get Cluster Redirect details

    Returns details of cluster redirects for a single Video Mesh cluster.

  • Read

    List Clusters Utilization

    Returns the utilization details of all Video Mesh clusters in an organization.

  • Read

    Get Cluster Utilization details

    Returns the utilization details for a single Video Mesh cluster.

  • Read

    List Reachability Test results V2

    Returns the test results of the Reachability tests for an organization. Changes in V2: 1. On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes. 2.

  • Read

    Get Reachability Test results for cluster V2

    Returns the test results of the Reachability tests for a single Video Mesh cluster. Changes in V2: 1. On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes. 2.

  • Read

    Get Reachability Test results for node V2

    Returns the test results of the Reachability tests for a single Video Mesh node. Changes in V2: 1. On-demand test results can be obtained along with the periodic tests that are executed on Video Mesh nodes. 2.

  • Read

    List Cluster Details

    Returns the cluster details of all Video Mesh clusters in an organization.

  • Read

    Get Cluster Details

    Returns the cluster details for a single Video Mesh cluster.

  • Read

    Get Triggered test status

    Returns the status of the test triggered using the Trigger on-demand test API.

  • Read

    Get Triggered test results

    Returns the results of the test triggered using the command ID. NOTE: The response format depends on the type of test triggered and it is the same as that of NetworkTest API, MediaHealthMonitorTest API, and ReachabilityTest API respectively.

  • Read

    List Network Test results

    Returns the test results of the Network tests triggered for an organization. The tests listed below are run as a part of the Network Test execution on the node. Bandwidth Test - Tests the bandwidth parameters of the Video Mesh node's network.

  • Read

    Get Network Test results for cluster

    Returns the test results of the Network tests triggered for a single Video Mesh cluster. The tests listed below are run as a part of the Network Test execution on the node. Bandwidth Test - Tests the bandwidth parameters of the Video Mesh node's network.

  • Read

    Get Network Test results for node

    Returns the test results of the Network tests triggered for a single Video Mesh node. The tests listed below are run as a part of the Network Test execution on the node. Bandwidth Test - Tests the bandwidth parameters of the Video Mesh node's network.

  • Read

    List Cluster Client Type Distribution details

    Returns the client type distribution details for all Video Mesh clusters in an organization.

  • Read

    Get Cluster Client Type Distribution details

    Returns the client type distribution details for a single Video Mesh cluster.

  • Read

    List Event Threshold Configuration

    Returns the event threshold configurations for orgId or clusterId, with optional filters eventName and eventScope.

  • Read

    Get Event Threshold Configuration

    Returns the event threshold configurations for eventThresholdId.

  • Write

    Trigger on-demand test for cluster

    Triggers an on-demand test for a cluster. The test is run on a maximum of 10 nodes present in the cluster, chosen at random, or based on input from the user.

  • Write

    Trigger on-demand test for node

    Triggers an on-demand test for a node.

  • Write

    Update Event Threshold Configuration

    Updates an existing event threshold configuration for given Event Threshold IDs.

  • Write

    Reset Event Threshold Configuration

    Resets the existing event threshold configuration for given Event Threshold IDs to default value. To stop receiving webhook events, use the Webhooks API to delete the webhook in question.

Admin Audit Events

  • Read

    List Admin Audit Events

    List admin audit events in your organization. Several query parameters are available to filter the response. Long result sets will be split into pages. NOTE: A maximum of one year of audit events can be returned per request.

  • Read

    List Admin Audit Event Categories

    Get the list of all admin event categories.

Authorizations

  • Read

    List authorizations for a user

    Lists all authorizations for a user. Either personId or personEmail must be provided. This API does not support pagination.

  • Read

    Get expiration status for a token

    Epoch-based expiration time for the token.

  • Destructive

    Delete authorization of org and client ID

    Deletes an authorization by org ID and client ID.

  • Destructive

    Delete authorization

    Deletes an authorization by authorization ID. Specify the authorization Id in the authorizationId parameter in the URI, which was listed in the list resource.

Calling Metrics

  • Read

    Webex Calling Call Quality Stats

    Returns aggregated Webex Calling call and media-quality statistics for the authenticated organization. A call or media session is classified as good quality when all available audio and video quality measurements meet their defined thresholds.

Classifications

  • Read

    List classifications

    List all the space classifications configured in your org.

Data Sources

  • Read

    Retrieve All Data Sources

    Lists all data sources registered by the Service App. Requires the spark-admin:datasourceread scope.

  • Read

    Retrieve Data Source Schemas

    Lists the available data source schemas. A valid API access token is required, but no specific scope is needed.

  • Read

    Retrieve Details of a Specific Data Source Schema

    Retrieves details for a specific data source schema by schema ID. A valid API access token is required, but no specific scope is needed.

  • Read

    Retrieve Data Source Details

    Retrieves details for a data source by ID. Use a Service App token with the spark-admin:datasourceread scope.

  • Write

    Register a Data Source

    Register a data source with the Webex BYODS system. Authenticate using a Service App with the spark-admin:datasourcewrite scope. Schema IDs determine the types of data Webex sends to the DAP and the expected responses.

  • Destructive

    Update a Data Source

    Updates a data source. The fields you can update are audience, subject, nonce, url, and tokenLifetimeMinutes. You can set status from active to disabled only if you provide an errorMessage, which may be shown to the customer administrator in Control Hub.

  • Destructive

    Delete a Data Source

    Deletes a data source by ID. Specify the data source ID in the dataSourceId URI parameter.

Archive Users

  • Read

    Query Archive User

    Retrieves archived user information for the specified organization. Supported attributes are id, which is the unique identifier of a user in the system, and username. It is assigned when the user is created and can be retrieved through GET Users API.

API Domain Management

  • Read

    Get Domain Verification Token

    This endpoint helps generate a token for a given domain within the specified organization. The user needs to add this token as a 'TXT' record to the DNS server. Possible Error: - 409: The request encountered a resource conflict.

  • Write

    Verify Domain

    This endpoint helps verify a given domain within the specified organization. This API verifies domain ownership by looking up and validating the 'TXT' record for the domain. Once verified, domain enforcement will be applied to the organization.

  • Write

    Claim Domain

    This endpoint helps claim the given domain within the specified organization. The domain needs to be verified before it can be claimed. Note There's an organization-level boolean flag called 'enforceVerifiedDomains'.

  • Write

    Unverify Domain

    After you unclaim the domain, it will still be verified. Domain enforcement will still apply to the organization. The unverify endpoint helps to remove the domain ownership verification for the organization. Possible Error: - 400: The request was a Bad Request.

  • Write

    Unclaim Domain

    This API is used to unclaim a domain for the organization. The domain will remain verified, and domain enforcement will still apply to the given organization. Possible Error: - 400: The request was a Bad Request. The domain cannot be unclaimed.

Identity Organization

  • Read

    Get an organization

    Authorization OAuth token rendered by identity broker. One of the following OAuth scopes is required: - identity:organizationsrw - identity:organizationsread

  • Write

    Update an organization

    Authorization OAuth token rendered by identity broker. One of the following OAuth scopes is required: - identity:organizationsrw The following administrators can use this API: - idfulladmin Usage: 1.

  • Write

    Update Organization Authentication Configuration Settings

    Update the authentication configuration details, by organizationID. Specify the organization ID in the orgId parameter in the URI. Authorization OAuth token rendered by identity broker.

  • Write

    Update Organization Password Policy

    Update Organization Password Policy, by organizationID. Specify the organization ID in the orgId parameter in the URI. Authorization OAuth token rendered by identity broker.

  • Write

    Generate OTP

    This API allows an admin to generate a One-Time Password (OTP) for user accounts with userNameType set as partner-upn. The OTP is used by users to log in to any Webex application, whereupon they are asked to change their password.

Groups

  • Read

    List and Search Groups

    List groups in your organization. Set the includeMembers parameter to true to return group members. The total number of members returned is limited to 500. Use the startIndex and count parameters to page through result set. To search for a specific group use the filter parameter.

  • Read

    Get Group Details

    Get details for a group, by ID. Optionally, the members may be retrieved with this request. The maximum number of members returned is 500.

  • Write

    Create a Group

    Create a new group for a given organization. The group may optionally be created with group members.

  • Write

    Update a Group

    Update the group details, by ID. Specify the group ID in the groupId parameter in the URI.

  • Destructive

    Delete a Group

    Remove a group from the system. Specify the group ID in the groupId parameter in the URI.

SCIM 2 Groups

  • Read

    Get Group Members

    Returns the members of a group. - The default maximum number of members returned is 500. - Control parameters are available to page through the members and to control the size of the results. - Long result sets are split into pages.

  • Read

    Search groups

    Retrieve a list of groups in the organization. Long result sets are split into pages. Authorization An OAuth token rendered by Identity Broker.

  • Read

    Get a group

    Retrieve details for a group, by ID. Optionally, members can be retrieved with this request. The maximum number of members returned is 500. Authorization OAuth token rendered by Identity Broker.

  • Write

    Create a group

    Create a new group for a given organization. The group may optionally be created with group members. Authorization OAuth token returned by Identity Broker.

  • Write

    Update a group with PATCH

    Update group attributes with PATCH. Specify the group ID in the groupId parameter in the URI. Authorization OAuth token returned by Identity Broker.

  • Destructive

    Update a group with PUT

    Replace the contents of the Group. Specify the group ID in the groupId parameter in the URI. Authorization OAuth token returned by Identity Broker.

  • Destructive

    Delete a group

    Remove a group from the system. Specify the group ID in the groupId parameter in the URI. Authorization OAuth token rendered by Identity Broker.

Guest Management

  • Read

    Get Guest Count

    To retrieve the number of guests, the scopes guest-issuer:read or guest-issuer:write are needed.

  • Write

    Create a Guest

    Create a new token for a single guest user. The Service App that creates the guest must have the scope guest-issuer:write. Guests are implicitly created by retrieving the guest access token.

Historical Analytics APIs

Hybrid Clusters

  • Read

    List Hybrid Clusters

    List hybrid clusters for an organization. If no orgId is specified, the default is the organization of the authenticated user. Only an admin auth token with the spark-admin:hybridclustersread scope can list clusters.

  • Read

    Get Hybrid Cluster Details

    Shows details for a hybrid cluster, by ID. Only an admin auth token with the spark-admin:hybridclustersread scope can see cluster details.

Hybrid Connectors

  • Read

    List Hybrid Connectors

    List hybrid connectors for an organization. If no orgId is specified, the default is the organization of the authenticated user. Only an admin auth token with the spark-admin:hybridconnectorsread scope can list connectors.

  • Read

    Get Hybrid Connector Details

    Shows details for a hybrid connector, by ID. Only an admin auth token with the spark-admin:hybridconnectorsread scope can see connector details.

Licenses

  • Read

    List Licenses

    List all licenses for a given organization. If no orgId is specified, the default is the organization of the authenticated user. Response properties that are not applicable to the license will not be present in the response.

  • Read

    Get License Details

    Shows details for a license, by ID. Specify the license ID in the licenseId parameter in the URI. Use the optional query parameter includeAssignedTo to get a list of all objects that are assigned with the license.

  • Write

    Assign Licenses to Users

    Assign licenses and attendee siteUrls to existing users. Only an admin can assign licenses. Only existing users can be assigned a license.

Live Monitoring

  • Read

    Get Live Meeting metrics categorized by Country

    Retrieve live meeting metrics categorized by country for a specific meeting site or for all meeting sites owned by the customer. To retrieve live monitoring information, you must use an administrator token with the analytics:readall scope.

Organization Contacts

  • Read

    Get a Contact

    Shows details for an organization contact by ID. Specify the organization ID in the orgId parameter in the URI, and specify the contact ID in the contactId parameter in the URI. NOTE: The orgId used in the path for this API are the org UUIDs.

  • Read

    List Contacts

    List contacts in the organization. The default limit is 100. keyword can be the value of "displayName", "firstName", "lastName", "email". An empty string of keyword means get all contacts. groupIds is a comma separated list group IDs.

  • Write

    Create a Contact

    Creating a new contact for a given organization requires an org admin role.

  • Write

    Update a Contact

    Update details for contact by ID. Only an admin can update a contact. Specify the organization ID in the orgId parameter in the URI, and specify the contact ID in the contactId parameter in the URI.

  • Write

    Bulk Create or Update Contacts

    Create or update contacts in bulk. Update an existing contact by specifying the contact ID in the contactId parameter in the request body.

  • Write

    Bulk Delete Contacts

    Delete contacts in bulk.

  • Destructive

    Delete a Contact

    Remove a contact from the organization. Only an admin can remove a contact. Specify the organization ID in the orgId parameter in the URI, and specify the contact ID in the contactId parameter in the URI.

Organizations

  • Read

    List Organizations

    List all organizations visible by your account. The results will not be paginated.

  • Read

    Get Organization Details

    Shows details for an organization, by ID. Specify the org ID in the orgId parameter in the URI.

  • Destructive

    Delete Organization

    Deletes an organization, by ID. It may take up to 10 minutes for the organization to be deleted after the response is returned. Specify the org ID in the orgId parameter in the URI.

Partner Administrators

  • Read

    Get all customers managed by a partner admin

    Get all customer organizations managed by given partner admin, in the managedBy request parameter. The managedBy user typically has the role of a Partner Admin.

  • Read

    Get all partner admins assigned to a customer

    For a given customer, get all the partner admins with their role details. This does not include partner admins who have access through Customer Groups. This API can be used by Partner Full Admins. Specify the orgId in the path parameter.

  • Write

    Assign partner admin to a customer

    Assign a specific Partner Admin to a customer organization. The partner admin is a user that has the Partner Administrator role. Other partner roles, such as Partner Full Administrator are not applicable for this API, since this role manages all customer organizations.

  • Destructive

    Unassign partner admin from a customer

    Unassign a specific partner admin from a customer organization. Unassigning a customer organization from a partner admin does not remove the role from the user.

  • Destructive

    Revoke all partner admin roles for a given person ID

    Revoke all partner administrator roles from a user, thereby revoking access to Partner Hub and all managed customer organizations. This action does not grant or revoke Control Hub administrator roles (e.g. Full Administrator, User and Device Administrator, etc.).

Usage Reports

  • Read

    List usage reports

    Retrieves a list of usage reports for the organization. Supports optional filtering by resource type and creation date range. Each report has a reportId and may contain one or more generated files in reportFiles[].

  • Read

    Get available resource types

    Returns the list of available resource types that can be used for report generation, along with available data dates.

  • Read

    Get usage report details

    Retrieves detailed information for a specific usage report.

  • Read

    Download usage report file

    Downloads one completed report file as a binary stream. Use the fileId returned in the report's reportFiles array. A reportId identifies the overall report and cannot be used with this endpoint.

  • Write

    Create usage report

    Creates a new usage report for the specified organization, resource type, and date range. The report is generated asynchronously in the background. A single usage report (reportId) is always created for each request.

  • Destructive

    Delete usage report

    Deletes the specified usage report and its associated file. This operation cannot be undone.

Partner Reports/Templates

  • Read

    List Report Templates

    List report templates. Report templates are available for use with the Partner Reports API. To access this endpoint, you must use an administrator token with spark-admin:reportsread and identity:peopleread scopes.

  • Write

    Create a Report

    Create a new report. A new report can be created using templateId available from the List Report Templates API. For each templateId, there are a set of validation rules that need to be followed. The templateId parameter is a number. However, it is a limitation of developer.webex.

Reports

  • Read

    Get Report Details

    Shows details for a report, by report ID. Specify the report ID in the reportId parameter in the URI. Notes: CSV reports for Webex suite services are only supported for organizations based in the North American region.

  • Write

    Create a Report

    Create a new report. For each templateId, there are a set of validation rules that need to be followed. For example, for templates belonging to Webex, the user needs to provide siteUrl. These validation rules can be retrieved via the Report Templates API.

  • Destructive

    Delete a Report

    Remove a report from the system. Specify the report ID in the reportId parameter in the URI CSV reports for Webex suite services are only supported for organizations based in the North American region.

Report Templates

  • Read

    List Report Templates

    List all the available report templates that can be generated. CSV (comma separated value) reports for Webex services are only supported for organizations based in the North American region. Organizations based in other regions will return blank CSV files for any Webex reports.

Resource Group Memberships

  • Read

    List Resource Group Memberships

    Lists all resource group memberships for an organization. Use query parameters to filter the response.

  • Read

    List Resource Group Memberships V2

    Lists all resource group memberships for an organization having filtering option based on entity type (User / Workspace). Use query parameters to filter the response.

  • Read

    Get Resource Group Membership Details

    Shows details for a resource group membership, by ID. Specify the resource group membership ID in the resourceGroupMembershipId URI parameter.

  • Destructive

    Update a Resource Group Membership

    Updates a resource group membership, by ID. Specify the resource group membership ID in the resourceGroupMembershipId URI parameter. Only the resourceGroupId can be changed with this action. Resource group memberships with a status of "pending" cannot be updated.

Resource Groups

  • Read

    List Resource Groups

    List resource groups. Use query parameters to filter the response.

  • Read

    Get Resource Group Details

    Shows details for a resource group, by ID. Specify the resource group ID in the resourceGroupId parameter in the URI.

Roles

  • Read

    List Roles

    List all roles. Must be called by an admin user.

  • Read

    Get Role Details

    Shows details for a role, by ID. Specify the role ID in the roleId parameter in the URI.

Bulk Manage SCIM 2 Users and Groups

  • Write

    User bulk API

    Authorization OAuth token rendered by Identity Broker. One of the following OAuth scopes is required: - identity:peoplerw Usage: 1. The input JSON must conform to the following schema: 'urn:ietf:params:scim:api:messages:2.0:BulkRequest'. 1.

SCIM 2 Schemas

  • Read

    Get Group Schema

    This API allows the service client to get all the Group schemas information from CI. Authorization: OAuth token rendered by Identity Broker.

  • Read

    Get User Schema

    This API allows the service client to get all the User schemas information from CI. Authorization: OAuth token rendered by Identity Broker.

  • Read

    Get Schema using Group Schema ID

    This API allows the service client to get the Group/User Schema using Schema Id from CI. Example: - urn:ietf:params:scim:schemas:core:2.0:Group is one of the Group Schema Id. Using this particular ID, we can fetch all information related to it.

SCIM 2 Users

  • Read

    Search users

    Authorization OAuth token rendered by Identity Broker. One of the following OAuth scopes is required: - identity:peoplerw - identity:peopleread The following administrators can use this API: - idfulladmin - iduseradmin - idreadonlyadmin - iddeviceadmin

  • Read

    Get a user

    Authorization OAuth token rendered by Identity Broker. One of the following OAuth scopes is required: - identity:peoplerw - identity:peopleread The following administrators can use this API: - idfulladmin - iduseradmin - idreadonlyadmin - iddeviceadmin

  • Read

    Get Me

    Authorization OAuth token rendered by Identity Broker. One of the following OAuth scopes is required: - identity:peoplerw - identity:peopleread The API can be used by any user to retrieve user information using their own access token.

  • Write

    Create a user

    The SCIM 2 /Users API provides a programmatic way to manage users in Webex Identity using The Internet Engineering Task Force standard SCIM 2.0 standard as specified by RFC 7643 SCIM 2.0 Core Schema and RFC 7644 SCIM 2.0 Core Protocol.

  • Write

    Update a user with PATCH

    Authorization OAuth token rendered by Identity Broker. One of the following OAuth scopes is required: - identity:peoplerw The following administrators can use this API: - idfulladmin - iduseradmin Usage: 1.

  • Destructive

    Update a user with PUT

    Authorization OAuth token rendered by Identity Broker. One of the following OAuth scopes is required: - identity:peoplerw The following administrators can use this API: - idfulladmin - iduseradmin Usage: 1.

  • Destructive

    Delete a user

    Authorization OAuth token rendered by Identity Broker. One of the following OAuth scopes is required: - identity:peoplerw The following administrators can use this API: - idfulladmin - iduseradmin

Security Audit Events

  • Read

    List Security Audit Events

    List Security Audit Events. This API currently returns user sign-in and sign-out data. To call this API the audit:eventsread scope must be selected for the Integration or Service App and authorized by a Full Admin. Several query parameters are available to filter the response.

Send Activation Email

  • Read

    Get Bulk Activation Email Resend Job Status

    Get the details of an activation email resend job by its job ID. Requires a full or user administrator auth token with a scope of spark-admin:peoplewrite or read-only administrator auth token with a scope of spark-admin:peopleread.

  • Read

    Get Bulk Activation Email Resend Job Errors

    Get errors of an activation email resend job by its job ID. Requires a full or user administrator auth token with a scope of spark-admin:peoplewrite or read-only administrator auth token with a scope of spark-admin:peopleread.

  • Write

    Initiate Bulk Activation Email Resend Job

    Initiate a bulk activation email resend job that sends an activation email to all eligible users in an organization. Only a single instance of the job can be running for an organization. Requires a full or user administrator auth token with a scope of spark-admin:peoplewrite.

Service Apps

  • Write

    Create Service App Access Token

    Retrieves an organization specific token pair for an already authorized Service App. Service Apps use machine accounts to make API calls on behalf of an organization, independent of individual user life cycles.

Settings

  • Read

    Get an Organization Setting

    This endpoint retrieves the specified setting for the given organization and is accessible with the scope 'identity:organizationsread'.

  • Write

    Create or Update an Organization Setting

    This endpoint creates or updates the specified setting for the given organization; however, the 'name' of the setting cannot be modified. It is accessible with the scope 'identity:organizationsrw'.

Partner Tags

  • Read

    Retrieve all customer tags

    Retrieves all tags which are being used by any customer organizations. Once a tag is unassigned from the last customer, it is automatically removed and is not returned by this API. This API can be used by a partner full admin, a read-only partner, or an partner admin.

  • Read

    Get customer organization's tags

    Retrieve tags associated with a customer organization based on the orgId provided. This API can be used by a partner full admin, a read-only partner, or an partner admin. Specify the customer orgId in the orgId parameter in the URI.

  • Read

    Fetch all customers for a given set of tags

    For a set of tags, retrieve all customer organizations that match any one of the tags. This API can be used by a partner full admin, a read-only partner, or an partner admin.

  • Read

    Subscription List on a given tag name or a set of tags

    For a partner organization fetch all it's subscriptions with their tag list for a given tag names. This API can be used by partner full admins, partner admins and admin read-only partners.

  • Read

    Fetch a Subscription

    For a given partner org, customer org and external subscription id, fetch subscription details with its associated tags. This API can be used by partner full admins, partner admins and admin read-only partners.

  • Write

    Create or Replace existing customer tags with the provided ones

    Assign or replace tag(s) which for a customer organization. If the tag doesn't already exist, a new one is created and assigned to the customer automatically. This API can be used by partner full admins and partner admins. Each tag has a character limit of 25.

  • Write

    Create or Replace existing subscription tags with the provided ones

    Assign or replace tags specific to each subscription for an organization. Each organization may have one or more subscriptions. This API can be used by partner full admins and partner admins. Currently there is a limit of 5 tags per subscription when creating tags.

Workspace Metrics

  • Read

    Workspace Metrics

    Get metric data for the specified workspace and metric name, optionally aggregated over a specified time period. The workspaceId and metricName parameters indicate which workspace to fetch metrics for and what kind of metrics to get.

  • Read

    Workspace Duration Metrics

    Get metrics for how much time a workspace has been in the state given by the measurement parameter. For example, if the measurement is timeBooked then the duration for which the workspace has been booked is returned.

Device Call Settings

  • Read

    Get Device Members

    Get the list of all the members of the device including primary and secondary users. A device member can be either a person or a workspace. An admin can access the list of member details, modify member details and search for available members on a device.

  • Read

    Search Members

    Search members that can be assigned to the device. A device member can be either a person or a workspace. A admin can access the list of member details, modify member details and search for available members on a device.

  • Read

    Get Count of Members

    Get the count of members that can be assigned to the device. A device member can be either a person or a workspace. This requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Get Count of Available Members

    Get the count of members that can be assigned to devices. A device member can be either a person or a workspace. This requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Get Device Settings

    Get override settings for a device. Device settings lists all the applicable settings for MPP, ATA and Wifi devices at the device level. An admin can also modify the settings. DECT devices do not support settings at the device level.

  • Read

    Get Location Device Settings

    Get device override settings for a location. This requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Get Webex Calling Device Details

    Not supported for Webex for Government (FedRAMP) Retrieves Webex Calling device details that include information needed for third-party device management. Webex calling devices are associated with a specific user Workspace or Virtual Line.

  • Read

    Get Person Devices

    Get all devices for a person. This requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Get Workspace Devices

    Get all devices for a workspace. This requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Read the device override settings for a organization

    Get device override settings for an organization. Retrieving this list requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Read the list of Line Key Templates

    List all Line Key Templates available for this organization. Line Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display.

  • Read

    Get details of a Line Key Template

    Get detailed information about a Line Key Template by template ID in an organization. Line Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display.

  • Read

    Preview Apply Line Key Template

    Preview the number of devices that will be affected by the application of a Line Key Template or when resetting devices to their factory Line Key settings. Line Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display.

  • Read

    Get List of Apply Line Key Template jobs

    Get the list of all apply line key templates jobs in an organization. Line Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display.

  • Read

    Get the job status of an Apply Line Key Template job

    Get the status of an apply line key template job by its job ID. Line Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display.

  • Read

    Get job errors for an Apply Line Key Template job

    GET job errors for an apply Line Key Template job in an organization. Line Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display.

  • Read

    Read the DECT device type list - Deprecated

    Not supported for Webex for Government (FedRAMP). The REST path for this API has changed to [GET /telephony/config/devices/dectNetworks/supportedDevices{?orgId}]. The use of this old REST path is deprecated and will be decommissioned on October 10, 2024.

  • Read

    Read the DECT device type list

    Not supported for Webex for Government (FedRAMP). Get DECT device type list with base stations and line ports supported count. This is a static list. Retrieving this list requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Validate a list of MAC address

    Validate a list of MAC addresses. Validating this list requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Read

    List Change Device Settings Jobs

    List change device settings jobs. Lists all the jobs for jobType calldevicesettings for the given organization in order of most recent one to oldest one irrespective of its status.

  • Read

    Get Change Device Settings Job Status

    Get change device settings job status. Provides details of the job with jobId of jobType calldevicesettings. This API requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    List Change Device Settings Job Errors

    List change device settings job errors. Lists all error details of the job with jobId of jobType calldevicesettings. This API requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Get Device Layout by Device ID

    Get layout information of a device by device ID in an organization. Device layout customizes a user’s programmable line keys (PLK) on the phone and any attached Key Expansion Modules (KEM) with the existing configured line members and the user’s monitoring list.

  • Read

    List Rebuild Phones Jobs

    Not supported for Webex for Government (FedRAMP) . Get the list of all Rebuild Phones jobs in an organization. Rebuild phones jobs are used when there is a change in the network configuration of phones in a location, i.e.

  • Read

    Get the Job Status of a Rebuild Phones Job

    Not supported for Webex for Government (FedRAMP) . Get the details of a rebuild phones job by its job ID. Rebuild phones jobs are used when there is a change in the network configuration of phones in a location, i.e.

  • Read

    Get Job Errors for a Rebuild Phones Job

    Not supported for Webex for Government (FedRAMP) . Get errors for a rebuild phones job in an organization. Rebuild phones jobs are used when there is a change in the network configuration of phones in a location, i.e.

  • Read

    Get Device Settings for a Person

    Device settings list the compression settings for a person. Device settings customize a device's behavior and performance. The compression field optimizes call quality for inbound and outbound calls.

  • Read

    Get Device Settings for a Workspace

    Device settings list the compression settings for a workspace. Device settings customize a device's behavior and performance. The compression field optimizes call quality for inbound and outbound calls.

  • Read

    Read the List of Background Images

    Gets the list of device background images for an organization. Webex Calling supports the upload of up to 100 background image files for each org. These image files can then be referenced by MPP phones in that org for use as their background image.

  • Read

    Get User Devices Count

    Get the total device and application count for a person. The device count can be used to determine if more devices can be added for users with a device count limit. For example, users with standard calling licenses can only have one physical device.

  • Write

    Apply Changes for a specific device

    Issues request to the device to download and apply changes to the configuration. Applying changes for a specific device requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Write

    Create a Line Key Template

    Create a Line Key Template in this organization. Line Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display.

  • Write

    Apply a Line Key Template

    Apply a Line Key Template or reset devices to their factory Line Key settings. Line Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display.

  • Write

    Change Device Settings Across Organization Or Location Job

    Change device settings across organization or locations jobs. Performs bulk and asynchronous processing for all types of device settings initiated by organization and system admins in a stateful persistent manner.

  • Write

    Rebuild Phones Configuration

    Not supported for Webex for Government (FedRAMP) . Rebuild all phone configurations for the specified location. Rebuild phones jobs are used when there is a change in the network configuration of phones in a location, i.e.

  • Write

    Upload a Device Background Image

    Configure a device's background image by uploading an image with file format, .jpeg or .png, encoded image file. Maximum image file size allowed to upload is 625 KB.

  • Destructive

    Update Members on the device

    Modify member details on the device. A device member can be either a person, virtual line or a workspace. An admin can access the list of member details, modify member details and search for available members on a device.

  • Destructive

    Update device settings

    Modify override settings for a device. Device settings list all the applicable settings for an MPP and an ATA devices at the device level. Admins can also modify the settings. NOTE: DECT devices do not support settings at the device level.

  • Destructive

    Update Third Party Device

    Not supported for Webex for Government (FedRAMP) Modify a device's sipPassword. Updating sipPassword on the device requires a full or user administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Modify Hoteling Settings for a Person's Primary Devices

    Modify hoteling login configuration on a person's Webex Calling Devices which are in effect when the device is the user's primary device and device type is PRIMARY. To view the current hoteling login settings, see the hoteling field in Get Person Devices.

  • Destructive

    Modify Workspace Devices

    Modify devices for a workspace. Modifying devices for a workspace requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Modify a Line Key Template

    Modify a Line Key Template by its template ID in an organization. Line Keys, also known as Programmable Line Keys (PLK), are the keys found on either side of a typical desk phone display.

  • Destructive

    Delete a Line Key Template

    Delete a Line Key Template by its template ID in an organization. Line Keys also known as Programmable Line Keys (PLK) are the keys found on either sides of a typical desk phone display.

  • Destructive

    Modify Device Layout by Device ID

    Modify the layout of a device by device ID in an organization. Device layout customizes a user’s programmable line keys (PLK) on the phone and any attached Key Expansion Modules (KEM) with the existing configured line members and the user’s monitoring list.

  • Destructive

    Update Device Settings for a Person

    Update device settings modifies the compression settings for a person. Device settings customize a device's behavior and performance. The compression field optimizes call quality for inbound and outbound calls.

  • Destructive

    Update Device Settings for a Workspace

    Update device settings modifies the compression settings for a workspace. Device settings customize a device's behavior and performance. The compression field optimizes call quality for inbound and outbound calls.

  • Destructive

    Delete Device Background Images

    Delete the list of designated device background images for an organization. Maximum is 10 images per request. Deleting a device background image requires a full or device administrator auth token with a scope of spark-admin:telephonyconfigwrite.

Device Call Settings With Device Dynamic Settings

  • Read

    Read the List of Supported Devices

    Gets the list of supported devices for an organization. Retrieving this list requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Get Settings Groups

    This API returns the settingsGroups that define the structure and association of tags for device dynamic settings. The settingsGroups are used to organize the tags into logical groups, making it easier to manage and configure device dynamic settings.

  • Read

    Get Customer Device Dynamic Settings

    Retrieve dynamic settings for specific device tags at customer level, allowing filters by familyOrModelDisplayName and tag identifier. This API lets you request the values of multiple Device Settings at once by specifying a list of familyOrModelDisplayName and tag combinations.

  • Read

    Get Location Device Dynamic Settings

    Retrieve dynamic settings for specific device tags at the specified location level, allowing filters by familyOrModelDisplayName and tag identifier.

  • Read

    Get Device Dynamic Settings

    Retrieve settings for a specified device. This API retrieves device settings based on the specified tags; if the tags field is empty or missing, all settings for the device are returned.

  • Read

    List Device Dynamic Settings Jobs

    List device dynamic settings jobs. Lists all the jobs for job type dynamicdevicesettings for the given organization in order of most recent one to oldest one irrespective of its status.

  • Read

    Get Device Dynamic Settings Job Status

    Get device dynamic settings job status. Provides details of the job with jobId of jobType dynamicdevicesettings. This API requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    List Device Dynamic Settings Job Errors

    List Update device dynamic settings job errors. Lists all error details of the job with jobId of jobType dynamicdevicesettings. This API requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Write

    Update Device Dynamic Settings Across Organization or Location

    Creates a job to update device settings at location or organization level. The job runs asynchronously and persistently, applying the requested settings in bulk to all relevant devices, which may belong to multiple families as specified in the request.

  • Destructive

    Update Device Dynamic Settings

    Modify dynamic settings for a specified device. This API updates device settings based on the specified tags. If the tags field is empty, the request has no effect.

Beta Device Call Settings With Dynamic Device Settings

  • Read

    Get Validation Schema

    This API returns the validation schema for tags of all or specific familyOrModelDisplayName. The schema is used to validate the tag for devices in the Webex Calling platform.

Device Configurations

  • Read

    List Device Configurations for device

    Lists all device configurations associated with the given device ID. Administrators can list configurations for all devices within an organization.

  • Write

    Update Device Configurations

    Edit configurations for the device specified by device ID.

Devices

  • Read

    List Devices

    Lists all active Webex devices associated with the authenticated user, such as devices activated in personal mode. This requires the spark:devicesread scope. Administrators can list all devices within their organization.

  • Read

    Get Device Details

    Shows details for a device, by ID. This requires an auth token with the spark:devicesread scope to see your own device, or spark-admin:devicesread to see any other device in your organization. Specify the device ID in the deviceId parameter in the URI.

  • Write

    Create a Device by MAC Address

    Create a phone by its MAC address in a specific workspace or for a person. Specify the mac, model and either workspaceId or personId. You can get the model from the supported devices API. Either workspaceId or personId should be provided.

  • Write

    Modify Device Tags

    Create, delete or update tags on a device. For your own device, this requires an auth token with the spark:deviceswrite scope. An auth token with the spark-admin:deviceswrite scope is required to operate on other devices within the organization.

  • Write

    Create a Device Activation Code

    Generate an activation code for a device in a specific workspace by workspaceId or for a person by personId.

  • Destructive

    Delete a Device

    Deletes a device, by ID. Deleting your own device requires an auth token with the spark:deviceswrite scope. Deleting any other device in the organization will require an administrator auth token with the spark-admin:deviceswrite scope.

Hot Desk

  • Read

    List Sessions

    List hot desk sessions. Use query parameters to filter the response. The orgId parameter is for use by partner administrators acting on a managed organization.

  • Destructive

    Delete Session

    Delete a hot desk session.

Locations

  • Read

    List Locations

    List locations for an organization. Use query parameters to filter the result set by location name, ID, or organization. Long result sets will be split into pages.

  • Read

    Get Location Details

    Shows details for a location, by ID. Specify the location ID in the locationId parameter in the URI. Use query parameter orgId to filter the result set by organization(optional).

  • Read

    List Location Floors

    List location floors. Requires an administrator auth token with the spark-admin:locationsread scope.

  • Read

    Get Location Floor Details

    Shows details for a floor, by ID. Specify the floor ID in the floorId parameter in the URI. Requires an administrator auth token with the spark-admin:locationsread scope.

  • Write

    Create a Location

    Create a new Location for a given organization. Only an admin in the organization can create a new Location. Creating a location in your organization requires a full administrator auth token with a scope of spark-admin:locationswrite.

  • Write

    Create a Location Floor

    Create a new floor in the given location. The displayName parameter is optional, and omitting it will result in the creation of a floor without that value set. Requires an administrator auth token with the spark-admin:locationswrite scope.

  • Destructive

    Update a Location

    Update details for a location, by ID. Updating a location in your organization requires a full administrator or location administrator auth token with a scope of spark-admin:locationswrite. Specify the location ID in the locationId parameter in the URI.

  • Destructive

    Delete Location

    Delete a location, by ID. Specify the location ID in the locationId parameter in the URI. Deleting a location in your organization requires a full administrator auth token with a scope of spark-admin:locationswrite.

  • Destructive

    Update a Location Floor

    Updates details for a floor, by ID. Specify the floor ID in the floorId parameter in the URI. Include all details for the floor returned by a previous call to Get Location Floor Details.

  • Destructive

    Delete a Location Floor

    Deletes a floor, by ID. Requires an administrator auth token with the spark-admin:locationswrite scope.

Workspace Personalization

  • Read

    Get Personalization Task

    Returns the status of a personalization task for a given workspace. Whilst in progress the endpoint will return Accepted and provide a Retry-After header indicating the number of seconds a client should wait before retrying.

  • Write

    Personalize a Workspace

    Initializes the personalization for a given workspace for the user email provided. The personalization process is asynchronous and thus a background task is created when this endpoint is invoked.

Workspaces

  • Read

    List Workspaces

    List workspaces. Use query parameters to filter the response. The orgId parameter can only be used by admin users of another organization (such as partners).

  • Read

    Get Workspace Details

    Shows details for a workspace, by ID. The locationId, workspaceLocationId, floorId, indoorNavigation, capacity, type and notes fields will only be present if they have been set for the workspace. Specify the workspace ID in the workspaceId parameter in the URI.

  • Read

    Get Workspace Capabilities

    Shows the capabilities for a workspace by ID. Returns a set of capabilities, including whether or not the capability is supported by any device in the workspace, and if the capability is configured (enabled).

  • Destructive

    Update a Workspace

    Updates details for a workspace by ID. Specify the workspace ID in the workspaceId parameter in the URI. Include all details for the workspace that are present in a GET request for the workspace details.

  • Destructive

    Delete a Workspace

    Deletes a workspace by ID. Also deletes all devices associated with the workspace. Any deleted devices will need to be reactivated. Specify the workspace ID in the workspaceId parameter in the URI.

Journey Workspace management API

  • Read

    Get Workspace

    Get workspace details. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:adminorgread or cjds:adminorgwrite scopes or cjp:configread or cjp:configwrite scopes

  • Read

    Get All Workspaces

    Get All Workspaces. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:adminorgread or cjds:adminorgwrite scopes or cjp:configread or cjp:configwrite scopes

  • Write

    Create Workspace

    Create Workspace in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope.It requires the appropriate cjds:adminorgwrite or cjp:configwrite scopes

  • Destructive

    Update Workspace

    Update workspace by Id. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:adminorgwrite or cjp:configwrite scopes

  • Destructive

    Delete Workspace

    Delete Workspace By Id. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:adminorgwrite or cjp:configwrite scopes

X API

  • Read

    Query Status

    Query the current status of the Webex RoomOS Device. You specify the target device in the deviceId parameter in the URI. The target device is queried for statuses according to the expression in the name parameter.

  • Read

    Query Schema

    Query the schema for statuses and commands of Webex RoomOS Devices. You specify the target devices in the deviceId parameter in the URI. Querying command schemas requires the spark:xapicommands scope and querying status schemas requires the spark:xapistatuses scope.

  • Write

    Execute Command

    Executes a command on the Webex RoomOS Device. Specify the command to execute in the commandName URI parameter. See the xAPI section of the Device Developers Guide for a description of command expressions.

DECT Devices Settings

  • Read

    Get the List of DECT Networks for an Organization

    Retrieves the list of DECT networks for an organization. DECT Networks provide roaming voice services via base stations and wireless handsets. A DECT network can be provisioned up to 1000 lines across up to 254 base stations.

  • Read

    Get DECT Network Details

    Retrieves the details of a DECT network. DECT Networks provide roaming voice services via base stations and wireless handsets. A DECT network can be provisioned up to 1000 lines across up to 254 base stations.

  • Read

    Get a List of DECT Network Base Stations

    Retrieve a list of base stations in a DECT Network. A DECT network supports 2 types of base stations, DECT DBS-110 Single-Cell and DECT DBS-210 Multi-Cell. A DECT DBS-110 allows up to 30 lines of registration and supports 1 base station only.

  • Read

    Get the Details of a Specific DECT Network Base Station

    Retrieve details of a specific base station in the DECT Network. A DECT network supports 2 types of base stations, DECT DBS-110 Single-Cell and DECT DBS-210 Multi-Cell. A DECT DBS-110 allows up to 30 lines of registration and supports 1 base station only.

  • Read

    Get List of Handsets for a DECT Network ID

    List all the handsets associated with a DECT Network ID. A handset can have up to two lines, and a DECT network supports a total of 120 lines across all handsets.

  • Read

    Get Specific DECT Network Handset Details

    List the specific DECT Network handset details. A handset can have up to two lines, and a DECT network supports a total of 120 lines across all handsets.

  • Read

    GET List of DECT Networks Associated with a Person

    Retrieves the list of DECT networks for a person in an organization. DECT Network provides roaming voice services via base stations and wireless handsets. DECT network can be provisioned up to 1000 lines across up to 254 base stations.

  • Read

    GET List of DECT Networks Associated with a Workspace

    Retrieves the list of DECT networks for a workspace in an organization. DECT Network provides roaming voice services via base stations and wireless handsets. DECT network can be provisioned up to 1000 lines across up to 254 base stations.

  • Read

    Search Available Members

    List the members that are available to be assigned to DECT handset lines. DECT handset lines can be assigned to people, places, or virtual lines within the organization. This API helps administrators identify which members are eligible for assignment to DECT devices.

  • Read

    Get DECT Serviceability Password Status

    Retrieves the DECT serviceability password status. If the serviceability password is enabled but has not been generated, the enabled status will be returned as true even though there is no active serviceability password.

  • Write

    Create a DECT Network

    Create a multi-cell DECT network for a given location. DECT networks enable wireless communication for DECT devices within a location, allowing multiple base stations to provide coverage across a larger area.

  • Write

    Create Multiple Base Stations

    This API is used to create multiple base stations in a DECT network in an organization. Base stations provide wireless connectivity for DECT handsets and extend the coverage area of a DECT network.

  • Write

    Add a Handset to a DECT Network

    Add a handset to a DECT network in a location in an organization. Adding a handset to a DECT network requires a full or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Write

    Add a List of Handsets to a DECT Network

    Add a list of up to 50 handsets to a DECT network in a location. A DECT network acts as a container that can support up to 1,000 lines across all handsets, with each handset capable of handling up to two lines.

  • Write

    Generate and Enable DECT Serviceability Password

    Generates and enables a 16-character DECT serviceability password. Generating a password and transmitting it to the DECT network can reboot the entire network. Be sure you choose an appropriate time to generate a new password.

  • Destructive

    Update DECT Network

    Update the details of a DECT network. debugLevel will not be supported in this API; use Update DECT Network Debug Level API for changing the debug level. DECT Networks provide roaming voice services via base stations and wireless handsets.

  • Destructive

    Delete DECT Network

    Delete a DECT network. DECT Networks provide roaming voice services via base stations and wireless handsets. A DECT network can be provisioned up to 1000 lines across up to 254 base stations.

  • Destructive

    Update DECT Network Debug Level

    Update the debug level for a DECT network. The debug level controls the verbosity of logging for the DECT network. Setting it to DEBUG enables detailed diagnostic logging, while STANDARD provides normal operational logging.

  • Destructive

    Delete Bulk DECT Network Base Stations

    Delete all the base stations in the DECT Network. A DECT network supports 2 types of base stations, DECT DBS-110 Single-Cell and DECT DBS-210 Multi-Cell. A DECT DBS-110 allows up to 30 lines of registration and supports 1 base station only.

  • Destructive

    Delete a Specific DECT Network Base Station

    Delete a specific base station in the DECT Network. A DECT network supports 2 types of base stations, DECT DBS-110 Single-Cell and DECT DBS-210 Multi-Cell. A DECT DBS-110 allows up to 30 lines of registration and supports 1 base station only.

  • Destructive

    Update DECT Network Handset

    Update the line assignment on a handset. A handset can have up to two lines, and a DECT network supports a total of 120 lines across all handsets.

  • Destructive

    Delete Specific DECT Network Handset Details

    Delete a specific DECT Network handset. A handset can have up to two lines, and a DECT network supports a total of 120 lines across all handsets.

  • Destructive

    Delete Multiple Handsets

    Delete multiple handsets or all of them. A handset can have up to two lines, and a DECT network supports a total of 120 lines across all handsets.

  • Destructive

    Update DECT Serviceability Password Status

    Enables or disables the DECT serviceability password. Enabling or disabling the password and transmitting it to the DECT network can reboot the entire network. Be sure you choose an appropriate time for this action.

AI Receptionist for Webex Calling

  • Read

    List AI Receptionists

    Get list of AI Receptionists. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services. These APIs let administrators manage AI receptionist resources across organizations and locations.

  • Read

    Validate Country for AI Receptionist

    Validates if country passed in the request supports AI Receptionist. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Read

    List AI Receptionist Templates

    Get AI Receptionist template list. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Templates help standardize greetings, goals, and guidelines. Returns all templates in a single response.

  • Read

    Get AI Receptionist Template Details

    Get AI Receptionist template details. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Use templates to define goals, messages, and guidelines.

  • Read

    Validate AI Receptionist

    Validates AI Receptionist name at location level and max limit at org level. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Read

    List Available Numbers for AI Receptionist

    List and search numbers that can be assigned as AI Receptionist number. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Numbers listed here can be assigned to an AI receptionist at a location.

  • Read

    Get AI Receptionist Details

    Get AI Receptionist details. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services. This API requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Get AI Receptionist Voices

    Get list of available AI Receptionist voices. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. This API returns the available voice options that can be configured for an AI Receptionist.

  • Read

    List AI Receptionist Intents

    Get list of AI Receptionist Intents. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent call-handling behaviors such as transfers. Returns all intents in a single response.

  • Read

    Get AI Receptionist Intent

    Get details of a specific AI Receptionist Intent. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent call-handling behaviors such as transfers.

  • Read

    List Knowledge Bases

    Get list of Knowledge Bases for an organization. Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries. This API returns all knowledge bases available in the organization.

  • Read

    Get Knowledge Base Details

    Get details of a specific Knowledge Base. Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries. This API requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    List Knowledge Base Documents

    Get list of documents in a Knowledge Base. Documents are files uploaded to a Knowledge Base that AI Receptionists use to answer caller queries. This API requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Get Knowledge Base Document Details

    Get details of a specific document in a Knowledge Base. Documents are content entries in a Knowledge Base that AI Receptionists use to answer caller queries. This API returns document metadata including name, content, status, and timestamps.

  • Read

    Download Knowledge Base Document

    Download a document from a Knowledge Base. Documents are files uploaded to a Knowledge Base that AI Receptionists use to answer caller queries. The response contains the file content with appropriate Content-Type and Content-Disposition headers.

  • Write

    Create an AI Receptionist

    Create a new AI Receptionist for a location. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Write

    Create AI Receptionist Intent

    Create a new AI Receptionist Intent. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent call-handling behaviors such as transfers.

  • Write

    Create a Knowledge Base

    Create a new Knowledge Base for an organization. Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Write

    Create Knowledge Base Document

    Create a new document in a Knowledge Base. Documents are content entries in a Knowledge Base that AI Receptionists use to answer caller queries. This API creates a document with specified name and content.

  • Write

    Upload Knowledge Base Document

    Upload a document to a Knowledge Base. Documents are files uploaded to a Knowledge Base that AI Receptionists use to answer caller queries. Supported file types include PDF, TXT, DOCX, XLSX, XLS, and CSV.

  • Destructive

    Update an AI Receptionist

    Update an AI Receptionist. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Delete an AI Receptionist

    Delete an AI Receptionist. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Modify AI Receptionist Intent

    Modify an existing AI Receptionist Intent. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent call-handling behaviors such as transfers.

  • Destructive

    Delete AI Receptionist Intent

    Delete an AI Receptionist Intent. AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent call-handling behaviors such as transfers.

  • Destructive

    Modify a Knowledge Base

    Modify an existing Knowledge Base. Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Delete a Knowledge Base

    Delete a Knowledge Base. Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Modify Knowledge Base Document

    Modify a document in a Knowledge Base. Documents are content entries in a Knowledge Base that AI Receptionists use to answer caller queries. This API allows updating the name and content of an existing document.

  • Destructive

    Delete Knowledge Base Document

    Delete a document from a Knowledge Base. Documents are files uploaded to a Knowledge Base that AI Receptionists use to answer caller queries. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

Call Controls

  • Read

    Retrieve

    Retrieve a parked call. A new call is initiated to perform the retrieval in a similar manner to the dial command. The number field from the park command response can be used as the destination for the retrieve command.

  • Read

    List Calls

    Get the list of details for all active calls associated with the user.

  • Read

    Get Call Details

    Get the details of the specified active call for the user.

  • Read

    List Call History

    Get the list of call history records for the user. A maximum of 20 call history records per type (placed, missed, received) are returned.

  • Read

    List Call Queue Calls

    List the calls currently in the specified Call Queue. The returned calls follow the same format as the Call Queue events emitted by Webex Calling and include the caller details, position information (priority), and queue timing for each call currently waiting in the queue.

  • Read

    List Calls by Member ID

    Get the list of details for all active calls associated with the member.

  • Read

    Get Call Details by Member ID

    Get the details of the specified active call for the member.

  • Read

    List Call History by Member ID

    Get the list of call history records for the user. A maximum of 20 call history records per type (placed, missed, received) are returned.

  • Read

    Retrieve by Member ID

    Retrieve a parked call. A new call is initiated to perform the retrieval in a similar manner to the dial command. The number field from the park command response can be used as the destination for the retrieve command.

  • Write

    Dial

    Initiate an outbound call to a specified destination. This is also commonly referred to as Click to Call or Click to Dial.

  • Write

    Answer

    Answer an incoming call. When no endpointId is specified, the call is answered on the user's primary device. When an endpointId is specified, the call is answered on the device or application identified by the endpointId.

  • Write

    Reject

    Reject an unanswered incoming call.

  • Write

    Hangup

    Hangup a call. If used on an unanswered incoming call, the call is rejected and sent to busy.

  • Write

    Hold

    Hold a connected call.

  • Write

    Resume

    Resume a held call.

  • Write

    Mute

    Mute a call. This API can only be used for a call that reports itself as mute capable via the muteCapable field in the call details.

  • Write

    Unmute

    Unmute a call. This API can only be used for a call that reports itself as mute capable via the muteCapable field in the call details.

  • Write

    Divert

    Divert a call to a destination or a user's voicemail. This is also commonly referred to as a Blind Transfer.

  • Write

    Transfer

    Transfer two calls together. Unanswered incoming calls cannot be transferred but can be diverted using the divert API.

  • Write

    Park

    Park a connected call. The number field in the response can be used as the destination for the retrieve command to retrieve the parked call.

  • Write

    Start Recording

    Start recording a call. Use of this API is only valid when the user's call recording mode is set to "On Demand".

  • Write

    Stop Recording

    Stop recording a call. Use of this API is only valid when a call is being recorded and the user's call recording mode is set to "On Demand".

  • Write

    Pause Recording

    Pause recording on a call. Use of this API is only valid when a call is being recorded and the user's call recording mode is set to "On Demand" or "Always with Pause/Resume".

  • Write

    Resume Recording

    Resume recording a call. Use of this API is only valid when a call's recording is paused and the user's call recording mode is set to "On Demand" or "Always with Pause/Resume".

  • Write

    Transmit DTMF

    Transmit DTMF digits to a call.

  • Write

    Push

    Pushes a call from the assistant to the executive the call is associated with. Use of this API is only valid when the assistant's call is associated with an executive.

  • Write

    Pickup

    Picks up an incoming call to another user. A new call is initiated to perform the pickup in a similar manner to the dial command. When target is not present, the API pickups up a call from the user's call pickup group.

  • Write

    Barge In

    Barge-in on another user's answered call. A new call is initiated to perform the barge-in in a similar manner to the dial command.

  • Write

    Pull

    Pull a call from one device to another. A temporary new call is initiated to perform the call pull in a similar manner to the dial command. When a user answers an alerting device, the device is connected to the pulled call and the new call created for the call pull is released.

  • Write

    Dial by Member ID

    Initiate an outbound call to a specified destination. This is also commonly referred to as Click to Call or Click to Dial.

  • Write

    Answer by Member ID

    Answer an incoming call. When no endpointId is specified, the call is answered on the user's primary device. When an endpointId is specified, the call is answered on the device or application identified by the endpointId.

  • Write

    Hangup by Member ID

    Hangup a call. If used on an unanswered incoming call, the call is rejected and sent to busy.

  • Write

    Start Recording by Member ID

    Start recording a call. Use of this API is only valid when the user's call recording mode is set to "On Demand".

  • Write

    Stop Recording by Member ID

    Stop recording a call. Use of this API is only valid when a call is being recorded and the user's call recording mode is set to "On Demand".

  • Write

    Pause Recording by Member ID

    Pause recording on a call. Use of this API is only valid when a call is being recorded and the user's call recording mode is set to "On Demand" or "Always with Pause/Resume".

  • Write

    Resume Recording by Member ID

    Resume recording a call. Use of this API is only valid when a call's recording is paused and the user's call recording mode is set to "On Demand" or "Always with Pause/Resume".

  • Write

    Barge In by Member ID

    Barge-in on another user's answered call. A new call is initiated to perform the barge-in in a similar manner to the dial command.

  • Write

    Divert by Member ID

    Divert a call to a destination or a user's voicemail. This is also commonly referred to as a Blind Transfer.

  • Write

    Push by Member ID

    Pushes a call from the assistant to the executive the call is associated with. Use of this API is only valid when the assistant's call is associated with an executive.

  • Write

    Park by Member ID

    Park a connected call. The number field in the response can be used as the destination for the retrieve command to retrieve the parked call.

  • Write

    Pickup by Member ID

    Picks up an incoming call to another user. A new call is initiated to perform the pickup in a similar manner to the dial command. When target is not present, the API pickups up a call from the user's call pickup group.

  • Write

    Pull by Member ID

    Pull a call from one device to another. A temporary new call is initiated to perform the call pull in a similar manner to the dial command. When a user answers an alerting device, the device is connected to the pulled call and the new call created for the call pull is released.

  • Write

    Reject by Member ID

    Reject an unanswered incoming call.

  • Write

    Transfer by Member ID

    Transfer two calls together. Unanswered incoming calls cannot be transferred but can be diverted using the divert API.

  • Write

    Transmit DTMF by Member ID

    Transmit DTMF digits to a call.

External Voicemail

  • Write

    Set or Clear Message Waiting Indicator (MWI) Status

    Enables an external voicemail service to SET or CLEAR the Message Waiting Indicator (MWI) for a person or workspace. Invoke the API using a bearer token from a Service App in the target organization, created by a full admin with the scope spark-admin:callswrite.

  • Write

    Set or Clear Message Waiting Indicator (MWI) Status by Member ID

    Enables an external voicemail service to SET or CLEAR the Message Waiting Indicator (MWI) for a person or workspace. Invoke the API using a bearer token from a Service App in the target organization, created by a full admin with the scope spark-admin:callswrite.

Conference Controls

  • Read

    Get Conference Details

    Get the details of the conference. An empty JSON object body is returned if there is no conference.

  • Read

    Get Conference Details by Member ID

    Get the details of the conference. An empty JSON object body is returned if there is no conference.

  • Write

    Hold by Member ID

    Hold the conference host. There is no request body.

  • Write

    Mute by Member ID

    Mutes the host or a participant. Mutes the host when no request body is provided (i.e. media stream from the host will not be transmitted to the conference). Mutes a participant when the request body contains the participant's call ID (i.e.

  • Write

    Resume by Member ID

    Resumes the held conference host. There is no request body.

  • Write

    Unmute by Member ID

    Unmutes the host or a participant. Unmutes the host when no request body is provided (i.e. media stream from the host will be transmitted to the conference). Unmutes a participant when the request body contains the participant's call ID (i.e.

  • Write

    Start Conference

    Join the user's calls into a conference. A minimum of two call IDs are required. Each call ID identifies an existing call between the user and a participant to be added to the conference.

  • Write

    Add Participant

    Adds a participant to an existing conference. The request body contains the participant's call ID.

  • Write

    Mute

    Mutes the host or a participant. Mutes the host when no request body is provided (i.e. media stream from the host will not be transmitted to the conference). Mutes a participant when the request body contains the participant's call ID (i.e.

  • Write

    Unmute

    Unmutes the host or a participant. Unmutes the host when no request body is provided (i.e. media stream from the host will be transmitted to the conference). Unmutes a participant when the request body contains the participant's call ID (i.e.

  • Write

    Deafen Participant

    Deafens a participant (i.e. media stream will not be transmitted to the participant). The request body contains the call ID of the participant to deafen

  • Write

    Undeafen Participant

    Undeafens a participant (i.e. resume transmitting the conference media stream to the participant). The request body contains the call ID of the participant to undeafen.

  • Write

    Hold

    Hold the conference host. There is no request body.

  • Write

    Resume

    Resumes the held conference host. There is no request body.

  • Write

    Barge In by Member ID

    Transition the member's conference type to barge-in mode. This allows the supervisor to join the conference as a full participant where all parties can hear the supervisor.

  • Write

    Silent Monitor by Member ID

    Transition the member's conference type to silent monitoring mode. This allows the supervisor to listen to the conference without being heard by the other participants.

  • Write

    Supervisor Coach by Member ID

    Transition the member's conference type to supervisor coaching mode. This allows the supervisor to coach the agent in a one-way audio session where only the agent can hear the supervisor.

  • Write

    Start Conference by Member ID

    Join the user's calls into a conference. A minimum of two call IDs are required. Each call ID identifies an existing call between the user and a participant to be added to the conference.

  • Write

    Add Participant by Member ID

    Adds a participant to an existing conference. The request body contains the participant's call ID.

  • Write

    Deafen Participant by Member ID

    Deafens a participant (i.e. media stream will not be transmitted to the participant). The request body contains the call ID of the participant to deafen

  • Write

    Undeafen Participant by Member ID

    Undeafens a participant (i.e. resume transmitting the conference media stream to the participant). The request body contains the call ID of the participant to undeafen.

  • Write

    Barge In

    Transition the user's conference type to barge-in mode. This allows the supervisor to join the conference as a full participant where all parties can hear the supervisor.

  • Write

    Silent Monitor

    Transition the user's conference type to silent monitoring mode. This allows the supervisor to listen to the conference without being heard by the other participants.

  • Write

    Supervisor Coach

    Transition the user's conference type to supervisor coaching mode. This allows the supervisor to coach the agent in a one-way audio session where only the agent can hear the supervisor.

  • Destructive

    Release Conference

    Release the conference (the host and all participants). Note that for a 3WC (three-way call) the Transfer API can be used to perform an attended transfer so that the participants remain connected.

  • Destructive

    Release Conference by Member ID

    Release the conference (the host and all participants). Note that for a 3WC (three-way call) the Transfer API can be used to perform an attended transfer so that the participants remain connected.

Call Controls Members

  • Write

    Set Wrap-up Reasons by Member ID

    Sets wrap-up reasons for the specified member's last completed call. This API is for admins/service apps to perform actions on behalf of a user. The request must provide wrapupReasons.

Call Controls Members Me

  • Write

    Set Wrap-up Reasons

    Sets wrap-up reasons for the authenticated user's last completed call. The request must provide wrapupReasons.

Call Routing

  • Read

    Get Local Gateway Dial Plan Usage for a Trunk

    Get Local Gateway Dial Plan Usage for a Trunk. A trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.

  • Read

    Get Locations Using the Local Gateway as PSTN Connection Routing

    Get Locations Using the Local Gateway as PSTN Connection Routing. A trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.

  • Read

    Get Route Groups Using the Local Gateway

    Get Route Groups Using the Local Gateway. A trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.

  • Read

    Get Local Gateway Usage Count

    Get Local Gateway Usage Count A trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.

  • Read

    Validate a Dial Pattern

    Validate a Dial Pattern. Dial plans route calls to on-premises destinations by use of trunks or route groups. They are configured globally for an enterprise and apply to all users, regardless of location.

  • Read

    Read the List of Dial Plans

    List all Dial Plans for the organization. Dial plans route calls to on-premises destinations by use of the trunks or route groups with which the dial plan is associated. Multiple dial patterns can be defined as part of your dial plan.

  • Read

    Get a Dial Plan

    Get a Dial Plan for the organization. Dial plans route calls to on-premises destinations by use of trunks or route groups. They are configured globally for an enterprise and apply to all users, regardless of location.

  • Read

    Validate a Trunk

    Validate Local Gateway trunk settings for the organization before creation. Local Gateway trunks connect Webex Calling to on-premises PSTN infrastructure, terminating on a local gateway or other supported device.

  • Read

    Read the List of Trunks

    List all Trunks for the organization. A Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.

  • Read

    Get a Trunk

    Get a Trunk for the organization. A Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.

  • Read

    Read the List of Trunk Types

    List all Trunk Types with Device Types for the organization. A Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.

  • Read

    Read the List of Routing Groups

    List all Route Groups for an organization. A Route Group is a group of trunks that allows further scale and redundancy with the connection to the premises.

  • Read

    Read a Route Group for a Organization

    Reads a Route Group for the organization based on id. A Route Group is a collection of trunks that allows further scale and redundancy with the connection to the premises. Route groups can include up to 10 trunks from different locations.

  • Read

    Read the Usage of a Routing Group

    List the number of "Call to" on-premises Extensions, Dial Plans, PSTN Connections, and Route Lists used by a specific Route Group.

  • Read

    Read the Call to Extension Locations of a Routing Group

    List "Call to" on-premises Extension Locations for a specific route group. Users within these locations are registered to a PBX which allows you to route unknown extensions (calling number length of 2-6 digits) to the PBX using an existing trunk or route group.

  • Read

    Read the Dial Plan Locations of a Routing Group

    List Dial Plan Locations for a specific route group. Dial Plans allow you to route calls to on-premises destinations by use of trunks or route groups. They are configured globally for an enterprise and apply to all users, regardless of location.

  • Read

    Read the PSTN Connection Locations of a Routing Group

    List PSTN Connection Locations for a specific route group. This solution lets you configure users to use Cloud PSTN (CCP or Cisco PSTN) or Premises-based PSTN.

  • Read

    Read the Route Lists of a Routing Group

    List Route Lists for a specific route group. Route Lists are a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.

  • Read

    Read the List of Route Lists

    List all Route Lists for the organization. A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.

  • Read

    Get a Route List

    Get a rout list details. A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.

  • Read

    Get Numbers assigned to a Route List

    Get numbers assigned to a Route List A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.

  • Read

    Get Local Gateway Call to On-Premises Extension Usage for a Trunk

    Get local gateway call to on-premises extension usage for a trunk. A trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.

  • Read

    Retrieve the list of Translation Patterns

    Retrieve a list of translation patterns for a given organization. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See this article for details about the translation pattern syntax.

  • Read

    Retrieve a specific Translation Pattern for an Organization

    Retrieve the details of a translation pattern for a given organization. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See this article for details about the translation pattern syntax.

  • Read

    Retrieve a specific Translation Pattern for a Location

    Retrieve a specific translation pattern for a given location. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See this article for details about the translation pattern syntax.

  • Write

    Test Call Routing

    Validates that an incoming call can be routed. Dial plans route calls to on-premises destinations by use of trunks or route groups. They are configured globally for an enterprise and apply to all users, regardless of location.

  • Write

    Create a Dial Plan

    Create a Dial Plan for the organization. Dial plans route calls to on-premises destinations by use of trunks or route groups. They are configured globally for an enterprise and apply to all users, regardless of location.

  • Write

    Create a Trunk

    Create a Trunk for the organization. A Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.

  • Write

    Create Route Group for a Organization

    Creates a Route Group for the organization. A Route Group is a collection of trunks that allows further scale and redundancy with the connection to the premises. Route groups can include up to 10 trunks from different locations.

  • Write

    Create a Route List

    Create a Route List for the organization. A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.

  • Write

    Create a Translation Pattern for an Organization

    Create a translation pattern for a given organization. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See this article for details about the translation pattern syntax.

  • Write

    Create a Translation Pattern for a Location

    Create a translation pattern for a given location. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See this article for details about the translation pattern syntax.

  • Destructive

    Modify Dial Patterns

    Modify dial patterns for the Dial Plan. Dial plans route calls to on-premises destinations by use of trunks or route groups. They are configured globally for an enterprise and apply to all users, regardless of location.

  • Destructive

    Modify a Dial Plan

    Modify a Dial Plan for the organization. Dial plans route calls to on-premises destinations by use of trunks or route groups. They are configured globally for an enterprise and apply to all users, regardless of location.

  • Destructive

    Delete a Dial Plan

    Delete a Dial Plan for the organization. Dial plans route calls to on-premises destinations by use of trunks or route groups. They are configured globally for an enterprise and apply to all users, regardless of location.

  • Destructive

    Modify a Trunk

    Modify a Trunk for the organization. A Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.

  • Destructive

    Delete a Trunk

    Delete a Trunk for the organization. A Trunk is a connection between Webex Calling and the premises, which terminates on the premises with a local gateway or other supported device.

  • Destructive

    Modify a Route Group for a Organization

    Modifies an existing Route Group for an organization based on id. A Route Group is a collection of trunks that allows further scale and redundancy with the connection to the premises. Route groups can include up to 10 trunks from different locations.

  • Destructive

    Remove a Route Group from an Organization

    Remove a Route Group from an Organization based on id. A Route Group is a collection of trunks that allows further scale and redundancy with the connection to the premises. Route groups can include up to 10 trunks from different locations.

  • Destructive

    Modify a Route List

    Modify the details for a Route List. A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.

  • Destructive

    Delete a Route List

    Delete a route list for a customer. A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.

  • Destructive

    Modify Numbers for Route List

    Modify numbers for a specific Route List of a Customer. A Route List is a list of numbers that can be reached via a Route Group. It can be used to provide cloud PSTN connectivity to Webex Calling Dedicated Instance.

  • Destructive

    Modify a specific Translation Pattern for an Organization

    Modify a translation pattern for a given organization. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See this article for details about the translation pattern syntax.

  • Destructive

    Delete a specific Translation Pattern

    Delete a translation pattern for a given organization. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See this article for details about the translation pattern syntax.

  • Destructive

    Modify a specific Translation Pattern for a Location

    Modify a specific translation pattern for a given location. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See this article for details about the translation pattern syntax.

  • Destructive

    Delete a specific Translation Pattern for a Location

    Delete a specific translation pattern for a given location. A translation pattern lets you manipulate dialed digits before routing a call and applies to outbound calls only. See this article for details about the translation pattern syntax.

Location Call Settings

  • Read

    Read the List of Dial Patterns

    List all Dial Patterns for the organization. Dial plans route calls to on-premises destinations by use of trunks or route groups. They are configured globally for an enterprise and apply to all users, regardless of location.

  • Read

    List Locations Webex Calling Details

    Lists Webex Calling locations for an organization with Webex Calling details. Searching and viewing locations with Webex Calling details in your organization require an administrator auth token with the spark-admin:telephonyconfigread scope.

  • Read

    Get Location Webex Calling Details

    Shows Webex Calling details for a location, by ID. Specifies the location ID in the locationId parameter in the URI. Searching and viewing locations in your organization requires an administrator auth token with the spark-admin:telephonyconfigread scope.

  • Read

    Get a List of Update Routing Prefix jobs

    Get the list of all update routing prefix jobs in an organization. The routing prefix is associated with a location and is used to route calls belonging to that location. This API allows users to retrieve all the update routing prefix jobs in an organization.

  • Read

    Get the job status of Update Routing Prefix job

    Get the status of the update routing prefix job by its job ID. The routing prefix is associated with a location and is used to route calls belonging to that location. This API allows users to check the status of update routing prefix job by job ID in an organization.

  • Read

    Get job errors for update routing prefix job

    GET job errors for the update routing prefix job in an organization. The routing prefix is associated with a location and is used to route calls belonging to that location.

  • Read

    Get a Location Emergency callback number

    Get location emergency callback number. To retrieve location callback number requires a full, user or read-only administrator or location administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Validate the List of Extensions

    Validates the list of Extensions provided by the customer at the organization level. It checks the extension meets the current extension length limits and does not conflict with the extensions of organization-level entities and settings.

  • Read

    Validate Extensions

    Validate extensions for a specific location. Validating extensions requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Read

    Get Music On Hold

    Retrieve the location's music on hold settings. Location music on hold settings allows you to play music when a call is placed on hold or parked.

  • Read

    Get Private Network Connect

    Retrieve the location's network connection type. Network Connection Type determines if the location's network connection is public or private.

  • Read

    Read the List of Routing Choices

    List all Routes for the organization. Trunk and Route Group qualify as Route. Trunks and Route Groups provide you the ability to configure Webex Calling to manage calls between Webex Calling hosted users and premises PBX users.

  • Read

    Get the List of Phone Numbers Available for External Caller ID

    Get the list of phone numbers available for external caller ID usage by a Webex Calling entity (such as a person, virtual line, or workspace) within the specified location.

  • Read

    Get Available Phone Numbers for a Location with Given Criteria

    List the service and standard PSTN numbers that are available to be assigned as the location's main number. These numbers are associated with the location specified in the request URL and can be active/inactive and assigned to an owning entity or unassigned.

  • Read

    Get Webex Go Available Phone Numbers

    List standard numbers that are available to be assigned as the webex go phone number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are unassigned.

  • Read

    Get Location ECBN Available Phone Numbers

    List standard numbers that are available to be assigned as the location's emergency callback number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are assigned to an owning entity.

  • Read

    Get Location Call Intercept Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as the location's call intercept number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are assigned to an owning entity.

  • Read

    Read list of Receptionist Contact Directories

    List all Receptionist Contact Directories for a location. Receptionist Contact Directories can be used to create named directories of users. Retrieving this list requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Get details for a Receptionist Contact Directory

    Get details for a specific Receptionist Contact Directory from a location. Receptionist Contact Directories are uniquely named per location and contain directories of Persons, Auto Attendants, Call Queues, Hunt Groups, Single Number Reaches, and Paging Groups.

  • Read

    Get Available Charge Numbers for a Location with Given Criteria

    List the numbers that are available to be assigned as the location's charge number. These numbers are non-toll-free and non-mobile numbers assigned to the location specified in the request URL.

  • Read

    Get a List of Disable Calling Location Jobs

    Get a List of Disable Calling Location Jobs for the organization. Retrieving the list of disable calling location jobs requires a full administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Retrieve Errors for a Disable Calling Location Job

    Retrieve detailed error information for a disable calling location job. This is particularly useful for jobs that have failed or encountered errors during processing. Retrieving job errors requires a full administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Get Disable Calling Location Job Status

    Get the status and details of a specific disable calling location job. Retrieving job status requires a full administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Get the location call captions settings

    Retrieve the location's call captions settings. NOTE: The call captions feature is not supported for locations in India.

  • Write

    Enable a Location for Webex Calling

    Enable a location by adding it to Webex Calling. This add Webex Calling support to a location created created using the POST /v1/locations API. Locations are used to support calling features which can be defined at the location level.

  • Write

    Change Announcement Language

    Change announcement language for the given location. Change announcement language for current people/workspaces and/or existing feature configurations. This does not change the default announcement language which is applied to new users/workspaces and new feature configurations.

  • Write

    Create a Receptionist Contact Directory

    Create a new Receptionist Contact Directory for a location. Receptionist Contact Directories can be used to create named directories of users and/or location features (Auto Attendant, Call Queue, Hunt Group, Single Number Reach, and Paging Group).

  • Write

    Disable a Location for Webex Calling

    Disable a Location for Webex Calling. Initiating a disable calling location job requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Write

    Safe Delete Check Before Disabling a Location for Webex Calling

    Performs a safe delete check operation to identify any issues that would prevent the calling location from being disabled. This API helps identify resources that need to be addressed before a calling location can be successfully disabled.

  • Write

    Pause a Disable Calling Location Job

    Pause an in-progress disable calling location job. The job must be in the PROCESSING state to be paused. Pausing a job requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Write

    Resume a Paused Disable Calling Location Job

    Resume a previously paused disable calling location job. The job must be in the PAUSED state to be resumed. Resuming a job requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Update Location Webex Calling Details

    Update Webex Calling details for a location, by ID. Specifies the location ID in the locationId parameter in the URI. Modifying the connection via API is only supported for the local PSTN types of TRUNK and ROUTEGROUP.

  • Destructive

    Update a Location Emergency callback number

    Update details for a location emergency callback number. Updating a location callback number requires a full administrator or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Update Music On Hold

    Update the location's music on hold settings. Location music on hold settings allows you to play music when a call is placed on hold or parked.

  • Destructive

    Update Private Network Connect

    Update the location's network connection type. Network Connection Type determines if the location's network connection is public or private.

  • Destructive

    Modify a Receptionist Contact Directory

    Modify Receptionist Contact Directories attached to a location. This modification will replace the existing list of contacts with the new incoming contacts list from the request body. The API does not support incremental updates.

  • Destructive

    Delete a Receptionist Contact Directory

    Delete a Receptionist Contact Directory from a location. Receptionist Contact Directories can be used to create named directories of users. Deleting a directory requires a full or write-only administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Update the location call captions settings

    Update the location's call captions settings. NOTE: The call captions feature is not supported for locations in India.

Call Settings For Me Phase 5

  • Read

    Get Personal Assistant Settings

    Retrieve personal assistant settings for a person. The personal assistant feature allows users to configure an automated attendant that can handle incoming calls when they are unavailable, including presence-based routing and call transfer options.

  • Read

    Get Person's Voicemail Rules

    Get person's voicemail passcode rules. Voicemail rules specify the default passcode requirements. They are provided for informational purposes only and cannot be modified. The voicemail feature allows users to manage their voicemail settings as part of Webex Calling.

  • Read

    Get Hoteling Guest Settings

    Retrieve hoteling guest settings for a person. Hoteling allows a person to temporarily use a device as a guest, associating their extension and configuration with that device for a limited time.

  • Read

    Get Available Hoteling Hosts

    Retrieve a list of available hoteling hosts that a person can associate with as a guest. Returns hosts that have hoteling enabled on their devices and are available for guest associations. The list can be filtered by name or phone number and supports pagination.

  • Destructive

    Update Personal Assistant Settings

    Update personal assistant settings for a person. Allows configuring the personal assistant feature including enabling/disabling it, setting presence status, configuring call transfer options, and alerting preferences.

  • Destructive

    Update Voicemail PIN

    Set the voicemail PIN for a person. Updates the PIN used to access voicemail messages. The PIN must comply with the passcode rules defined for the organization. The voicemail feature is part of Webex Calling, allowing users to secure their voicemail access with a PIN.

  • Destructive

    Update Hoteling Guest Settings

    Update hoteling guest settings for a person. Allows enabling or disabling the ability to use hoteling as a guest, configuring whether an association will be removed automatically after a specified time period, and associating with a hoteling host.

Call Settings For Me

  • Read

    Get List Available Preferred Answer Endpoints

    Get the person's preferred answer endpoint and the list of endpoints available for selection. The list of endpoints is empty if the person has no endpoints assigned which support the preferred answer endpoint functionality.

  • Read

    Get My Secondary Line Owner's Available Preferred Answer Endpoint List

    Retrieve the list of available preferred answer endpoints for the secondary line owner of the authenticated person.

  • Read

    Get Preferred Answer Endpoint

    Retrieve the selected preferred answering endpoint for the user.

  • Read

    Get My Secondary Line Owner's Preferred Answer Endpoint

    Retrieve the selected preferred answering endpoint for the secondary line owner of the authenticated person.

  • Read

    Get My WebexGoOverride Settings

    Retrieve "Mobile User Aware" override setting for Do Not Disturb feature. When enabled, a mobile device will still ring even if Do Not Disturb, Quiet Hours, or Presenting Status are enabled.

  • Read

    Get My Caller ID Settings

    Get Caller ID Settings for the authenticated user. Calling Line ID Delivery Blocking in Webex prevents your name and phone number from being shown to people you call.

  • Read

    Get My Secondary Line Owner Caller ID Settings

    Get Caller ID Settings for the secondary line owner of the authenticated user. Note that the secondary line information is only available for the authenticated user.

  • Read

    Read My Selected Caller ID Settings

    Read selected caller ID settings associated with the authenticated user. Caller ID settings control how a person's information is displayed when making outgoing calls.

  • Read

    Get My Secondary Line Owner's Selected Caller ID Settings

    Get details of selected caller ID settings associated with a secondary line of the authenticated user. Note that an authenticated user can only retrieve information for their configured secondary lines.

  • Read

    Get My Available Caller ID List

    Get details of available caller IDs of the authenticated user. Caller ID settings control how a person's information is displayed when making outgoing calls. The available caller ID list shows the caller IDs that the user can choose from.

  • Read

    Get My Secondary Line Owner's Available Caller ID List

    Get details of available caller IDs for a secondary line of the authenticated user. Note that an authenticated user can only retrieve information for their configured secondary lines. Caller ID settings control how a person's information is displayed when making outgoing calls.

  • Read

    Read the List of My Endpoints

    Retrieve the list of endpoints associated with the authenticated user. Endpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line.

  • Read

    Get My Endpoints Details

    Get details of an endpoint associated with the authenticated user. Endpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line.

  • Read

    Get My Call Recording Settings

    Get details of call recording settings associated with the authenticated user. Call recording settings allow you to access and customize options that determine when and how your calls are recorded, providing control over recording modes and notifications.

  • Read

    Get My Secondary Line Owner's Call Recording Settings

    Get details of call recording settings associated with a secondary line of the authenticated user. Note that an authenticated user can only retrieve information for their configured secondary lines.

  • Read

    Get My Own Details

    Get profile details for the authenticated user. Profile details include the user's name, email, location and calling details. This API requires a user auth token with a scope of spark:telephonyconfigread.

  • Read

    Get My Feature Access Codes

    Retrieve all Feature Access Codes configured for services that are assigned to the authenticated user. For each feature access code, the name and code are returned. If an alternate code is defined, it is also returned.

  • Read

    Get My Feature Access Codes For Secondary Line Owner

    Retrieve all Feature Access Codes configured for services that are assigned for the secondary line owner. For each feature access code, the name and code are returned. If an alternate code is defined, it is also returned.

  • Read

    Get My Executive Assigned Assistants

    Get list of assigned executive assistants for an authenticated user. As an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.

  • Read

    Get My Executive Available Assistants

    Get a list of available executive assistants for the authenticated user. As an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle.

  • Read

    Get My Executive Assistant Settings

    Get settings for an executive assistant. Executive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive. Assistants can also set the call forwarding destination, and join or leave an executive’s pool.

  • Read

    Get My Calling Services List

    Retrieves the list of enabled calling services for the authenticated user. These services are designed to improve call handling and ensure that users can manage their communications effectively. They are commonly found in both personal and business telephony systems.

  • Read

    Get My Secondary Line Owner Calling Services List

    Retrieves the list of enabled calling services for the secondary line owner of the authenticated user. These services are designed to improve call handling and ensure that users can manage their communications effectively.

  • Read

    Get User's Single Number Reach Settings

    Retrieves all single number reach settings configured for the authenticated user. The "Single Number Reach" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office.

  • Read

    Read My Call Forwarding Settings

    Read call forwarding settings associated with the authenticated user. Three types of call forwarding are supported: + Always - forwards all incoming calls to the destination you choose.

  • Read

    Get My Secondary Line Owner's Call Forwarding Settings

    Get details of call forwarding settings associated with a secondary line of the authenticated user. Note that an authenticated user can only retrieve information for their configured secondary lines.

  • Read

    Get My Call Pickup Group Settings

    Get Call Pickup Group Settings for the authenticated user. Call pickup group enables a user to answer any ringing line within their pickup group. A call pickup group is an administrator-defined set of users within a location, to which the call pickup feature applies.

  • Read

    Get My Secondary Line Owner Call Pickup Group Settings

    Get Call Pickup Group Settings for the secondary line owner of the authenticated user. Note that the secondary line information is only available for the authenticated user. Call pickup group enables a user to answer any ringing line within their pickup group.

  • Read

    Get My Call Park Settings

    Get details of call park settings associated with the authenticated user. Call Park allows call recipients to place a call on hold so that it can be retrieved from another device. This API requires a user auth token with a scope of spark:telephonyconfigread.

  • Read

    Get My Secondary Line Owner Call Park Settings

    Get details of call park settings for the secondary line owner of the authenticated user. Note that the secondary line information is only available for the authenticated user.

  • Read

    Read Voicemail Settings for a Person

    Retrieve a person's voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail. Optionally, notifications can be sent to a mobile phone via text or email.

  • Read

    Get My Secondary Line Owner's Voicemail Settings

    GET voicemail settings for a secondary line of the authenticated user. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail. Optionally, notifications can be sent to a mobile phone via text or email.

  • Read

    Get My Call Block Settings

    Get details of call block settings associated with the authenticated user. Call block settings allow you to get the User Call Block Number List. This API requires a user auth token with a scope of spark:telephonyconfigread.

  • Read

    Get My Call Block State For Specific Number

    Get call block state details for a specific number associated with the authenticated user. Call block settings allow you to get the User Call Block Number List. This API requires a user auth token with a scope of spark:telephonyconfigread.

  • Read

    Get My Monitoring Settings

    Retrieves the monitoring settings for the authenticated person, which shows specified people, places, virtual lines or call park extensions that are being monitored.

  • Read

    Get My Call Center Settings

    Retrieves the call center settings and list of all call centers the logged in user belongs to. Calls from the Call Centers are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors.

  • Read

    Get My Secondary Line Owner's Call Center Settings

    Retrieves the call center settings and list of all call centers associated with a secondary line of the authenticated user. Note that an authenticated user can only retrieve information for their configured secondary lines.

  • Read

    Get my call captions settings

    Retrieve the effective call captions settings of the authenticated user. NOTE: The call captions feature is not supported for Webex Calling Standard users or users assigned to locations in India.

  • Read

    Get Speed Dials

    Get the Speed Dials settings for the authenticated user. This API returns all configured speed dials (no pagination).

  • Read

    Get Speed Dial Available Members

    Get the available members which can be configured as Speed Dials for the authenticated user. Speed Dials allow Webex Calling users to quickly dial frequently contacted people, places, or virtual lines by assigning them to dedicated keys on their desk phones or soft clients.

  • Read

    Get Location List for My Organization

    Get the list of locations for the authenticated person's organization. Locations are used to organize Webex Calling resources such as people, workspaces, and features within an organization. Each location can have its own settings and configurations for calling services.

  • Read

    Get Large Organization Status

    Get whether the authenticated person's organization is considered as a large organization.

  • Write

    Add phone number as User's Single Number Reach

    Add a phone number as a single number reach for the authenticated user. The "Single Number Reach" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office.

  • Write

    Add a phone number to user's Call Block List

    Add a phone number to the call block list for the authenticated user. Call block settings allow you to get the User Call Block Number List. This API requires a user auth token with a scope of spark:telephonyconfigwrite.

  • Destructive

    Modify Preferred Answer Endpoint

    Sets or clears the person’s preferred answer endpoint. To clear the preferred answer endpoint the id attribute must be set to null.

  • Destructive

    Modify My Secondary Line Owner's Preferred Answer Endpoint

    Sets or clears the preferred answer endpoint for the secondary line owner of the authenticated person. To clear the preferred answer endpoint the id attribute must be set to null.

  • Destructive

    Modify My WebexGoOverride Settings

    Update "Mobile User Aware" override setting for Do Not Disturb feature. When enabled, a mobile device will still ring even if Do Not Disturb, Quiet Hours, or Presenting Status are enabled.

  • Destructive

    Modify My Caller ID Settings

    Update Caller ID Settings for the authenticated user. Calling Line ID Delivery Blocking in Webex prevents your name and phone number from being shown to people you call.

  • Destructive

    Modify My Secondary Line Owner Caller ID Settings

    Update Caller ID Settings for the secondary line owner of the authenticated user. Note that the secondary line information is only available for the authenticated user.

  • Destructive

    Configure My Selected Caller ID Settings

    Update selected caller ID settings associated with the authenticated user. Caller ID settings control how a person's information is displayed when making outgoing calls.

  • Destructive

    Modify My Secondary Line Owner's Selected Caller ID Settings

    Update selected caller ID settings associated with a secondary line owner of the authenticated user. Note that an authenticated user can only modify information for their configured secondary lines.

  • Destructive

    Modify My Endpoints Details

    Update alerting settings of the mobility endpoint associated with the authenticated user. Endpoints are devices, applications, or hotdesking guest profiles. Endpoints can be owned by an authenticated user or have the user as a secondary line.

  • Destructive

    Modify My Executive Assigned Assistants

    Update assigned executive assistants for the authenticated user. As an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.

  • Destructive

    Modify My Executive Assistant Settings

    Update Settings for an executive assistant. Executive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive. Assistants can also set the call forwarding destination, and join or leave an executive’s pool.

  • Destructive

    Modify User's Single Number Reach Settings

    Updates single number reach settings associated with the authenticated user. The "Single Number Reach" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office.

  • Destructive

    Modify User's Single Number Reach Contact Settings

    Update the contact settings of single number reach for the authenticated user. The "Single Number Reach" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office.

  • Destructive

    Delete User's Single Number Reach Contact Settings

    Delete contact settings associated with the authenticated user. The "Single Number Reach" feature in Webex allows users to access their business phone capabilities from any device, making it easy to make and receive calls as if at their office.

  • Destructive

    Configure My Call Forwarding Settings

    Update call forwarding settings associated with the authenticated user. Three types of call forwarding are supported: + Always - forwards all incoming calls to the destination you choose.

  • Destructive

    Modify My Secondary Line Owner's Call Forwarding Settings

    Update call forwarding settings associated with a secondary line owner of the authenticated user. Note that an authenticated user can only modify information for their configured secondary lines.

  • Destructive

    Configure Voicemail Settings for a Person

    Configure a person's voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail. Optionally, notifications can be sent to a mobile phone via text or email.

  • Destructive

    Modify My Secondary Line Owner's Voicemail Settings

    Update voicemail settings associated with a secondary line owner of the authenticated user. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail.

  • Destructive

    Delete User Call Block Number

    Delete call block number settings associated with the authenticated user. Call block settings allow you to delete a number from the User Call Block Number List. This API requires a user auth token with a scope of spark-admin:peoplewrite.

  • Destructive

    Modify My Call Center Settings

    Modify the call center settings and availability for an agent in one or more call centers to which the logged in user belongs. Calls from the Call Centers are routed to agents based on configuration.

  • Destructive

    Modify My Secondary Line Owner's Call Center Settings

    Modify the call center settings and availability for an agent in one or more call centers associated with a secondary line owner of the authenticated user. Note that an authenticated user can only modify information for their configured secondary lines.

  • Destructive

    Modify Speed Dials

    Modify the Speed Dials settings for the authenticated user. This is a replacement list for speed dials.

Beta Call Settings For Me With Userhub Phase1

  • Read

    Get Call Policies Settings for User

    Get call policies settings for the authenticated user. Call Policies in Webex allow you to manage how your call information is displayed and handled. You can view privacy settings for your connected line ID on redirected calls and review other call-related preferences.

  • Read

    Get User Executive Screening Settings

    Get executive screening settings for the authenticated user. Executive Screening in Webex allows you to manage how incoming calls are screened and alerted based on your preferences.

  • Read

    Get User Executive Call Filtering Settings

    Get executive call filtering settings for the authenticated user. Executive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types.

  • Read

    Get User Executive Call Filtering Criteria Settings

    Get executive call filtering criteria settings for the authenticated user. Executive Call Filtering Criteria in Webex allows you to retrieve detailed configuration for a specific filter rule.

  • Read

    Get Do Not Disturb Settings for User

    Get Do Not Disturb settings for the authenticated user. Do Not Disturb (DND) enables users to block or silence incoming calls on their phone.

  • Read

    Get User Executive Alert Settings

    Get executive alert settings for the authenticated user. Executive Alert settings in Webex allow you to control how calls are routed to executive assistants, including alerting mode, rollover options, and caller ID presentation.

  • Read

    Get country-specific telephony configuration requirements

    Retrieve country-specific telephony configuration requirements for the authenticated user. Webex Calling supports multiple regions and time zones to validate and present the information using the local date and time, as well as localized dialing rules.

  • Read

    Get announcement languages for the authenticated user

    Retrieve the list of available announcement languages for the authenticated user's telephony configuration. Announcement languages determine the language used for system prompts and announcements during calls.

  • Write

    Add User Executive Call Filtering Criteria

    Create a new executive call filtering criteria for the authenticated user. Executive Call Filtering Criteria in Webex allows you to define detailed filter rules for incoming calls.

  • Destructive

    Modify Call Policies Settings for User

    Update call policies settings for the authenticated user. Call Policies in Webex allow you to manage how your call information is displayed and handled. You can configure privacy settings for your connected line ID on redirected calls and control other call-related preferences.

  • Destructive

    Modify User Executive Screening Settings

    Update executive screening settings for the authenticated user. Executive Screening in Webex allows you to manage how incoming calls are screened and alerted based on your preferences.

  • Destructive

    Modify User Executive Call Filtering Settings

    Update executive call filtering settings for the authenticated user. Executive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types.

  • Destructive

    Modify User Executive Call Filtering Criteria Settings

    Update executive call filtering criteria settings for the authenticated user. Executive Call Filtering Criteria in Webex allows you to modify detailed configuration for a specific filter rule.

  • Destructive

    Delete User Executive Call Filtering Criteria

    Delete a specific executive call filtering criteria for the authenticated user. Executive Call Filtering Criteria in Webex allows you to manage detailed filter rules for incoming calls. This API removes a specific filter rule by its unique identifier.

  • Destructive

    Modify Do Not Disturb Settings for User

    Update Do Not Disturb settings for the authenticated user. Do Not Disturb (DND) enables users to block or silence incoming calls on their phone.

  • Destructive

    Modify User Executive Alert Settings

    Update executive alert settings for the authenticated user. Executive Alert settings in Webex allow you to control how calls are routed to executive assistants, including alerting mode, rollover options, and caller ID presentation.

Beta Settings Features For Barge In

  • Read

    Get Barge-In Settings

    Retrieve Barge-In settings of the user. The Barge-In feature enables you to use a Feature Access Code (FAC) to answer a call that was directed to another subscriber, or barge-in on the call if it was already answered. Barge-In can be used across locations.

  • Destructive

    Configure Barge-In Settings

    Configure person's Barge-In settings. The Barge-In feature enables you to use a Feature Access Code (FAC) to answer a call that was directed to another subscriber, or barge-in on the call if it was already answered. Barge-In can be used across locations.

Call Settings For Me With User Hub Phase2

  • Read

    Get Priority Alert Settings

    Get Priority Alert Settings for the authenticated user. Priority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.

  • Read

    Get Priority Alert Criteria Settings

    Get Priority Alert Criteria Settings for the authenticated user. Priority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.

  • Read

    Get User (and Location) Schedules

    Get Schedules for Call Settings for the authenticated user. Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert.

  • Read

    Get User Schedule

    Get a Schedule details for Call Settings of the authenticated user. Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert.

  • Read

    Get User Schedule Event

    Get a Schedule Event details for Call Settings of the authenticated user. Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert.

  • Read

    Get User's Location Level Schedule

    Get Location Schedule for Call Settings of the authenticated user. Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert.

  • Read

    Get Call Notify Settings for User

    Get Call Notify Settings for the authenticated user. Call Notify allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.

  • Read

    Get Call Notify Criteria Settings

    Get Call Notify Criteria Settings for the authenticated user. Call Notify allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.

  • Read

    Get Selective Call Accept Settings for User

    Get Selective Call Accept Settings for the authenticated user. Selective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.

  • Read

    Get Selective Call Accept Criteria Settings for User

    Get Selective Call Accept Criteria Settings for the authenticated user. Selective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.

  • Read

    Get Available Numbers for User's Location

    Get Available Numbers for User's Location. Fetch all the numbers available in User's location. This API requires a user auth token with a scope of spark:telephonyconfigread.

  • Read

    Get Settings for a Selective Call Forwarding Criteria

    Get settings for a Selective Call Forwarding Criteria for the authenticated user.

  • Read

    Get Selective Call Forward Settings for User

    Get Selective Call Forward Settings for the authenticated user. Selective Call Forward allows you to create customized rules to forward specific calls for users based on the phone number,identity and the time or day of the call.

  • Write

    Add a Priority Alert Criteria

    Create a Priority Alert Criteria for the authenticated user. Priority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.

  • Write

    Add a User level Schedule for Call Settings

    Create a new Schedule for the authenticated user. Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert.

  • Write

    Add an event for a User Schedule

    Create a new Event for for the authenticated user's specified schedule. Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert.

  • Write

    Add a Call Notify Criteria

    Create a Call Notify Criteria for the authenticated user. Call Notify allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.

  • Write

    Add User Selective Call Accept Criteria

    Create a new Selective Call Accept Criteria for the authenticated user. Selective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.

  • Write

    Add a Selective Call Forwarding Criteria

    Create a Selective Call Forwarding Criteria for the authenticated user.

  • Destructive

    Modify Priority Alert Settings for User

    Update Priority Alert Settings for the authenticated user. Priority alert allows you to set up a unique ringtone based on predefined criteria. This is helpful, when the user wants to be quickly notified that a specific phone number is calling.

  • Destructive

    Modify Settings for a Priority Alert Criteria

    Modify Priority Alert Criteria Settings for the authenticated user. Priority alert allows you to set up a unique ringtone based on predefined criteria. This API allows modifying attributes such as name, phoneNumbers etc for a particular criteria.

  • Destructive

    Delete a Priority Alert Criteria

    Delete a Priority Alert criteria for the authenticated user. Priority alert allows you to set up a unique ringtone based on predefined criteria. This API removes a specific criteria rule by its unique identifier.

  • Destructive

    Modify User Schedule

    Modify a Schedule details for Call Settings of the authenticated user. Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert.

  • Destructive

    Delete a User Schedule

    Delete a specific schedule for the authenticated user. Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert.

  • Destructive

    Modify User Schedule Event

    Modify a Schedule event details for Call Settings of the authenticated user. Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert.

  • Destructive

    Delete User a Schedule Event

    Delete a specific schedule event for the authenticated user. Schedules are used to define specific time periods which can be applied to various Call Settings, such as Sequential Ring, or Priority Alert.

  • Destructive

    Modify Call Notify Settings for User

    Update Call Notify Settings for the authenticated user. Call Notify allows you to set up a unique ringtone based on predefined criteria. This API allows modifying attributes such as name, phoneNumbers etc for a particular criteria.

  • Destructive

    Modify a Call Notify Criteria

    Modify Call Notify Criteria Settings for the authenticated user. Call Notify allows you to set up a unique ringtone based on predefined criteria. This API allows modifying attributes such as name, phoneNumbers etc for a particular criteria.

  • Destructive

    Delete a Call Notify Criteria

    Delete a Call Notify criteria for the authenticated user. Call Notify allows you to set up a unique ringtone based on predefined criteria. This API removes a specific criteria rule by its unique identifier.

  • Destructive

    Modify Selective Call Accept Settings for User

    Update Selective Call Accept Settings for the authenticated user. Selective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.

  • Destructive

    Modify a Selective Call Accept Criteria

    Modify Selective Call Accept Criteria Settings for the authenticated user. Selective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.

  • Destructive

    Delete a Selective Call Accept Criteria

    Delete a Selective Call Accept Criteria for the authenticated user. Selective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number,identity and the time or day of the call.

  • Destructive

    Modify Settings for a Selective Call Forwarding Criteria

    Modify settings for a Selective Call Forwarding Criteria for the authenticated user.

  • Destructive

    Delete a Selective Call Forwarding Criteria

    Delete a Selective Call Forwarding Criteria for the authenticated user. Selective call forwarding allows you to define rules that automatically forward incoming calls based on specific criteria. This API removes a specific criteria rule by its unique identifier.

  • Destructive

    Modify Selective Call Forward Settings for User

    Update the Selective Call Forward Settings for the authenticated user. Selective Call Accept allows you to create customized rules to accept specific calls for users based on the phone number, identity, and the time or day of the call.

Call Settings For Me With User Hub Phase3

  • Read

    Get Selective Call Reject Settings for User

    Get Selective Call Reject Settings for the authenticated user. Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.

  • Read

    Get Anonymous Call Rejection Settings for User

    Get Anonymous Call Rejection Settings for the authenticated user. Anonymous Call Rejection allows you to reject calls from anonymous callers. This API requires a user auth token with a scope of spark:telephonyconfigread.

  • Read

    Get Selective Call Reject Criteria Settings for User

    Get Selective Call Reject Criteria Settings for the authenticated user. Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.

  • Read

    Get Call Waiting Settings for User

    Get Call Waiting Settings for the authenticated user. Call Waiting allows a user to receive multiple calls simultaneously. When the user is on an active call, they can receive an incoming call and switch between the two calls.

  • Read

    Get Sequential Ring Settings for User

    Get Sequential Ring Settings for the authenticated user. Sequential Ring allows calls to ring additional phone numbers in sequence if the initial call is not answered. This can be configured to ring up to five phone numbers with customizable ring patterns.

  • Read

    Get Sequential Ring Criteria Settings for User

    Get Sequential Ring Criteria Settings for the authenticated user. Sequential Ring criteria defines rules for when sequential ring should activate based on the caller and schedule. This API requires a user auth token with a scope of spark:telephonyconfigread.

  • Write

    Add User Selective Call Reject Criteria

    Create a new Selective Call Reject Criteria for the authenticated user. Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.

  • Write

    Add User Sequential Ring Criteria

    Create a new Sequential Ring Criteria for the authenticated user. Sequential Ring criteria defines rules for when sequential ring should activate based on the caller and schedule. This API requires a user auth token with a scope of spark:telephonyconfigwrite.

  • Destructive

    Modify Selective Call Reject Settings for User

    Update Selective Call Reject Settings for the authenticated user. Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.

  • Destructive

    Modify Anonymous Call Rejection Settings for User

    Update Anonymous Call Rejection Settings for the authenticated user. Anonymous Call Rejection allows you to reject calls from anonymous callers. This API requires a user auth token with a scope of spark:telephonyconfigwrite.

  • Destructive

    Modify a Selective Call Reject Criteria

    Modify Selective Call Reject Criteria Settings for the authenticated user. Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.

  • Destructive

    Delete a Selective Call Reject Criteria

    Delete a Selective Call Reject Criteria for the authenticated user. Selective Call Reject allows you to create customized rules to reject specific calls for users based on the phone number,identity and the time or day of the call.

  • Destructive

    Modify Call Waiting Settings for User

    Update Call Waiting Settings for the authenticated user. Call Waiting allows a user to receive multiple calls simultaneously. When the user is on an active call, they can receive an incoming call and switch between the two calls.

  • Destructive

    Modify Sequential Ring Settings for User

    Update Sequential Ring Settings for the authenticated user. Sequential Ring allows calls to ring additional phone numbers in sequence if the initial call is not answered. This can be configured to ring up to five phone numbers with customizable ring patterns.

  • Destructive

    Modify Sequential Ring Criteria Settings for User

    Update Sequential Ring Criteria Settings for the authenticated user. Sequential Ring criteria defines rules for when sequential ring should activate based on the caller and schedule. This API requires a user auth token with a scope of spark:telephonyconfigwrite.

  • Destructive

    Delete Sequential Ring Criteria

    Delete a Sequential Ring Criteria for the authenticated user. Sequential Ring criteria defines rules for when sequential ring should activate based on the caller and schedule. This API requires a user auth token with a scope of spark:telephonyconfigwrite.

Mode Management

  • Read

    Get Mode Management Features

    Retrieves a list of all mode management features (Auto Attendants, Call Queues, and Hunt Groups) for which the authenticated user has been designated as a mode manager. This API returns basic information about each feature including its ID, name, and type.

  • Read

    Get Common Modes

    Retrieves a list of common operating mode names that are shared across multiple specified features.

  • Read

    Get Mode Management Feature

    Retrieves detailed information about a specific mode management feature including its current operating mode and exception status. This API provides the feature's ID, name, type, current operating mode ID, and whether it is currently in an exception mode.

  • Read

    Get Normal Operation Mode

    Retrieves the current normal operating mode that the feature is scheduled to be in based on its time schedules. This represents the mode the feature would be in if no manual exceptions or overrides were active.

  • Read

    Get Operating Mode

    Retrieves detailed information about a specific operating mode for a feature, including the mode's ID and name. This API allows managers to get the details of any operating mode configured for a feature.

  • Write

    Switch Mode for Multiple Features

    Switches the operating mode for multiple features simultaneously by specifying a common mode name. This API accepts a list of feature IDs and sets all of them to the specified operating mode, provided that mode exists for all features.

  • Write

    Switch to Normal Operation

    Switches the feature back to its normal scheduled operation mode, removing any manual exceptions or overrides that may be active. This returns the feature to operating according to its configured time schedules.

  • Write

    Switch Mode for Single Feature

    Switches the operating mode for a single feature to a specified mode, either temporarily or with manual switchback. This API creates an exception to the feature's normal scheduled operation, allowing managers to manually control the feature's behavior.

  • Write

    Extend Current Operating Mode Duration

    Extends the duration of the current operating mode by adding additional time before it expires or reverts to scheduled operation. This API allows managers to prolong a temporary mode change without having to switch modes again.

Call Settings For Me Phase 4

  • Read

    Retrieve My Simultaneous Ring Settings

    Retrieve simultaneous ring settings for the authenticated user. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.

  • Read

    Retrieve My Simultaneous Ring Criteria

    Retrieve simultaneous ring criteria settings for the authenticated user. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.

  • Read

    Retrieve My Guest Calling Numbers

    Retrieve available guest calling numbers for the authenticated user. This API returns a list of phone numbers that can be used for guest calling purposes. Retrieving guest calling numbers requires a user auth token with a scope of spark:telephonyconfigread.

  • Write

    Upload Voicemail Busy Greeting

    Uploads a new busy greeting audio file for the authenticated user's voicemail. This endpoint is part of the voicemail greeting management capabilities provided by the Webex Calling platform and is available when the wxc-csg-hydra-call-184017-phase4 feature is enabled.

  • Write

    Upload Voicemail No Answer Greeting

    Uploads a new no answer greeting audio file for the authenticated user's voicemail. This endpoint is part of the voicemail greeting management capabilities provided by the Webex Calling platform and is available when the wxc-csg-hydra-call-184017-phase4 feature is enabled.

  • Write

    Create My Simultaneous Ring Criteria

    Create simultaneous ring criteria settings for the authenticated user. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.

  • Destructive

    Modify My Simultaneous Ring Settings

    Modify simultaneous ring settings for the authenticated user. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.

  • Destructive

    Modify My Simultaneous Ring Criteria

    Modify simultaneous ring criteria settings for the authenticated user. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.

  • Destructive

    Delete My Simultaneous Ring Criteria

    Delete simultaneous ring criteria settings for the authenticated user. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.

Calling Service Settings

  • Read

    Read the List of Announcement Languages

    List all languages supported by Webex Calling for announcements and voice prompts. Retrieving announcement languages requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Get Voicemail Settings

    Retrieve the organization's voicemail settings. Organizational voicemail settings determines what voicemail features a person can configure and automatic message expiration.

  • Read

    Get Voicemail Rules

    Retrieve the organization's voicemail rules. Organizational voicemail rules specify the default passcode requirements. They are provided for informational purposes only and cannot be modified.

  • Read

    Get the organization Music on Hold configuration

    Retrieve the organization's Music on Hold settings.

  • Read

    Get Large Organization Status

    Get the large organization status for a customer. Large organization status indicates whether an organization is categorized as a large organization based on the threshold percentage.

  • Read

    Get the organization call captions settings

    Retrieve the organization's call captions settings. The call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting.

  • Destructive

    Update Voicemail Settings

    Update the organization's voicemail settings. Organizational voicemail settings determines what voicemail features a person can configure and automatic message expiration.

  • Destructive

    Update Voicemail Rules

    Update the organization's default voicemail passcode and/or rules. Organizational voicemail rules specify the default passcode requirements.

  • Destructive

    Update the organization Music on Hold configuration

    Update the organization's Music on Hold settings.

  • Destructive

    Update the organization call captions settings

    Update the organization's call captions settings. The call caption feature allows the customer to enable and manage closed captions and transcript functionality (rolling caption panel) in Webex Calling, without requiring the user to escalate the call to a meeting.

Client Call Settings

  • Read

    Get an Organization's MS Teams Settings

    Not supported for Webex for Government (FedRAMP) Get organization MS Teams settings. At an organization level, MS Teams settings allow access to viewing the HIDE WEBEX APP and PRESENCE SYNC settings.

  • Destructive

    Update an Organization's MS Teams Setting

    Not supported for Webex for Government (FedRAMP) Update an MS Teams setting. MS Teams setting can be updated at the organization level. Requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

Telephony

  • Read

    Read the Contact Center Extensions

    Retrieves the Contact Center phone number, extension, virtual numbers, endpoints, and endpoints registration status associated with the authenticated user.

Converged Recordings

  • Read

    List Recordings

    List recordings. You can specify a date range, and the maximum number of recordings to return. The list returned is sorted in descending order by the date and time that the recordings were created. Long result sets are split into pages.

  • Read

    List Recordings for Admin or Compliance officer

    List recordings for an admin or compliance officer. You can specify a date range, and the maximum number of recordings to return. The list returned is sorted in descending order by the date and time that the recordings were created. Long result sets are split into pages.

  • Read

    Get Recording Details

    Retrieves details for a recording with a specified recording ID. Only recordings of owner with the authenticated user may be retrieved.

  • Read

    Get Recording metadata

    Retrieves metadata details for a recording with a specified recording ID. The recording must be owned by the authenticated user.

  • Write

    Reassign Recordings

    Reassigns recordings to a new user. As an administrator, you can reassign a list of recordings or all recordings of a particular user to a new user. The recordings can belong to an org user, a virtual line, or a workspace, but the destination user should only be a valid org user.

  • Write

    Move Recordings into the Recycle Bin

    Move recordings into the recycle bin with recording IDs or move all the recordings to the recycle bin. Only the following two entities can use this API Administrator: A user or an application with the scope spark-admin:recordingswrite.

  • Write

    Restore Recordings from Recycle Bin

    Restore recordings from the recycle bin with recording IDs or restore all the recordings that are in the recycle bin. Only the following two entities can use this API Administrator: A user or an application with the scope spark-admin:recordingswrite.

  • Destructive

    Delete a Recording

    Removes a recording with a specified recording ID. The deleted recording cannot be recovered. If a Compliance Officer deletes another user's recording, the recording will be inaccessible to regular users (host, attendees and shared), and to the Compliance officer as well.

  • Destructive

    Purge Recordings from Recycle Bin

    Purge recordings from the recycle bin matching the supplied recording IDs, or purge all the recordings that are in the recycle bin. A recording, once purged, cannot be restored.

Emergency Services Settings

  • Read

    Retrieve RedSky Account Details for an Organization

    Retrieve RedSky account details for an organization. The Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada.

  • Read

    Get the Organization Compliance Status for a RedSky Account

    Get the organization compliance status for a RedSky account. The locationStatus.state in the response will show the state for the location that is in the earliest stage of configuration.

  • Read

    Get the Organization Compliance Status and the Location Status List

    Get the organization compliance status and the location status list for a RedSky account. The enhanced emergency (E911) service for Webex Calling provides an emergency service designed for organizations with a hybrid or nomadic workforce.

  • Read

    Get a Location's RedSky Emergency Calling Parameters

    Get the Emergency Calling Parameters for a specific location. The enhanced emergency (E911) service for Webex Calling provides an emergency service designed for organizations with a hybrid or nomadic workforce.

  • Read

    Get a Location's RedSky Compliance Status

    Get RedSky compliance status for a specific location. The enhanced emergency (E911) service for Webex Calling provides an emergency service designed for organizations with a hybrid or nomadic workforce.

  • Read

    Get an Organization Emergency Call Notification

    Get organization emergency call notification. Emergency Call Notifications can be enabled at the organization level, allowing specified email addresses to receive email notifications when an emergency call is made. To comply with U.S.

  • Read

    Get a Location Emergency Call Notification

    Get location emergency call notification. Emergency Call Notifications can be enabled at the organization level, allowing specified email addresses to receive email notifications when an emergency call is made.

  • Read

    Get Dependencies for a Hunt Group Emergency Callback Number

    Retrieves the emergency callback number dependencies for a specific hunt group. Hunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.

  • Read

    Get a Person's Emergency Callback Number

    Retrieve a person's emergency callback number settings. Emergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Callback Numbers (ECBN) and Emerge…

  • Read

    Retrieve A Person's Emergency Callback Number Dependencies

    Retrieve Emergency Callback Number dependencies for a person.

  • Read

    Get a Workspace Emergency Callback Number

    Retrieve the emergency callback number setting associated with a specific workspace.

  • Read

    Retrieve Workspace Emergency Callback Number Dependencies

    Retrieve Emergency Callback Number dependencies for a workspace.

  • Read

    Get Dependencies for a Virtual Line Emergency Callback Number

    Retrieves the emergency callback number dependencies for a specific virtual line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines for Webex Calling users.

  • Read

    Get the Virtual Line's Emergency Callback Settings

    Retrieve the emergency callback number settings for a specific virtual line. A virtual line is a capability in Webex Calling that allows administrators to configure multiple lines for Webex Calling users.

  • Write

    Create an Account and Admin in RedSky

    Create an account and admin in RedSky. The Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada.

  • Write

    Login to a RedSky Admin Account

    Login to Redsky for an existing account admin user to retrieve the companyId and verify the status of externalTenantEnabled. The password provided will not be stored.

  • Write

    Create a RedSky Building Address and Alert Email for a Location

    Add a RedSky building address and alert email for a specified location.

  • Destructive

    Update RedSky Service Settings

    Update the RedSky service settings. The Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada.

  • Destructive

    Update the Organization RedSky Account's Compliance Status

    Update the compliance status for the customer's RedSky account. The Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada.

  • Destructive

    Update a Location's RedSky Compliance Status

    Update the compliance status for a specific location. The Enhanced Emergency (E911) Service for Webex Calling provides dynamic location support and a network that routes emergency calls to Public Safety Answering Points (PSAP) around the US, its territories, and Canada.

  • Destructive

    Update a RedSky Building Address for a Location

    Update a RedSky building address for a specified location. This endpoint is intended for use by online customers who have a single location setup.

  • Destructive

    Update an Organization Emergency Call Notification

    Update an organization emergency call notification. Once settings are enabled at the organization level, the configured email address will receive emergency call notifications for all locations.

  • Destructive

    Update a Location Emergency Call Notification

    Update a location emergency call notification. Once settings enabled at the organization level, the configured email address will receive emergency call notifications for all locations; for specific location customization, users can navigate to Management Locations, select the C…

  • Destructive

    Update a Person's Emergency Callback Number

    Update a person's emergency callback number settings. Emergency Callback Configurations can be enabled at the organization level, Users without individual telephone numbers, such as extension-only users, must be set up with accurate Emergency Callback Numbers (ECBN) to enable th…

  • Destructive

    Update a Workspace Emergency Callback Number

    Update the emergency callback number settings for a workspace.

  • Destructive

    Update a Virtual Line's Emergency Callback settings

    Update the emergency callback number settings for a specific virtual line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines for Webex Calling users.

Features: Announcement Playlist

  • Read

    List Announcement Playlists

    Fetch a list of announcement playlist at an organization. This API requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Get Announcement Playlist

    Fetch details of announcement playlist by its ID at an organization level. This API requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    List Playlist Locations

    Fetch list of locations which are assigned to the given announcement playlist This API requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Write

    Create Announcement Playlist

    Create announcement Playlist at an organization level. A maximum of 25 announcement files can be included in a single playlist. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Update Announcement Playlist

    Modify an existing announcement playlist at an organization level. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Delete Announcement Playlist

    Delete an announcement playlist for an organization. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Update Playlist Locations

    Modify list of assigned locations or add new locations to the announcement playlist. This will assing the playlist to the location's music on hold. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

Call Queue Settings with Playlist Settings

  • Read

    Get Playlist Usage

    GET /telephony/config/announcements/playlists/{playListId}/usage

Features: Announcement Repository

  • Read

    Fetch list of announcement greetings on location and organization level

    Fetch a list of binary announcement greetings at an organization as well as location level. An admin can upload a file at an organization level. This file will be uploaded to the announcement repository.

  • Read

    Fetch repository usage for announcements for an organization

    Retrieves repository usage for announcements for an organization. This API requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Fetch details of a binary announcement greeting at the organization level

    Fetch details of a binary announcement greeting by its ID at an organization level. An admin can upload a file at an organization level. This file will be uploaded to the announcement repository.

  • Read

    Get Announcement File URI

    Retrieve the fileUri for an existing binary announcement greeting at the organization level. Use the returned fileUri with the Get Media Download URL API to get URLs for downloading the announcement media file.

  • Read

    Fetch repository usage for announcements in a location

    Retrieves repository usage for announcements in a location. This API requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Fetch details of a binary announcement greeting at location level

    Fetch details of a binary announcement greeting by its ID at a location level. An admin can upload a file at a location level. This file will be uploaded to the announcement repository.

  • Read

    Get Location Announcement File URI

    Retrieve the fileUri for an existing binary announcement greeting at the location level. Use the returned fileUri with the Get Media Download URL API to get URLs for downloading the announcement media file.

  • Read

    Get Media Download URL

    Retrieve a pre-signed S3 download URL and KMS encryption key for a previously uploaded announcement media file identified by its S3 path. To preview the announcement media file: 1.

  • Read

    Get Text-to-Speech Usage

    Retrieve text-to-speech usage information, including the number of API calls made, the maximum allowed within the time window, and the timestamp indicating when the usage will reset.

  • Read

    Get Text-to-Speech Generation Status

    Get the status of a text-to-speech generation request by its ID. If the status is SUCCESS, the response includes promptUrl, kmsKeyUri, and fileUri to preview or use the audio prompt. To preview the audio prompt: 1.

  • Read

    List Text-to-Speech Voices

    Fetch a list of available text-to-speech voices. Use the returned voice ID and language code in the generation request. Text-to-speech (TTS) efficiently generates prompts, greetings, and announcements by converting written text into synthesized audio using the specified voice.

  • Write

    Upload a binary announcement greeting at organization level

    Upload a binary file to the announcement repository at an organization level. An admin can upload a file at an organization level. This file will be uploaded to the announcement repository.

  • Write

    Generate Upload URL

    Generate a pre-signed S3 upload URL, KMS encryption key for uploading an announcement media file. And file URI to create announcement using the media file. To encrypt and upload the announcement media file: 1.

  • Write

    Upload a binary announcement greeting at the location level

    Upload a binary file to the announcement repository at a location level. An admin can upload a file at a location level. This file will be uploaded to the announcement repository.

  • Write

    Generate a Text-to-Speech Prompt

    Generate a text-to-speech prompt from the provided text, voice, and language. Text-to-speech (TTS) efficiently generates prompts, greetings, and announcements by converting written text into synthesized audio using the specified voice.

  • Destructive

    Modify a binary announcement greeting at organization level

    Modify an existing announcement greeting at an organization level. An admin can upload a file or modify an existing file at an organization level. This file will be uploaded to the announcement repository.

  • Destructive

    Delete an announcement greeting of the organization

    Delete an announcement greeting for an organization. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Modify a binary announcement greeting at location level

    Modify an existing announcement greeting at a location level. An admin can upload a file or modify an existing file at a location level. This file will be uploaded to the announcement repository.

  • Destructive

    Delete an announcement greeting in a location

    Delete an announcement greeting in a location. This API requires a full administrator or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

Features: Auto Attendant

  • Read

    Read the List of Auto Attendants

    List all Auto Attendants for the organization. Auto attendants play customized prompts and provide callers with menu options for routing their calls through your system.

  • Read

    Get Details for an Auto Attendant

    Retrieve an Auto Attendant details. Auto attendants play customized prompts and provide callers with menu options for routing their calls through your system.

  • Read

    Get Call Forwarding Settings for an Auto Attendant

    Retrieve Call Forwarding settings for the designated Auto Attendant including the list of call forwarding rules. The call forwarding feature allows you to direct all incoming calls based on specific criteria that you define.

  • Read

    Get Selective Call Forwarding Rule for an Auto Attendant

    Retrieve a Selective Call Forwarding Rule's settings for the designated Auto Attendant. A selective call forwarding rule for an auto attendant allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.

  • Read

    Get Auto Attendant Primary Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as the auto attendant's primary phone number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are unassigned.

  • Read

    Get Auto Attendant Alternate Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as the auto attendant's alternate number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are unassigned.

  • Read

    Get Auto Attendant Call Forward Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as the auto attendant's call forward number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are assigned to an owning entity.

  • Read

    Read the List of Auto Attendant Announcement Files

    List file info for all auto attendant announcement files associated with this auto attendant. Auto attendant announcement files contain messages and music that callers hear while waiting in the queue.

  • Write

    Create an Auto Attendant

    Create new Auto Attendant for the given location. Auto attendants play customized prompts and provide callers with menu options for routing their calls through your system.

  • Write

    Create a Selective Call Forwarding Rule for an Auto Attendant

    Create a Selective Call Forwarding Rule for the designated Auto Attendant. A selective call forwarding rule for an auto attendant allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.

  • Write

    Switch Mode for Call Forwarding Settings for an Auto Attendant

    Switches the current operating mode of the Auto Attendant to the mode as per normal operations. Operating modes allow call forwarding to be configured based on predefined schedules, enabling different routing behaviors during business hours, after hours, or holidays.

  • Destructive

    Update an Auto Attendant

    Update the designated Auto Attendant. Auto attendants play customized prompts and provide callers with menu options for routing their calls through your system.

  • Destructive

    Delete an Auto Attendant

    Delete the designated Auto Attendant. Auto attendants play customized prompts and provide callers with menu options for routing their calls through your system.

  • Destructive

    Update Call Forwarding Settings for an Auto Attendant

    Update Call Forwarding settings for the designated Auto Attendant. The call forwarding feature allows you to direct all incoming calls based on specific criteria that you define. Below are the available options for configuring your call forwarding: 1.

  • Destructive

    Update Selective Call Forwarding Rule for an Auto Attendant

    Update a Selective Call Forwarding Rule's settings for the designated Auto Attendant. A selective call forwarding rule for an auto attendant allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.

  • Destructive

    Delete a Selective Call Forwarding Rule for an Auto Attendant

    Delete a Selective Call Forwarding Rule for the designated Auto Attendant. A selective call forwarding rule for an auto attendant allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.

  • Destructive

    Delete a Auto Attendant Announcement File

    Delete an announcement file for the designated auto attendant. Auto Attendant announcement files contain messages and music that callers hear while waiting in the queue. A auto attendant can be configured to play whatever subset of these announcement files is desired.

Features: Call Park

  • Read

    Read the List of Call Parks

    List all Call Parks for the organization. Call Park allows call recipients to place a call on hold so that it can be retrieved from another device.

  • Read

    Get Details for a Call Park

    Retrieve Call Park details. Call Park allows call recipients to place a call on hold so that it can be retrieved from another device.

  • Read

    Get available agents from Call Parks

    Retrieve available agents from call parks for a given location. Call Park allows call recipients to place a call on hold so that it can be retrieved from another device.

  • Read

    Get available recall hunt groups from Call Parks

    Retrieve available recall hunt groups from call parks for a given location. Call Park allows call recipients to place a call on hold so that it can be retrieved from another device.

  • Read

    Get Call Park Settings

    Retrieve Call Park Settings from call parks for a given location. Call Park allows call recipients to place a call on hold so that it can be retrieved from another device.

  • Read

    Read the List of Call Park Extensions

    List all Call Park Extensions for the organization. The Call Park service, enabled for all users by default, allows a user to park a call against an available user's extension or to a Call Park Extension.

  • Read

    Get Details for a Call Park Extension

    Retrieve Call Park Extension details. The Call Park service, enabled for all users by default, allows a user to park a call against an available user's extension or to a Call Park Extension.

  • Write

    Create a Call Park

    Create new Call Parks for the given location. Call Park allows call recipients to place a call on hold so that it can be retrieved from another device.

  • Write

    Create a Call Park Extension

    Create new Call Park Extensions for the given location. Call Park Extension enables a call recipient to park a call to an extension, so someone else within the same Organization can retrieve the parked call by dialing that extension.

  • Destructive

    Update a Call Park

    Update the designated Call Park. Call Park allows call recipients to place a call on hold so that it can be retrieved from another device. Updating a call park requires a full administrator or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Delete a Call Park

    Delete the designated Call Park. Call Park allows call recipients to place a call on hold so that it can be retrieved from another device. Deleting a call park requires a full administrator or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Update Call Park settings

    Update Call Park settings for the designated location. Call Park allows call recipients to place a call on hold so that it can be retrieved from another device.

  • Destructive

    Update a Call Park Extension

    Update the designated Call Park Extension. Call Park Extension enables a call recipient to park a call to an extension, so someone else within the same Organization can retrieve the parked call by dialing that extension.

  • Destructive

    Delete a Call Park Extension

    Delete the designated Call Park Extension. Call Park Extension enables a call recipient to park a call to an extension, so someone else within the same Organization can retrieve the parked call by dialing that extension.

Features: Call Pickup

  • Read

    Read the List of Call Pickups

    List all Call Pickups for the organization. Call Pickup enables a user (agent) to answer any ringing line within their pickup group.

  • Read

    Get Details for a Call Pickup

    Retrieve the designated Call Pickup details. Call Pickup enables a user (agent) to answer any ringing line within their pickup group.

  • Read

    Get available agents from Call Pickups

    Retrieve available agents from call pickups for a given location. Call Pickup enables a user (agent) to answer any ringing line within their pickup group.

  • Write

    Create a Call Pickup

    Create new Call Pickups for the given location. Call Pickup enables a user (agent) to answer any ringing line within their pickup group. Creating a call pickup requires a full administrator or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Update a Call Pickup

    Update the designated Call Pickup. Call Pickup enables a user (agent) to answer any ringing line within their pickup group. Updating a call pickup requires a full administrator or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Delete a Call Pickup

    Delete the designated Call Pickup. Call Pickup enables a user (agent) to answer any ringing line within their pickup group. Deleting a call pickup requires a full administrator or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

Features: Call Queue

  • Read

    Read the List of Call Queue or Customer Assist Queues

    List all Call Queues for the organization. Call queues temporarily hold calls in the cloud, when all agents assigned to receive calls from the queue are unavailable. Queued calls are routed to an available agent, when not on an active call.

  • Read

    Get Call Queue Settings

    Retrieve Call Queue Settings for a specific organization. Call Queue Settings configure organization-wide defaults for call queues, including supervisor tone notifications for barge in, silent monitoring, and coaching; optimized simultaneous-ring handling that preserves caller q…

  • Read

    Get Details for a Call Queue or Customer Assist Queue

    Retrieve Call Queue details. Call queues temporarily hold calls in the cloud, when all agents assigned to receive calls from the queue are unavailable. Queued calls are routed to an available agent, when not on an active call.

  • Read

    Read the List of Call Queue Announcement Files

    List file info for all Call Queue announcement files associated with this Call Queue. Call Queue announcement files contain messages and music that callers hear while waiting in the queue.

  • Read

    Get Call Forwarding Settings for a Call Queue

    Retrieve Call Forwarding settings for the specified Call Queue, including the list of call forwarding rules. The call forwarding feature allows you to direct all incoming calls based on specific criteria that you define.

  • Read

    Get Selective Call Forwarding Rule for a Call Queue

    Retrieve a Selective Call Forwarding Rule's settings for the designated Call Queue. A selective call forwarding rule for a call queue allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.

  • Read

    Get Details for a Call Queue Holiday Service

    Retrieve Call Queue Holiday Service details. Configure the call queue to route calls differently during the holidays.

  • Read

    Get Details for a Call Queue Night Service

    Retrieve Call Queue Night service details. Configure the call queue to route calls differently during the hours when the queue is not in service. This is determined by a schedule that defines the business hours of the queue.

  • Read

    Get Details for a Call Queue Forced Forward

    Retrieve Call Queue policy Forced Forward details. This policy allows calls to be temporarily diverted to a configured destination.

  • Read

    Get Details for a Call Queue Stranded Calls

    Allow admin to view default/configured Stranded Calls settings, including whether the stranded calls queue policy will be triggered when all agents are unreachable.

  • Read

    Get Call Queue Primary Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as the call queue's primary phone number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are unassigned.

  • Read

    Get Call Queue Alternate Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as the call queue's alternate phone number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are unassigned.

  • Read

    Get Call Queue Call Forward Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as the call queue's call forward number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are assigned to an owning entity.

  • Read

    Get Call Queue Available Agents

    List all available users, workspaces, or virtual lines that can be assigned as call queue agents. Available agents are users (excluding users with Webex Calling Standard license), workspaces, or virtual lines that can be assigned to a call queue.

  • Read

    Get List of Supervisors for Call Queue or Customer Assist

    Get list of supervisors for an organization. Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.

  • Read

    Get Supervisor Details for Call Queue or Customer Assist

    Get details of a specific supervisor, which includes the agents associated agents with the supervisor, in an organization.

  • Read

    List Available Supervisors for Call Queue or Customer Assist

    Get list of available supervisors for an organization. Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.

  • Read

    List Available Agents for Call Queue or Customer Assist

    Get list of available agents for an organization. Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.

  • Read

    Read the List of Agents for Call Queue or Customer Assist

    List all Call Queues Agents for the organization. Agents can be users, workplace or virtual lines assigned to a call queue. Calls from the call queue are routed to agents based on configuration.

  • Read

    Get Details for an Agent for Call Queue or Customer Assist

    Retrieve details of a particular Call queue agent based on the agent ID. Agents can be users, workplace or virtual lines assigned to a call queue. Calls from the call queue are routed to agents based on configuration.

  • Read

    Get List of DNIS for a Call Queue

    Get the list of DNIS (Dialed Number Identification Service) entries for a call queue. DNIS allows call queues to distinguish between primary and alternate numbers when delivering calls to agents.

  • Read

    Get a DNIS for a Call Queue

    Get details of a specific DNIS (Dialed Number Identification Service) entry for a call queue. Retrieving DNIS details requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Get DNIS Settings for a Call Queue

    Get DNIS (Dialed Number Identification Service) settings for a call queue. Retrieving DNIS settings requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Get DNIS Announcements for a Call Queue

    Get the announcement settings for a specific DNIS (Dialed Number Identification Service) entry in a call queue. This includes welcome message, comfort message, music on hold, wait message, and whisper message settings.

  • Read

    Get Available Phone Numbers for DNIS

    Get the list of available phone numbers that can be assigned to a DNIS for call queues at a location. Retrieving available numbers requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Write

    Create Call Queue or Customer Assist Queue

    Create new Call Queues for the given location. Call queues temporarily hold calls in the cloud, when all agents assigned to receive calls from the queue are unavailable. Queued calls are routed to an available agent, when not on an active call.

  • Write

    Create a Selective Call Forwarding Rule for a Call Queue

    Create a Selective Call Forwarding Rule for the designated Call Queue. A selective call forwarding rule for a call queue allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.

  • Write

    Create a Supervisor for Call Queue or Customer Assist

    Create a new supervisor. The supervisor must be created with at least one agent. Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.

  • Write

    Switch Mode for Call Forwarding Settings for a Call Queue

    Switches the current operating mode of the Call Queue to the mode as per normal operations. Operating modes allow call forwarding to be configured based on predefined schedules, enabling different routing behaviors during business hours, after hours, or holidays.

  • Write

    Create a DNIS for a Call Queue

    Create a new DNIS (Dialed Number Identification Service) entry for a call queue. DNIS allows call queues to distinguish between primary and alternate numbers when delivering calls to agents. The maximum number of DNIS entries per call queue is 100.

  • Destructive

    Update Call Queue Settings

    Update Call Queue Settings for a specific organization. Call Queue Settings configure organization-wide defaults for call queues, including supervisor tone notifications for barge in, silent monitoring, and coaching; optimized simultaneous-ring handling that preserves caller que…

  • Destructive

    Update a Call Queue

    Update the designated Call Queue. Call queues temporarily hold calls in the cloud when all agents, which can be users or agents, assigned to receive calls from the queue are unavailable. Queued calls are routed to an available agent when not on an active call.

  • Destructive

    Delete a Call Queue

    Delete the designated Call Queue. Call queues temporarily hold calls in the cloud when all agents, which can be users or agents, assigned to receive calls from the queue are unavailable. Queued calls are routed to an available agent when not on an active call.

  • Destructive

    Delete a Call Queue Announcement File

    Delete an announcement file for the designated Call Queue. Call Queue announcement files contain messages and music that callers hear while waiting in the queue. A call queue can be configured to play whatever subset of these announcement files is desired.

  • Destructive

    Update Call Forwarding Settings for a Call Queue

    Update Call Forwarding settings for the designated Call Queue. The call forwarding feature allows you to direct all incoming calls based on specific criteria that you define. Below are the available options for configuring your call forwarding: 1.

  • Destructive

    Update a Selective Call Forwarding Rule for a Call Queue

    Update a Selective Call Forwarding Rule's settings for the designated Call Queue. A selective call forwarding rule for a call queue allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.

  • Destructive

    Delete a Selective Call Forwarding Rule for a Call Queue

    Delete a Selective Call Forwarding Rule for the designated Call Queue. A selective call forwarding rule for a call queue allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.

  • Destructive

    Update a Call Queue Holiday Service

    Update the designated Call Queue Holiday Service. Configure the call queue to route calls differently during the holidays. Updating a call queue holiday service requires a full administrator or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Update a Call Queue Night Service

    Update Call Queue Night Service details. Configure the call queue to route calls differently during the hours when the queue is not in service. This is determined by a schedule that defines the business hours of the queue.

  • Destructive

    Update a Call Queue Forced Forward Service

    Update the designated Forced Forward Service. If the option is enabled, then incoming calls to the queue are forwarded to the configured destination. Calls that are already in the queue remain queued.

  • Destructive

    Update a Call Queue Stranded Calls Service

    Update the designated Call Stranded Calls Service. Allow admin to modify configured Stranded Calls settings, including whether the stranded calls queue policy will be triggered when all agents are unreachable.

  • Destructive

    Delete Call Queue or Customer Assist Supervisors

    Delete the Call Queue or Customer Assist supervisors for an organization. Once you remove the supervisor, assigned agents will lose their supervisor assignments. Supervisors are users who manage agents and who perform functions including monitoring, coaching, and more.

  • Destructive

    Assign or Unassign Agents to Supervisor for Call Queue or Customer Assist

    Assign or unassign agents to the supervisor for an organization. Agents in a call queue can be associated with a supervisor who can silently monitor, coach, barge in or to take over calls that their assigned agents are currently handling.

  • Destructive

    Delete a Supervisor

    Deletes the supervisor from an organization. Supervisors are users who manage agents and who perform functions including monitoring, coaching, and more. Requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Update an Agent's Settings for One or More Call Queue or Customer Assist Queues

    Modify an agent's call queue settings for an organization. Calls from the call queue are routed to agents based on configuration. An agent can be assigned to one or more call queues and can be managed by supervisors.

  • Destructive

    Bulk Delete DNIS for a Call Queue

    Bulk delete a list of DNIS (Dialed Number Identification Service) entries for a call queue. A maximum of 99 DNIS entries can be deleted in a single request. Deleting DNIS entries requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Modify a DNIS for a Call Queue

    Modify a DNIS (Dialed Number Identification Service) entry for a call queue. To remove a phone number or extension from the DNIS, set the field to null. Modifying a DNIS requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Delete a DNIS for a Call Queue

    Delete a DNIS (Dialed Number Identification Service) entry for a call queue. Deleting a DNIS requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Modify DNIS Settings for a Call Queue

    Modify DNIS (Dialed Number Identification Service) settings for a call queue. Modifying DNIS settings requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Modify DNIS Announcements for a Call Queue

    Modify the announcement settings for a specific DNIS (Dialed Number Identification Service) entry in a call queue. This includes welcome message, comfort message, music on hold, wait message, and whisper message settings.

Features: Call Recording

  • Read

    Get Call Recording Settings

    Retrieve call recording settings for the organization. The Call Recording feature enables authorized agents to record any active call that Webex Contact Center manages.

  • Read

    Get Call Recording Terms of Service Settings

    Retrieve call recording terms of service settings for the organization. The Call Recording feature enables authorized agents to record any active call that Webex Contact Center manages.

  • Read

    Get Details for the Organization Compliance Announcement Setting

    Retrieve the organization compliance announcement settings. The Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement.

  • Read

    Get Details of Call Recording Compliance Announcement for the Location

    Retrieve the location compliance announcement settings. The Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement.

  • Read

    Get Call Recording Regions

    Retrieve all the call recording regions that are available for an organization. The Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings.

  • Read

    Get Call Recording Vendor Users

    Retrieve call recording vendor users of an organization. This API is used to get the list of users who are assigned to the default call-recording vendor of the organization.

  • Read

    Get Location Call Recording Vendors

    Retrieve details of the call recording vendor that the location is assigned and also a list of vendors. The Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings.

  • Read

    Get Call Recording Vendor Users for a Location

    Retrieve call recording vendor users of a location. This API is used to get the list of users assigned to the call recording vendor of the location.

  • Read

    List Call Recording Jobs

    Get the list of all call recording jobs in an organization. The Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings.

  • Read

    Get the Job Status of a Call Recording Job

    Get the details of a call recording job by its job ID. The Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings.

  • Read

    Get Job Errors for a Call Recording Job

    Get errors for a call recording job in an organization. The Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings.

  • Read

    Get Organization Call Recording Vendors

    Returns what the current vendor is as well as a list of all the available vendors. The Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings.

  • Read

    Get Organization Call Recording Announcement Settings

    Retrieve the organization call recording announcements setting. The call recording Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement.

  • Read

    Get Location Call Recording Announcement Settings

    Retrieve the location call recording announcements setting. The Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement.

  • Destructive

    Update Call Recording Settings

    Update call recording settings for the organization. The Call Recording feature enables authorized agents to record any active call that Webex Contact Center manages.

  • Destructive

    Update Call Recording Terms of Service Settings

    Update call recording terms of service settings for the given vendor. The Call Recording feature enables authorized agents to record any active call that Webex Contact Center manages.

  • Destructive

    Update the Organization Compliance Announcement

    Update the organization compliance announcement. The Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement.

  • Destructive

    Update Call Recording Compliance Announcement for the Location

    Update the location compliance announcement. The Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement.

  • Destructive

    Set Call Recording Vendor for a Location

    Assign a call recording vendor to a location of an organization. Response will be 204 if the changes can be applied immediatley otherwise 200 with a job ID is returned.

  • Destructive

    Set Organization Call Recording Vendor

    Returns a Job ID that you can use to get the status of the job. The Call Recording feature supports multiple third-party call recording providers, or vendors, to capture and manage call recordings.

  • Destructive

    Update Organization Call Recording Announcement Settings

    Update Organization Call Recording Announcement Settings. The Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement.

  • Destructive

    Update Location Call Recording Announcement Settings

    Update Location Call Recording Announcement Settings. The Compliance Announcement feature interacts with the Call Recording feature, specifically with the playback of the start/stop announcement.

Features: Customer Assist

  • Read

    List Wrap Up Reasons

    Return the list of wrap-up reasons configured for a customer. Agents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.

  • Read

    Read Wrap Up Reason

    Return the wrap-up reason by ID. Agents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.

  • Read

    Validate Wrap Up Reason

    Validate the wrap-up reason name. Agents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.

  • Read

    Read Available Queues

    Return the available queues for a wrap-up reason. Agents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.

  • Read

    Read Wrap Up Reason Settings

    Return a wrap-up reason by location ID and queue ID. Agents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.

  • Read

    Read Screen Pop Configuration

    Returns the screen pop configuration for a call queue in a location. Screen pop lets agents view customer-related info in a pop-up window.

  • Read

    List Available Agents

    Return a list of available agents with Customer Assist license in a location. Retrieving the list of available agents requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Get Available Agents

    List eligible people who can be assigned as Customer Assist agents. Returns people with a Webex Calling Professional license across all locations visible to the caller's authorization. Workspaces and virtual lines are not included.

  • Write

    Create Wrap Up Reason

    Create a wrap-up reason. Agents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.

  • Destructive

    Update Wrap Up Reason

    Modify a wrap-up reason. Agents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.

  • Destructive

    Delete Wrap Up Reason

    Delete a wrap-up reason. Agents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.

  • Destructive

    Update Wrap Up Reason Settings

    Modify a wrap-up reason by location ID and queue ID. Agents handling calls use wrap-up reasons to categorize the outcome after a call ends. The control hub admin can configure these reasons for customers and assign them to queues.

  • Destructive

    Update Screen Pop Configuration

    Modifies the screen pop configuration for a call queue in a location. Screen pop lets agents view customer-related info in a pop-up window. Modifying the screen pop configuration requires a full or device administrator auth token with a scope of spark-admin:telephonyconfigwrite.

Call Settings Configurable Storage Region

  • Read

    Get the Data (Storage) Policy Settings for the Organization

    Retrieve the settings for data (storage) policy region of the organization. Data policies allow administrators to configure the storage region for organization data at the organization or location level.

  • Read

    Get All the Storage Regions Available for Configuring as Data Policy Region

    Retrieve all the storage regions available for configuring data (storage) policy of an organization or organization's location. Data policies allow administrators to configure the storage region for organization data at the organization or location level.

  • Read

    Get the Data (Storage) Policy Settings for the Organization's Location

    Retrieve the settings for data (storage) policy region of the organization's location. Data policies allow administrators to configure the storage region for organization data at the organization or location level.

  • Destructive

    Update the Data (Storage) Policy Settings for the Organization

    Modify the configurations for data (storage) policy region of the organization. Data policies allow administrators to configure the storage region for organization data at the organization or location level.

  • Destructive

    Update the Data (Storage) Policy Settings for the Organization's Location

    Modify the configurations for data (storage) policy region of the organization's location. Data policies allow administrators to configure the storage region for organization data at the organization or location level.

Features: Hot Desking Sign in via Voice Portal

  • Read

    Voice Portal Hot desking sign in details for a location

    Get the Hot desking sign in details for a location. This requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Voice Portal Hot desking sign in details for a user

    Get the Hot desking sign in details for a user. This requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Destructive

    Update Voice Portal Hot desking sign in details for a location

    Update the Hot desking sign in details for a location. This requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Update Voice Portal Hot desking sign in details for a user

    Update the Hot desking sign in details for a user. This requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

Features: Hunt Group

  • Read

    Read the List of Hunt Groups

    List all calling Hunt Groups for the organization. Hunt groups can route incoming calls to a group of people or workspaces. You can even configure a pattern to route to a whole group.

  • Read

    Get Details for a Hunt Group

    Retrieve Hunt Group details. Hunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.

  • Read

    Get Call Forwarding Settings for a Hunt Group

    Retrieve Call Forwarding settings for the specified Hunt Group including the list of call forwarding rules. The call forwarding feature allows you to direct all incoming calls based on specific criteria that you define.

  • Read

    Get Selective Call Forwarding Rule for a Hunt Group

    Retrieve a Selective Call Forwarding Rule's settings for the designated Hunt Group. A selective call forwarding rule for a hunt group allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.

  • Read

    Get Hunt Group Primary Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as the hunt group's primary phone number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are unassigned.

  • Read

    Get Hunt Group Alternate Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as the hunt group's alternate phone number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are unassigned.

  • Read

    Get Hunt Group Call Forward Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as the hunt group's call forward number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are assigned to an owning entity.

  • Write

    Create a Hunt Group

    Create new Hunt Groups for the given location. Hunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.

  • Write

    Create a Selective Call Forwarding Rule for a Hunt Group

    Create a Selective Call Forwarding Rule for the designated Hunt Group. A selective call forwarding rule for a hunt group allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.

  • Write

    Switch Mode for Call Forwarding Settings for a Hunt Group

    Switches the current operating mode of the Hunt Group to the mode as per normal operations. Operating modes allow call forwarding to be configured based on predefined schedules, enabling different routing behaviors during business hours, after hours, or holidays.

  • Destructive

    Update a Hunt Group

    Update the designated Hunt Group. Hunt groups can route incoming calls to a group of people, workspaces or virtual lines. You can even configure a pattern to route to a whole group.

  • Destructive

    Delete a Hunt Group

    Delete the designated Hunt Group. Hunt groups can route incoming calls to a group of people or workspaces. You can even configure a pattern to route to a whole group.

  • Destructive

    Update Call Forwarding Settings for a Hunt Group

    Update Call Forwarding settings for the specified Hunt Group. The call forwarding feature allows you to direct all incoming calls based on specific criteria that you define. Below are the available options for configuring your call forwarding: 1.

  • Destructive

    Update a Selective Call Forwarding Rule for a Hunt Group

    Update a Selective Call Forwarding Rule's settings for the designated Hunt Group. A selective call forwarding rule for a hunt group allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.

  • Destructive

    Delete a Selective Call Forwarding Rule for a Hunt Group

    Delete a Selective Call Forwarding Rule for the designated Hunt Group. A selective call forwarding rule for a hunt group allows calls to be forwarded or not forwarded to the designated number, based on the defined criteria.

Features: Operating Modes

  • Read

    Read the List of Operating Modes

    Retrieve Operating Modes list defined at location, or organization level. Use query parameters to filter the result set by location or level. The list returned is sorted in ascending order by operating mode name. Long result sets are split into pages.

  • Read

    Get Details for an Operating Mode

    Retrieve an Operating Mode by Operating Mode ID. Operating modes can be used to define call routing rules for different scenarios like business hours, after hours, holidays, etc.

  • Read

    Get details for an Operating Mode Holiday

    Retrieve an Operating Mode Holiday by ID. Holidays define a recurring schedule for the Operating Modes. Retrieving an Operating Mode Holiday requires a full, read-only, or location administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Retrieve the List of Available Operating Modes in a Location

    Retrieve list of Operating Modes which are available to be assigned to a location level feature (Auto Attendant, Call Queue, or Hunt Group). Since each location and an org can have a max of 100 Operating Modes defined.

  • Read

    Get Operating Mode Call Forward Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as a operating mode's call forward number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are assigned to an owning entity.

  • Write

    Create an Operating Mode

    Create an Operating Mode at an organization, or a location level. Operating modes can be used to define call routing rules for different scenarios like business hours, after hours, holidays, etc.

  • Write

    Create an Operating Mode Holiday

    Create a holiday schedule event for the designated Operating Mode. Holidays define a recurring schedule for the Operating Modes. An Operating Mode can have a max of 150 holidays.

  • Destructive

    Modify an Operating Mode

    Modify the designated Operating Mode's configuration. Operating modes can be used to define call routing rules for different scenarios like business hours, after hours, holidays, etc.

  • Destructive

    Delete an Operating Mode

    Delete the designated Operating Mode. Deleting an Operating Mode requires a full, or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Modify an Operating Mode Holiday

    Modify the designated Operating Mode Holiday's configuration. Modifying an Operating Mode Holiday requires a full, or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Delete an Operating Mode Holiday

    Delete the designated Operating Mode Holiday. Deleting an Operating Mode Holiday requires a full, or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

Features: Paging Group

  • Read

    Read the List of Paging Groups

    List all Paging Groups for the organization. Group Paging allows a person to place a one-way call or group page to up to 75 people and/or workspaces by dialing a number or extension assigned to a specific paging group.

  • Read

    Get Details for a Paging Group

    Retrieve Paging Group details. Group Paging allows a person, place or virtual line a one-way call or group page to up to 75 people and/or workspaces and/or virtual line by dialing a number or extension assigned to a specific paging group.

  • Read

    Get Paging Group Primary Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as the paging group's primary phone number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are unassigned.

  • Write

    Create a new Paging Group

    Create a new Paging Group for the given location. Group Paging allows a one-way call or group page to up to 75 people, workspaces and virtual lines by dialing a number or extension assigned to a specific paging group.

  • Destructive

    Update a Paging Group

    Update the designated Paging Group. Group Paging allows a person to place a one-way call or group page to up to 75 people, workspaces and virtual lines by dialing a number or extension assigned to a specific paging group.

  • Destructive

    Delete a Paging Group

    Delete the designated Paging Group. Group Paging allows a person to place a one-way call or group page to up to 75 people and/or workspaces by dialing a number or extension assigned to a specific paging group.

Features: Single Number Reach

  • Read

    Get Single Number Reach Primary Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as the single number reach's primary phone number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are unassigned.

  • Read

    Get Single Number Reach Settings For A Person

    Retrieve Single Number Reach settings for the given person. Single number reach allows you to setup your work calls ring any phone number.

  • Write

    Create Single Number Reach For a Person

    Create a single number reach for a person in an organization. Single number reach allows you to setup your work calls ring any phone number.

  • Destructive

    Update Single Number Reach Settings For A Person

    Update Single number reach settings for a person. Single number reach allows you to setup your work calls ring any phone number. This means that your office phone, mobile phone, or any other designated devices can ring at the same time, ensuring you don't miss important calls.

  • Destructive

    Update Single Number Reach Settings For A Number

    Update Single number reach settings for a number. Single number reach allows you to setup your work calls ring any phone number. This means that your office phone, mobile phone, or any other designated devices can ring at the same time, ensuring you don't miss important calls.

  • Destructive

    Delete A Single Number Reach Number

    Delete Single number reach number for a person. Single number reach allows you to setup your work calls ring any phone number. This means that your office phone, mobile phone, or any other designated devices can ring at the same time, ensuring you don't miss important calls.

Features: Virtual Extensions

  • Read

    Read the List of Virtual Extensions

    Retrieve virtual extensions associated with a specific customer. The GET Virtual Extensions API allows administrators to retrieve a list of virtual extensions configured within their organization.

  • Read

    Get a Virtual Extension

    Retrieve Virtual Extension details for the given extension ID. Virtual extensions integrate remote workers on separate telephony systems into Webex Calling, enabling users to reach them via extension dialing.

  • Read

    Get Virtual extension settings

    Retrieve Virtual Extension settings for the given Org. This API retrieves the virtual extension mode settings configured for a given organization. Virtual extensions can operate in two modes: STANDARD and ENHANCED.

  • Read

    Validate an external phone number

    Validate external phone number for the given organization. This API is designed to validate external phone numbers before they are assigned as virtual extensions for a customer.

  • Read

    Get a list of a Virtual Extension Range

    Retrieves the list of Virtual Extension Ranges. Virtual extension ranges integrate remote workers on a separate telephony system into Webex Calling and enable extension dialing.

  • Read

    Get details of a Virtual Extension Range

    Retrieve virtual extension range details for the given extension range ID. Virtual extension ranges integrate remote workers on a separate telephony system into Webex Calling and enable extension dialing.

  • Read

    Validate the prefix and extension pattern for a Virtual Extension Range

    Validate the prefix and extension pattern for a Virtual Extension Range. Virtual extension ranges integrate remote workers on a separate telephony system into Webex Calling and enable extension dialing.

  • Write

    Create a Virtual Extension

    Create new Virtual Extension for the given organization or location. You can set up virtual extensions at the organization or location level. The organization level enables everyone across your organization to dial the same extension number to reach someone.

  • Write

    Create a Virtual Extension Range

    Create a new Virtual Extension Range for the given organization or location. Virtual extension ranges integrate remote workers on a separate telephony system into Webex Calling and enable extension dialing.

  • Destructive

    Update a Virtual Extension

    Update Virtual Extension details for the given extension ID. This API updates the configuration of an existing virtual extension identified by its unique extension ID.

  • Destructive

    Delete a Virtual Extension

    Delete Virtual Extension using the extension ID. This API permanently deletes a virtual extension from the organization. Once deleted, the extension will no longer route calls to the external phone number, and users won’t be able to reach it via the assigned extension.

  • Destructive

    Modify Virtual Extension Settings

    Update Virtual Extension details for the given extension ID. This endpoint updates the virtual extension settings for an organization. It is primarily used to configure the operating mode for virtual extensions.

  • Destructive

    Modify Virtual Extension Range

    Modify virtual extension range for the given extension range ID. Virtual extension ranges integrate remote workers on a separate telephony system into Webex Calling and enable extension dialing.

  • Destructive

    Delete a Virtual Extension Range

    Delete a virtual extension range for the given extension range ID. Virtual extension ranges integrate remote workers on a separate telephony system into Webex Calling and enable extension dialing.

Location Call Settings: Call Handling

  • Read

    Read the Internal Dialing configuration for a location

    Get current configuration for routing unknown extensions to the Premises as internal calls If some users in a location are registered to a PBX, retrieve the setting to route unknown extensions (digits that match the extension length) to the PBX.

  • Read

    Get Location Intercept

    Retrieve intercept location details for a customer location. Intercept incoming or outgoing calls for persons in your organization. If this is enabled, calls are either routed to a designated number the person chooses, or to the person's voicemail.

  • Read

    Get Location Outgoing Permission

    Retrieve the location's outgoing call settings. A location's outgoing call settings allow you to determine the types of calls the people/workspaces at the location are allowed to make, as well as configure the default calling permission for each call type at the location.

  • Read

    Get Outgoing Permission Auto Transfer Number

    Get the transfer numbers for the outbound permission in a location. Outbound permissions can specify which transfer number an outbound call should transfer to via the action field.

  • Read

    Get Outgoing Permission Location Access Code

    Retrieve access codes details for a customer location. Use Access Codes to bypass the set permissions for all persons/workspaces at this location.

  • Read

    Get Outgoing Permission Digit Pattern for a Location

    Get the digit patterns for the outbound permission in a location. Use Digit Patterns to bypass the set permissions for all persons/workspaces at this location.

  • Read

    Get Details for a Outgoing Permission Digit Pattern for a Location

    Get the digit pattern details. Use Digit Patterns to bypass the set permissions for all persons/workspaces at this location.

  • Write

    Generate example password for Location

    Generates an example password using the effective password settings for the location. If you don't specify anything in the generate field or don't provide a request body, then you will receive a SIP password by default.

  • Write

    Create Outgoing Permission a new access code for a customer location

    Add a new access code for the given location for a customer. Use Access Codes to bypass the set permissions for all persons/workspaces at this location.

  • Write

    Create Outgoing Permission a new Digit Pattern for a location

    Add a new digit pattern for the given location for a customer. Use Digit Patterns to bypass the set permissions for all persons/workspaces at this location.

  • Destructive

    Modify the Internal Dialing configuration for a location

    Modify current configuration for routing unknown extensions to the premise as internal calls If some users in a location are registered to a PBX, enable the setting to route unknown extensions (digits that match the extension length) to the PBX.

  • Destructive

    Put Location Intercept

    Modifies the intercept location details for a customer location. Intercept incoming or outgoing calls for users in your organization. If this is enabled, calls are either routed to a designated number the user chooses, or to the user's voicemail.

  • Destructive

    Update Location Outgoing Permission

    Update the location's outgoing call settings. Location's outgoing call settings allows you to determine the types of calls the people/workspaces at this location are allowed to make and configure the default calling permission for each call type at a location.

  • Destructive

    Put Outgoing Permission Auto Transfer Number

    Modifies the transfer numbers for the outbound permission in a location. Outbound permissions can specify which transfer number an outbound call should transfer to via the action field.

  • Destructive

    Delete Outgoing Permission Access Code Location

    Deletes the access code details for a particular location for a customer. Use Access Codes to bypass the set permissions for all persons/workspaces at this location.

  • Destructive

    Delete all Outgoing Permission Access Code for a Location

    Deletes all the access codes for a particular location for a customer. Use Access Codes to bypass the set permissions for all persons/workspaces at this location.

  • Destructive

    Delete all Outgoing Permission Digit Patterns for a Location

    Deletes all the digit patterns for a particular location for a customer. Use Digit Patterns to bypass the set permissions for all persons/workspaces at this location.

  • Destructive

    Update a Outgoing Permission Digit Pattern for a Location

    Update the designated digit pattern. Use Digit Patterns to bypass the set permissions for all persons/workspaces at this location. Updating a digit pattern requires a full administrator or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Delete a Outgoing Permission Digit Pattern for a Location

    Delete the designated digit pattern. Use Digit Patterns to bypass the set permissions for all persons/workspaces at this location. Deleting a digit pattern requires a full administrator or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

Location Call Settings: Schedules

  • Read

    Read the List of Schedules

    List all schedules for the given location of the organization. A time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.

  • Read

    Get Details for a Schedule

    Retrieve Schedule details. A time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.

  • Read

    Get Details for a Schedule Event

    Retrieve Schedule Event details. A time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.

  • Write

    Create a Schedule

    Create new Schedule for the given location. A time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.

  • Write

    Create a Schedule Event

    Create new Event for the given location Schedule. A time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.

  • Destructive

    Update a Schedule Event

    Update the designated Schedule Event. A time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.

  • Destructive

    Delete a Schedule Event

    Delete the designated Schedule Event. A time schedule establishes a set of times during the day or holidays in the year in which a feature, for example auto attendants, can perform a specific action.

User Call Settings (1/2)

  • Read

    Read Barge In Settings for a Person

    Retrieve a person's Barge In settings. The Barge In feature enables you to use a Feature Access Code (FAC) to answer a call that was directed to another subscriber, or barge-in on the call if it was already answered. Barge In can be used across locations.

  • Read

    Read Forwarding Settings for a Person

    Retrieve a person's Call Forwarding settings. Three types of call forwarding are supported: + Always - forwards all incoming calls to the destination you choose.

  • Read

    Read Call Intercept Settings for a Person

    Retrieves Person's Call Intercept settings. The intercept feature gracefully takes a person's phone out of service, while providing callers with informative announcements and alternative routing options.

  • Read

    Read Call Recording Settings for a Person

    Retrieve a person's Call Recording settings. The Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.

  • Read

    Read Call Waiting Settings for a Person

    Retrieve a person's Call Waiting settings. With this feature, a person can place an active call on hold and answer an incoming call. When enabled, while you are on an active call, a tone alerts you of an incoming call and you can choose to answer or ignore the call.

  • Read

    Read Caller ID Settings for a Person

    Retrieve a person's Caller ID settings. Caller ID settings control how a person's information is displayed when making outgoing calls. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of spark-admin:peopleread.

  • Read

    Read Person's Calling Behavior

    Retrieves the calling behavior and UC Manager Profile settings for the person which includes overall calling behavior and calling UC Manager Profile ID. Webex Calling Behavior controls which Webex telephony application and which UC Manager Profile is to be used for a person.

  • Read

    Read Do Not Disturb Settings for a Person

    Retrieve a person's Do Not Disturb settings. When enabled, this feature will give all incoming calls the busy treatment. Optionally, you can enable a Ring Reminder to play a brief tone on your desktop phone when you receive incoming calls.

  • Read

    Retrieve Executive Assistant Settings for a Person

    Retrieve the executive assistant settings for the specified personId. People with the executive service enabled, can select from a pool of assistants who have been assigned the executive assistant service and who can answer or place calls on their behalf.

  • Read

    Read Hoteling Settings for a Person

    Retrieve a person's hoteling settings. As an administrator, you can enable hoteling for people so that their phone profile (phone number, features, and calling plan) is temporarily loaded onto a shared (host) phone.

  • Read

    Read Incoming Permission Settings for a Person

    Retrieve a person's Incoming Permission settings. You can change the incoming calling permissions for a person if you want them to be different from your organization's default.

  • Read

    Retrieve a person's Outgoing Calling Permissions Settings

    Retrieve a person's Outgoing Calling Permissions settings. Outgoing calling permissions regulate behavior for calls placed to various destinations and default to the local level settings.

  • Read

    Get a List of Phone Numbers for a Person

    Get a person's phone numbers including alternate numbers. A person can have one or more phone numbers and/or extensions via which they can be called. This API requires a full or user administrator or location administrator auth token with the spark-admin:peopleread scope.

  • Read

    Get a person's Privacy Settings

    Get a person's privacy settings for the specified person ID. The privacy feature enables the person's line to be monitored by others and determine if they can be reached by Auto Attendant services.

  • Read

    Read Push-to-Talk Settings for a Person

    Retrieve a person's Push-to-Talk settings. Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people in different parts of your organization.

  • Read

    Read Receptionist Client Settings for a Person

    Retrieve a person's Receptionist Client settings. To help support the needs of your front-office personnel, you can set up people, workspaces or virtual lines as telephone attendants so that they can screen all incoming calls to certain numbers within your organization.

  • Read

    List of Schedules for a Person

    List schedules for a person in an organization. Schedules are used to support calling features and can be defined at the location or person level.

  • Read

    Get a Schedule Details

    Retrieve a schedule by its schedule ID. Schedules are used to support calling features and can be defined at the location or person level. businessHours schedules allow you to apply specific call settings at different times of the day or week by defining one or more events.

  • Read

    Fetch Event for a person's Schedule

    People can use shared location schedules or define personal schedules containing events. businessHours schedules allow you to apply specific call settings at different times of the day or week by defining one or more events.

  • Read

    Read Voicemail Settings for a Person

    Retrieve a person's Voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, .wav, format.

  • Write

    Configure Call Intercept Greeting for a Person

    Configure a person's Call Intercept Greeting by uploading a Waveform Audio File Format, .wav, encoded audio file. Your request will need to be a multipart/form-data request rather than JSON, using the audio/wav Content-Type.

  • Write

    Create Schedule for a Person

    Create a new schedule for a person. Schedules are used to support calling features and can be defined at the location or person level. businessHours schedules allow you to apply specific call settings at different times of the day or week by defining one or more events.

  • Write

    Add a New Event for Person's Schedule

    People can use shared location schedules or define personal schedules containing events. businessHours schedules allow you to apply specific call settings at different times of the day or week by defining one or more events.

  • Write

    Configure Busy Voicemail Greeting for a Person

    Configure a person's Busy Voicemail Greeting by uploading a Waveform Audio File Format, .wav, encoded audio file. Your request will need to be a multipart/form-data request rather than JSON, using the audio/wav Content-Type.

  • Write

    Configure No Answer Voicemail Greeting for a Person

    Configure a person's No Answer Voicemail Greeting by uploading a Waveform Audio File Format, .wav, encoded audio file. Your request will need to be a multipart/form-data request rather than JSON, using the audio/wav Content-Type.

  • Write

    Reset Voicemail PIN

    Reset a voicemail PIN for a person. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. A voicemail PIN is used to retrieve your voicemail messages.

  • Destructive

    Update a Schedule

    Modify a schedule by its schedule ID. Schedules are used to support calling features and can be defined at the location or person level. businessHours schedules allow you to apply specific call settings at different times of the day or week by defining one or more events.

  • Destructive

    Delete a Schedule

    Delete a schedule by its schedule ID. Schedules are used to support calling features and can be defined at the location or person level. businessHours schedules allow you to apply specific call settings at different times of the day or week by defining one or more events.

  • Destructive

    Modify a person's Application Services Settings

    Application services let you determine the ringing behavior for calls made to users in certain scenarios. You can also specify which devices users can download the Webex Calling app on.

  • Destructive

    Configure Barge In Settings for a Person

    Configure a person's Barge In settings. The Barge In feature enables you to use a Feature Access Code (FAC) to answer a call that was directed to another subscriber, or barge-in on the call if it was already answered. Barge In can be used across locations.

  • Destructive

    Configure Call Forwarding Settings for a Person

    Configure a person's Call Forwarding settings. Three types of call forwarding are supported: + Always - forwards all incoming calls to the destination you choose.

  • Destructive

    Configure Call Intercept Settings for a Person

    Configures a person's Call Intercept settings. The intercept feature gracefully takes a person's phone out of service, while providing callers with informative announcements and alternative routing options.

  • Destructive

    Configure Call Recording Settings for a Person

    Configure a person's Call Recording settings. The Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.

  • Destructive

    Configure Call Waiting Settings for a Person

    Configure a person's Call Waiting settings. With this feature, a person can place an active call on hold and answer an incoming call. When enabled, while you are on an active call, a tone alerts you of an incoming call and you can choose to answer or ignore the call.

  • Destructive

    Configure Caller ID Settings for a Person

    Configure a person's Caller ID settings. Caller ID settings control how a person's information is displayed when making outgoing calls. This API requires a full or user administrator or location administrator auth token with the spark-admin:peoplewrite scope.

  • Destructive

    Configure a person's Calling Behavior

    Modifies the calling behavior settings for the person which includes calling behavior and UC Manager Profile ID. Webex Calling Behavior controls which Webex telephony application and which UC Manager Profile is to be used for a person.

  • Destructive

    Configure Do Not Disturb Settings for a Person

    Configure a person's Do Not Disturb settings. When enabled, this feature will give all incoming calls the busy treatment. Optionally, you can enable a Ring Reminder to play a brief tone on your desktop phone when you receive incoming calls.

  • Destructive

    Modify Executive Assistant Settings for a Person

    Modify the executive assistant settings for the specified personId. People with the executive service enabled, can select from a pool of assistants who have been assigned the executive assistant service and who can answer or place calls on their behalf.

  • Destructive

    Configure Hoteling Settings for a Person

    Configure a person's hoteling settings. As an administrator, you can enable hoteling for people so that their phone profile (phone number, features, and calling plan) is temporarily loaded onto a shared (host) phone.

  • Destructive

    Configure Incoming Permission Settings for a Person

    Configure a person's Incoming Permission settings. You can change the incoming calling permissions for a person if you want them to be different from your organization's default.

  • Destructive

    Modify a person's Outgoing Calling Permissions Settings

    Modify a person's Outgoing Calling Permissions settings. Outgoing calling permissions regulate behavior for calls placed to various destinations and default to the local level settings.

  • Destructive

    Configure a person's Privacy Settings

    Configure a person's privacy settings for the specified person ID. The privacy feature enables the person's line to be monitored by others and determine if they can be reached by Auto Attendant services.

  • Destructive

    Configure Push-to-Talk Settings for a Person

    Configure a person's Push-to-Talk settings. Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people in different parts of your organization.

  • Destructive

    Configure Receptionist Client Settings for a Person

    Configure a person's Receptionist Client settings. To help support the needs of your front-office personnel, you can set up people, workspaces or virtual lines as telephone attendants so that they can screen all incoming calls to certain numbers within your organization.

  • Destructive

    Update an Event for a person's Schedule

    People can use shared location schedules or define personal schedules containing events. businessHours schedules allow you to apply specific call settings at different times of the day or week by defining one or more events.

  • Destructive

    Delete an Event for a person's Schedule

    People can use shared location schedules or define personal schedules containing events. businessHours schedules allow you to apply specific call settings at different times of the day or week by defining one or more events.

  • Destructive

    Configure Voicemail Settings for a Person

    Configure a person's Voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, .wav, format.

Location Call Settings: Voicemail

  • Read

    Get Location Voicemail

    Retrieve voicemail settings for a specific location. Location voicemail settings allows you to enable voicemail transcription for a specific location.

  • Read

    Get VoicePortal

    Retrieve Voice portal information for the location. Voice portals provide an interactive voice response (IVR) system so administrators can manage auto attendant announcements.

  • Read

    Get VoicePortal Passcode Rule

    Retrieve the voice portal passcode rule for a location. Voice portals provide an interactive voice response (IVR) system so administrators can manage auto attendant anouncements Retrieving the voice portal passcode rule requires a full read-only administrator or location adminis…

  • Read

    List VoicemailGroup

    List the voicemail group information for the organization. You can create a shared voicemail box and inbound FAX box to assign to users or call routing features like an auto attendant, call queue, or hunt group.

  • Read

    Get Location Voicemail Group

    Retrieve voicemail group details for a location. Manage your voicemail group settings for a specific location, like when you want your voicemail to be active, message storage settings, and how you would like to be notified of new voicemail messages.

  • Read

    Get Voicemail Group Fax Message Available Phone Numbers

    List the standard and service PSTN numbers that are available to be assigned as a voicemail group's FAX message phone number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are unassigned.

  • Read

    Get Voicemail Group Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as a voicemail group's phone number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are unassigned.

  • Read

    Get VoicePortal Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as the location voice portal's phone number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are unassigned.

  • Write

    Create a new Voicemail Group for a Location

    Create a new voicemail group for the given location for a customer. A voicemail group can be created for given location for a customer.

  • Destructive

    Update Location Voicemail

    Update the voicemail settings for a specific location. Location voicemail settings allows you to enable voicemail transcription for a specific location.

  • Destructive

    Update VoicePortal

    Update Voice portal information for the location. Voice portals provide an interactive voice response (IVR) system so administrators can manage auto attendant anouncements.

  • Destructive

    Modify Location Voicemail Group

    Modifies the voicemail group location details for a particular location for a customer. Manage your voicemail settings, like when you want your voicemail to be active, message storage settings, and how you would like to be notified of new voicemail messages.

  • Destructive

    Delete a Voicemail Group for a Location

    Delete the designated voicemail group. Deleting a voicemail group requires a full administrator or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

Numbers

  • Read

    Validate Phone Numbers

    Validate the list of phone numbers in an organization. Each phone number's availability is indicated in the response. Each location has a set of phone numbers that can be assigned to people, workspaces, or features.

  • Read

    Get Phone Numbers for an Organization with Given Criteria

    List all the phone numbers for the given organization along with the status and owner (if any). Numbers can be standard, service, or mobile. Both standard and service numbers are PSTN numbers.

  • Read

    List Manage Numbers Jobs

    Lists all Manage Numbers jobs for the given organization in order of most recent one to oldest one irrespective of its status. The public API only supports initiating jobs which move numbers between locations.

  • Read

    Get Manage Numbers Job Status

    Returns the status and other details of the job. Use this API to monitor a Manage Numbers job after it has been initiated. This API requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    List Manage Numbers Job Errors

    Lists all error details of Manage Numbers job. This will not list any errors if exitCode is COMPLETED. If the status is COMPLETEDWITHERRORS then this lists the cause of failures. List of possible Errors: + BATCH-1017021 - Failed to move because it is an inactive number.

  • Write

    Add Phone Numbers to a Location

    Adds a specified set of phone numbers to a location for an organization. Phone numbers must follow the E.164 format. Each location has a set of phone numbers that can be assigned to people, workspaces, or features. Active phone numbers are in service.

  • Write

    Initiate Number Jobs

    Starts the execution of an operation on a set of numbers. Supported operations are: MOVE, NUMBERUSAGECHANGE. Up to 1000 numbers can be given in MOVE operation type and NUMBERUSAGECHANGE operation type per request.

  • Write

    Pause the Manage Numbers Job

    Pause the running Manage Numbers Job. A paused job can be resumed. Use this API when a Manage Numbers job must be temporarily stopped before completion. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Write

    Resume the Manage Numbers Job

    Resume the paused Manage Numbers Job. A paused job can be resumed. Use this API to continue processing a Manage Numbers job that was previously paused. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Manage Number State in a Location

    Activate or deactivate the specified set of phone numbers in a location for an organization. Each location has a set of phone numbers that can be assigned to people, workspaces, or features. Phone numbers must follow the E.164 format. Active phone numbers are in service.

  • Destructive

    Remove Phone Numbers from a Location

    Remove the specified set of phone numbers from a location for an organization. Phone numbers must follow the E.164 format. Removing a mobile number may require more time depending on mobile carrier capabilities.

PSTN

  • Read

    Retrieve PSTN Connection Options for a Location

    Retrieve the list of PSTN connection options available for a location. PSTN location connection settings enables the admin to configure or change the PSTN provider for a location.

  • Read

    Retrieve PSTN Connection for a Location

    Retrieves the current configured PSTN connection details for a location. PSTN location connection settings enables the admin to configure or change the PSTN provider for a location.

  • Read

    Get Modifiable Numbers

    Retrieve modifiable numbers for a location based on action type. The required action query parameter specifies the operation used to identify eligible numbers. This endpoint does not support pagination.

  • Write

    Emergency Address Lookup to Verify if Address is Valid

    Returns a suggested address. If the input address is valid and unchanged, no errors are returned. If the input address requires corrections, the response includes a suggested address along with error details.

  • Write

    Perform Numbers Action

    Perform number usage action for the specified list of numbers. The required action query parameter specifies the operation to apply to the numbers in the request body. The API supports modifying number usage between STANDARD/SERVICE/ELIN.

  • Write

    Add an Emergency Address to a Location

    Adds a new emergency address to the specified location. On success, returns the unique identifier of the newly created emergency address. Emergency address settings allow the admin to configure or update the physical address associated with a phone number or a location.

  • Destructive

    Setup PSTN Connection for a Location

    Set up or update the PSTN connection details for a location. PSTN location connection settings enables the admin to configure or change the PSTN provider for a location.

  • Destructive

    Update the Emergency Address for a Phone Number

    Update the emergency address for a phone number. Emergency address settings allow the admin to configure or update the physical address associated with a phone number or a location.

  • Destructive

    Update the Emergency Address of a Location

    Updates the emergency address of the specified location. Emergency address settings allow the admin to configure or update the physical address associated with a phone number or a location.

Reports: Detailed Call History

  • Read

    Get Detailed Call History

    Provides Webex Calling Detailed Call History data for your organization. Results can be filtered with the startTime, endTime and locations request parameters.

  • Read

    Get Live Stream Detailed Call History

    Provides Webex Calling Detailed Call History data for your organization. Results can be filtered with the startTime, endTime and locations request parameters.

Person Call Settings

  • Read

    Retrieve a Person's Monitoring Settings

    Retrieve the monitoring settings for a person, which show specified people, places, virtual lines, or call park extensions that are being monitored.

  • Destructive

    Modify Monitoring Settings for a Person

    Modifies the monitoring settings of the person. Monitors the line status of specified people, places, virtual lines or call park extension. The line status indicates if a person, place or virtual line is on a call and if a call has been parked on that extension.

User Call Settings

  • Read

    Get Available Speed Dials for Person Monitoring

    Get available speed dials for Person monitoring configuration. This API allows administrators to retrieve a list of members that can be added as speed dials for monitoring a specific person. Speed dials allow quick access to frequently contacted members.

  • Read

    Get Available Members for Person Monitoring

    Get available members for person monitoring. This API allows administrators to retrieve a list of members that can be added to the monitoring list for a specific person.

User Call Settings (2/2)

  • Read

    List Move Users Jobs

    Lists all the Move Users jobs for the given organization in order of most recent job to oldest job irrespective of its status. This API requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Validate or Initiate Move Users Job

    This API allows the user to perform one of the following operations: Setting the validate attribute to true validates the user move. Setting the validate attribute to false performs the user move. Notes: A maximum of 100 users can be moved at a time.

  • Read

    Get Move Users Job Status

    Returns the status and other details of the job. This API requires a full or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    List Move Users Job errors

    Lists all error details of Move Users job. This will not list any errors if exitCode is COMPLETED. If the status is COMPLETEDWITHERRORS then this lists the cause of failures.

  • Read

    Retrieve Music On Hold Settings for a Person

    Retrieve the person's music on hold settings. Music on hold is played when a caller is put on hold, or the call is parked.

  • Read

    Retrieve Access Codes for a Person

    Retrieve the person's access codes. Access codes are used to bypass permissions. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Retrieve Transfer Numbers for a Person

    Retrieve the person's transfer numbers. When calling a specific call type, this person will be automatically transferred to another number. The person assigned the Auto Transfer Number can then approve the call and send it through or reject the call type.

  • Read

    Retrieve Digit Patterns for a Person

    Retrieve the person's digit patterns. Digit patterns are used to bypass permissions. Retrieving digit patterns requires a full or user or read-only administrator or location administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Retrieve Digit Pattern Details for a Person

    Retrieve the digit pattern details for a person. Digit patterns are used to bypass permissions. Retrieving the digit pattern details requires a full or user or read-only administrator or location administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Get Preferred Answer Endpoint

    Get the person's preferred answer endpoint and the list of endpoints available for selection. The preferred answer endpoint is null if one has not been selected.

  • Read

    Retrieve Agent's List of Available Caller IDs

    Get the list of call queues and hunt groups available for caller ID use by this person as an agent. This API requires a full, user, or read-only administrator or location administrator auth token with a scope of spark-admin:peopleread.

  • Read

    Retrieve Agent's Caller ID Information

    Retrieve the Agent's Caller ID Information. Each agent will be able to set their outgoing Caller ID as either the Call Queue's Caller ID, Hunt Group's Caller ID or their own configured Caller ID.

  • Read

    Read Call Bridge Settings for a Person

    Retrieve a person's Call Bridge settings. This API requires a full, user or read-only administrator or location administrator auth token with a scope of spark-admin:peopleread.

  • Read

    Get Person Secondary Available Phone Numbers

    List standard numbers that are available to be assigned as a person's secondary phone number. These numbers are associated with the location of the person specified in the request URL, can be active or inactive, and are unassigned.

  • Read

    Get Person Fax Message Available Phone Numbers

    List standard numbers that are available to be assigned as a person's FAX message number. These numbers are associated with the location of the person specified in the request URL, can be active or inactive, and are unassigned.

  • Read

    Get Person Call Forward Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as a person's call forward number. These numbers are associated with the location of the person specified in the request URL, can be active or inactive, and are assigned to an owning entity.

  • Read

    Get Person Primary Available Phone Numbers

    List numbers that are available to be assigned as a person's primary phone number. By default, this API returns standard and mobile numbers from all locations that are unassigned.

  • Read

    Get Person ECBN Available Phone Numbers

    List standard numbers that are available to be assigned as a person's emergency callback number. These numbers are associated with the location of the person specified in the request URL, can be active or inactive, and are assigned to an owning entity.

  • Read

    Get Person Call Intercept Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as a person's call intercept number. These numbers are associated with the location specified in the request URL, can be active or inactive, and are assigned to an owning entity.

  • Read

    Retrieve a Person's MS Teams Settings

    Not supported for Webex for Government (FedRAMP) Retrieve a person's MS Teams settings. At a person level, MS Teams settings allow access to retrieving the HIDE WEBEX APP and PRESENCE SYNC settings.

  • Read

    Get Personal Assistant

    Retrieve Personal Assistant details for a specific user. Personal Assistant is used to manage a user's incoming calls when they are away.

  • Read

    Retrieve the List of Available Features

    Retrieve a list of feature identifiers that can be assigned to a user for Mode Management. Feature identifiers reference feature instances like Auto Attendants, Call Queues, and Hunt Groups.

  • Read

    Retrieve the List of Features Assigned to a User for Mode Management

    Retrieve a list of feature identifiers that are already assigned to a user for Mode Management. Feature identifiers reference feature instances like Auto Attendants, Call Queues, and Hunt Groups. A maximum of 50 features can be assigned to a user for Mode Management.

  • Read

    Get the User’s Selective Call Accept Criteria List

    Retrieve selective call accept criteria list for a user. With the selective call accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Read

    Get a Criteria for the User’s Selective Call Accept Service

    Get the criteria details for the user's selective call accept service. With the Selective Call accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Read

    Get the User’s Selective Call Rejection Criteria Listing

    Retrieve selective call rejection criteria for a user. With the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Read

    Get a Criteria for the User’s Selective Call Rejection Service

    Get a criteria for the user's selective call rejection service. With the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Read

    Get the User’s Selective Call Forwarding

    Retrieve selective call forwarding criteria for a user. With the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Read

    Get a Criteria for the User’s Selective Call Forwarding Service

    Get the criteria details for the user's selective call forwarding service. With the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Read

    Search Shared-Line Appearance Members New

    Get members available for shared-line assignment to a Webex Calling Apps. Like most hardware devices, applications support assigning additional shared lines which can monitored and utilized by the application.

  • Read

    Get Count of Shared-Line Appearance Members

    Get the count of members available for shared-line assignment to Webex Calling Apps. Shared-line appearance allows multiple devices or applications to share a single line for call handling.

  • Read

    Get Shared-Line Appearance Members New

    Get primary and secondary members assigned to a shared line on a Webex Calling Apps. Like most hardware devices, applications support assigning additional shared lines which can monitored and utilized by the application.

  • Read

    Get the user call captions settings

    Retrieve the user's call captions settings. NOTE: The call captions feature is not supported for Webex Calling Standard users or users assigned to locations in India.

  • Read

    Get Person Executive Call Filtering Settings

    Retrieve the executive call filtering settings for the specified person. Executive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types.

  • Read

    Get Person Executive Call Filtering Criteria Settings

    Retrieve the executive call filtering criteria settings for the specified person. Executive Call Filtering Criteria in Webex allows you to retrieve the detailed configuration for a specific filter rule.

  • Read

    Get Person Executive Alert Settings

    Get executive alert settings for the specified person. Executive Alert settings in Webex allow you to control how calls are routed to executive assistants, including alerting mode, rollover options, and caller ID presentation.

  • Read

    Get Person Executive Assigned Assistants

    Get list of assigned executive assistants for the specified person. As an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.

  • Read

    Get Person Executive Available Assistants

    Retrieves a list of people available for assignment as executive assistants to the specified person. As an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle.

  • Read

    Get Person Executive Assistant Settings

    Get executive assistant settings for the specified person when person is configured as executive assistant. Executive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive.

  • Read

    Get Person Executive Screening Settings

    Get executive screening settings for the specified person. Executive Screening in Webex allows you to manage how incoming calls are screened and alerted based on your preferences.

  • Read

    Get Timezone and Announcement Language Settings of a Person

    Retrieve a person's timezone and announcement language settings. Webex Calling supports configuring timezone and announcement language preferences, allowing personalized call experience based on their location and language preferences.

  • Read

    Get Country Calling Configuration

    Retrieve country-specific configuration details including state requirements, zip code requirements, available states, and supported time zones. This information helps administrators configure user settings with valid timezone and location data for a specific country.

  • Write

    Pause the Move Users Job

    Pause the running Move Users Job. A paused job can be resumed. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Write

    Resume the Move Users Job

    Resume the paused Move Users Job that is in paused status. This API requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Write

    Create Access Codes for a Person

    Create new Access codes for the person. Access codes are used to bypass permissions. This API requires a full or user administrator or location administrator auth token with the spark-admin:telephonyconfigwrite scope.

  • Write

    Create Digit Patterns for a Person

    Create a new digit pattern for the given person. Digit patterns are used to bypass permissions. Creating the digit pattern requires a full or user or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Write

    Create a Criteria to the User’s Selective Call Accept Service

    Add a criteria to the user's selective call accept service. With the Selective Call accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Write

    Create a Criteria to the User’s Selective Call Rejection Service

    Add a criteria to the user's selective call rejection service. With the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Write

    Create a Criteria to the User’s Selective Call Forwarding Service

    Add a criteria to the user's selective call forwarding service. With the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Write

    Add Person Executive Call Filtering Criteria

    Create a new executive call filtering criteria configuration for the specified person. Executive Call Filtering Criteria in Webex allows you to define detailed filter rules for incoming calls.

  • Destructive

    Configure Music On Hold Settings for a Person

    Configure a person's music on hold settings. Music on hold is played when a caller is put on hold, or the call is parked. To configure music on hold settings for a person, music on hold setting must be enabled for this location.

  • Destructive

    Modify Access Codes for a Person

    Modify a person's access codes. Access codes are used to bypass permissions. This API requires a full or user administrator or location administrator auth token with the spark-admin:telephonyconfigwrite scope.

  • Destructive

    Delete Access Codes for a Person

    Deletes all Access codes for the person. Access codes are used to bypass permissions. This API requires a full or user administrator or location administrator auth token with the spark-admin:telephonyconfigwrite scope.

  • Destructive

    Modify Transfer Numbers for a Person

    Modify a person's transfer numbers. When calling a specific call type, this person will be automatically transferred to another number. The person assigned the Auto Transfer Number can then approve the call and send it through or reject the call type. You can add up to 3 numbers.

  • Destructive

    Modify the Digit Pattern Category Control Settings for a Person

    Modifies whether this user uses the specified digit patterns when placing outbound calls or not. Updating the digit pattern category control settings requires a full or user or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Delete all Digit Patterns for a Person

    Delete all digit patterns for a Person. Digit patterns are used to bypass permissions. Deleting the digit patterns requires a full or user or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Modify a Digit Pattern for a Person

    Modify a digit pattern for a Person. Digit patterns are used to bypass permissions. Updating the digit pattern requires a full or user or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Delete a Digit Pattern for a Person

    Delete a digit pattern for a Person. Digit patterns are used to bypass permissions. Deleting the digit pattern requires a full or user or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Assign or Unassign numbers to a person

    Assign or unassign alternate phone numbers to a person. Each location has a set of phone numbers that can be assigned to people, workspaces, or features.

  • Destructive

    Modify Preferred Answer Endpoint

    Sets or clears the person’s preferred answer endpoint. To clear the preferred answer endpoint the preferredAnswerEndpointId attribute must be set to null. This API requires spark:telephonyconfigwrite or spark-admin:telephonyconfigwrite scope.

  • Destructive

    Modify a person's voicemail passcode

    Modify a person's voicemail passcode. Modifying a person's voicemail passcode requires a full administrator, user administrator or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Modify Agent's Caller ID Information

    Modify Agent's Caller ID Information. Each Agent will be able to set their outgoing Caller ID as either the designated Call Queue's Caller ID or Hunt Group's Caller ID or their own configured Caller ID This API requires a full or user administrator or location administrator auth…

  • Destructive

    Configure Call Bridge Settings for a Person

    Configure a person's Call Bridge settings. This API requires a full or user administrator or location administrator auth token with the spark-admin:peoplewrite scope.

  • Destructive

    Configure a Person's MS Teams Setting

    Not supported for Webex for Government (FedRAMP) Configure a Person's MS Teams setting. MS Teams settings can be configured at the person level. Requires a full administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Update Personal Assistant

    Update Personal Assistant details for a specific user. Personal Assistant is used to manage a user's incoming calls when they are away. Updating Personal Assistant details requires a full or user administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Assign a List of Features to a User for Mode Management

    Assign a user a list of feature identifiers for Mode Management. Feature identifiers reference feature instances like Auto Attendants, Call Queues, and Hunt Groups. A maximum of 50 features can be assigned to a user for Mode Management.

  • Destructive

    Update User’s Selective Call Accept Criteria

    Modify selective call accept setting for a user. With the Selective Call accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Destructive

    Modify a Criteria From the User’s Selective Call Accept Service

    Modify a criteria for the user's selective call accept service. With the Selective Call Accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Destructive

    Delete a Criteria From the User’s Selective Call Accept service

    Delete a criteria from the user's selective call accept criteria list. With the Selective Call Accept feature, you can create different rules to accept specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Destructive

    Update User’s Selective Call Rejection Criteria List

    Modify selective call rejection setting for a user. With the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Destructive

    Modify a Criteria for the User’s Selective Call Rejection Service

    Modify a criteria for the user's selective call rejection service. With the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Destructive

    Delete a Criteria From the User’s Selective Call Rejection Service

    Delete a criteria from the user's selective call rejection service. With the Selective Call Rejection feature, you can create different rules to reject specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Destructive

    Update User’s Selective Call Forwarding Criteria List

    Modify selective call forwarding setting for a user. With the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Destructive

    Modify a Criteria for the User’s Selective Call Forwarding Service

    Modify a criteria for the user's selective call forwarding service. With the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Destructive

    Delete a Criteria From the User’s Selective Call Forwarding Service

    Delete a criteria from the user's selective call forwarding service. With the Selective Call Forwarding feature, you can create different rules to forward specific calls based on the phone number, who's calling, and/or the time and day of the call.

  • Destructive

    Put Shared-Line Appearance Members New

    Add or modify primary and secondary users assigned to shared-lines on a Webex Calling Apps. Like most hardware devices, applications support assigning additional shared lines which can monitored and utilized by the application.

  • Destructive

    Update the user call captions settings

    Update the user's call captions settings. NOTE: The call captions feature is not supported for Webex Calling Standard users or users assigned to locations in India.

  • Destructive

    Modify Person Executive Call Filtering Settings

    Update the executive call filtering settings for the specified person. Executive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types.

  • Destructive

    Modify Person Executive Call Filtering Criteria Settings

    Update the executive call filtering settings for the specified person. Executive Call Filtering in Webex allows you to control which calls are allowed to reach the executive assistant based on custom criteria, such as specific phone numbers or call types.

  • Destructive

    Delete Person Executive Call Filtering Criteria

    Delete a specific executive call filtering criteria configuration for the specified person. Executive Call Filtering Criteria in Webex allows you to manage detailed filter rules for incoming calls. This API removes a specific filter rule by its unique identifier.

  • Destructive

    Modify Person Executive Alert Settings

    Update executive alert settings for the specified person. Executive Alert settings in Webex allow you to control how calls are routed to executive assistants, including alerting mode, rollover options, and caller ID presentation.

  • Destructive

    Modify Person Executive Assigned Assistants

    Update assigned executive assistants for the specified person. As an executive, you can add assistants to your executive pool to manage calls for you. You can set when and which types of calls they can handle. Assistants can opt in when needed or opt out when not required.

  • Destructive

    Modify Person Executive Assistant Settings

    Update executive assistant settings for the specified person when person is configured as executive assistant. Executive assistants can make, answer, intercept, and route calls appropriately on behalf of their executive.

  • Destructive

    Modify Person Executive Screening Settings

    Update executive screening settings for the specified person. Executive Screening in Webex allows you to manage how incoming calls are screened and alerted based on your preferences.

  • Destructive

    Update Timezone and Announcement Language Settings of a Person

    Modify a person's timezone and announcement language settings. Webex Calling supports configuring timezone and announcement language preferences, allowing personalized call experience based on their location and language preferences.

User Call Settings Members Me

  • Read

    Get Message Summary

    Get a summary of the voicemail messages for the user.

  • Read

    List Messages

    Get the list of all voicemail messages for the user.

  • Read

    List Voice Message Memberships

    Retrieves the list of shared voicemail memberships for the authenticated user. Each membership represents a group calling feature (Call Queue, Hunt Group, or Auto Attendant) whose shared voicemail box the user has access to.

  • Write

    Mark As Read

    Update the voicemail message(s) as read for the user. If the messageId is provided, then only mark that message as read. Otherwise, all messages for the user are marked as read.

  • Write

    Mark As Unread

    Update the voicemail message(s) as unread for the user. If the messageId is provided, then only mark that message as unread. Otherwise, all messages for the user are marked as unread.

  • Destructive

    Delete Message

    Delete a specfic voicemail message for the user.

User Call Settings (3/3)

  • Read

    Get Anonymous Call Rejection Settings for a Person

    Get Anonymous Call Rejection Settings for a person. Anonymous Call Rejection allows people to automatically reject incoming calls from callers who have blocked their caller ID information.

  • Read

    List Enabled Calling Services for a Person

    Retrieves the list of enabled calling services for a person. Calling services are designed to improve call handling and ensure that people can manage their communications effectively.

  • Read

    Retrieve Simultaneous Ring Settings for a Person

    Retrieve simultaneous ring settings for a person. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Schedules can also be set up to ring these phones during certain times of the day or days of the week.

  • Read

    Retrieve Simultaneous Ring Criteria for a Person

    Retrieve simultaneous ring criteria settings for a person. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.

  • Read

    Retrieve a Person's Outbound Billing Plan

    Not supported for Webex for Government (FedRAMP). Retrieve the Cisco Calling Plan outbound billing plan setting for a person. Cisco Calling Plan outbound billing identifies whether outbound calls for the person are billed through Cisco Calling Plan.

  • Read

    Get Answer Settings for a Person

    Get the answer settings for a specific person. Answer settings allow administrators to configure automatic call answering behavior for a person, including preferred answer endpoint and whether auto answer is enabled.

  • Read

    Get Available Preferred Answer Endpoints for a Person

    Get the list of available preferred answer endpoints for a specific person. This API returns all available endpoints in a single response.

  • Write

    Create Simultaneous Ring Criteria for a Person

    Create simultaneous ring criteria settings for a person. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.

  • Destructive

    Update Anonymous Call Rejection Settings for a Person

    Update Anonymous Call Rejection Settings for a person. Configure whether to automatically reject incoming calls from anonymous callers. When Anonymous Call Rejection is enabled, calls from callers who have blocked their caller ID will be rejected.

  • Destructive

    Modify Simultaneous Ring Settings for a Person

    Modifies simultaneous ring settings for a person. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously. Schedules can also be set up to ring these phones during certain times of the day or days of the week.

  • Destructive

    Modify Simultaneous Ring Criteria for a Person

    Modify simultaneous ring criteria settings for a person. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.

  • Destructive

    Delete Simultaneous Ring Criteria for a Person

    Delete simultaneous ring criteria settings for a person. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.

  • Destructive

    Modify a Person's Outbound Billing Plan

    Not supported for Webex for Government (FedRAMP). Modify the Cisco Calling Plan outbound billing plan setting for a person. Cisco Calling Plan outbound billing identifies whether outbound calls for the person are billed through Cisco Calling Plan.

  • Destructive

    Update Answer Settings for a Person

    Modify the answer settings for a specific person. Answer settings allow administrators to configure automatic call answering behavior for a person, including preferred answer endpoint and whether auto answer is enabled.

Features: Hot Desking Members

  • Read

    Search Available Hot Desking Members

    Retrieve members available for assignment to a person's hot desking guest profile. Available members can include people, workspaces, and virtual lines that can be added as shared lines on the hot desking profile.

  • Read

    Get Hot Desking Members

    Retrieve the primary and shared-line members assigned to a person's hot desking guest profile. This API requires a full, user, device, read-only, or location administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Destructive

    Update Hot Desking Members

    Modify the primary and shared-line members assigned to a person's hot desking guest profile. The request replaces the hot desking profile member list with the members supplied in the request body.

User Call Settings Members

  • Read

    Get Message Summary by Member ID

    Get a summary of the voicemail messages for the user.

  • Read

    List Messages by Member ID

    Get the list of all voicemail messages for the user.

  • Read

    List Voice Message Memberships

    Retrieves the list of shared voicemail memberships for the specified member. Each membership represents a group calling feature (Call Queue, Hunt Group, or Auto Attendant) whose shared voicemail box the member has access to.

  • Write

    Mark As Read by Member ID

    Update the voicemail message(s) as read for the user. If the messageId is provided, then only mark that message as read. Otherwise, all messages for the user are marked as read.

  • Write

    Mark As Unread by Member ID

    Update the voicemail message(s) as unread for the user. If the messageId is provided, then only mark that message as unread. Otherwise, all messages for the user are marked as unread.

  • Destructive

    Delete Message by Member ID

    Delete a specfic voicemail message for the user.

Virtual Line Call Settings

  • Read

    Read the List of Virtual Lines

    List all Virtual Lines for the organization. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.

  • Read

    Read Call Recording Settings for a Virtual Line

    Retrieve Virtual Line's Call Recording settings. The Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.

  • Read

    Get Details for a Virtual Line

    Retrieve Virtual Line details. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.

  • Read

    Get Phone Number Assigned for a Virtual Line

    Get details on the assigned phone number and extension for the virtual line. Virtual lines can be assigned phone numbers and extensions to enable calling functionality. This information is essential for configuring and managing virtual line communication settings.

  • Read

    Get List of Devices Assigned for a Virtual Line

    Retrieve Device details assigned for a virtual line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.

  • Read

    Get List of DECT Networks Handsets for a Virtual Line

    Not supported for Webex for Government (FedRAMP) Retrieve DECT Network details assigned for a virtual line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.

  • Read

    Read Caller ID Settings for a Virtual Line

    Retrieve a virtual line's Caller ID settings. Caller ID settings control how a virtual line's information is displayed when making outgoing calls.

  • Read

    Read Call Waiting Settings for a Virtual Line

    Retrieve a virtual line's Call Waiting settings. With this feature, a virtual line can place an active call on hold and answer an incoming call. When enabled, while you are on an active call, a tone alerts you of an incoming call and you can choose to answer or ignore the call.

  • Read

    Read Call Forwarding Settings for a Virtual Line

    Retrieve a virtual line's Call Forwarding settings. Three types of call forwarding are supported: + Always - forwards all incoming calls to the destination you choose.

  • Read

    Read Incoming Permission Settings for a Virtual Line

    Retrieve a virtual line's Incoming Permission settings. You can change the incoming calling permissions for a virtual line if you want them to be different from your organization's default.

  • Read

    Retrieve a Virtual Line's Outgoing Calling Permissions Settings

    Retrieve a virtual line's Outgoing Calling Permissions settings. Outgoing calling permissions regulate behavior for calls placed to various destinations and default to the local level settings.

  • Read

    Retrieve Access Codes for a Virtual Line

    Retrieve the virtual line's access codes. Access codes are used to bypass permissions. This API requires a full, user, or read-only administrator auth token with a scope of spark-admin:telephonyconfigread

  • Read

    Retrieve Transfer Numbers for a Virtual Line

    Retrieve the virtual line's transfer numbers. When calling a specific call type, this virtual line will be automatically transferred to another number. The virtual line assigned to the Auto Transfer Number can then approve the call and send it through or reject the call type.

  • Read

    Retrieve Digit Patterns for a Virtual Profile

    Get list of digit patterns for the virtual profile. Digit patterns are used to bypass permissions. Retrieving this list requires a full, user, or read-only administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Retrieve Specified Digit Pattern Details for a Virtual Profile

    Get the specified digit pattern for the virtual profile​. Digit patterns are used to bypass permissions. Retrieving the digit pattern details requires a full, user, read-only, or location administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Read Call Intercept Settings for a Virtual Line

    Retrieves Virtual Line's Call Intercept settings. The intercept feature gracefully takes a virtual line's phone out of service, while providing callers with informative announcements and alternative routing options.

  • Read

    Retrieve Agent's List of Available Caller IDs

    Get the list of call queues and hunt groups available for caller ID use by this virtual line as an agent. When a virtual line is configured as an agent in call queues or hunt groups, they can choose which caller ID to display when making outbound calls.

  • Read

    Retrieve Agent's Caller ID Information

    Retrieve the Agent's Caller ID Information. Each agent will be able to set their outgoing Caller ID as either the Call Queue's Caller ID, Hunt Group's Caller ID or their own configured Caller ID.

  • Read

    Read Voicemail Settings for a Virtual Line

    Retrieve a virtual line's voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail. Optionally, notifications can be sent to a mobile phone via text or email.

  • Read

    Retrieve Music on Hold Settings for a Virtual Line

    Retrieve the virtual line's music on hold settings. Music on hold is played when a caller is put on hold, or the call is parked.

  • Read

    Read Push-to-Talk Settings for a Virtual Line

    Retrieve a virtual line's Push-to-Talk settings. Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people in different parts of your organization.

  • Read

    Read Call Bridge Settings for a Virtual Line

    Retrieve a virtual line's call bridge settings. Call bridge settings allow administrators to configure warning tones that play when a call is bridged or transferred, helping users identify when they are being connected to another party.

  • Read

    Read Barge in Settings for a Virtual Line

    Retrieve a virtual line's barge in settings. The Barge In feature enables you to use a Feature Access Code (FAC) to answer a call that was directed to another subscriber, or barge-in on the call if it was already answered. Barge In can be used across locations.

  • Read

    Get a Virtual Line's Privacy Settings

    Get a virtual line's privacy settings for the specified virtual line ID. The privacy feature enables the virtual line's line to be monitored by others and determine if they can be reached by Auto Attendant services.

  • Read

    Get Virtual Line Fax Message Available Phone Numbers

    List standard numbers that are available to be assigned as a virtual line's FAX message number. These numbers are associated with the location of the virtual line specified in the request URL, can be active or inactive, and are unassigned.

  • Read

    Get Virtual Line Call Forward Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as a virtual line's call forward number. These numbers are associated with the location of the virtual line specified in the request URL, can be active or inactive, and are assigned to an owning entity.

  • Read

    Get Virtual Line Available Phone Numbers

    List standard numbers that are available to be assigned as a virtual line's phone number. By default, this API returns unassigned numbers from all locations.

  • Read

    Get Virtual Line ECBN Available Phone Numbers

    List standard numbers that can be assigned as a virtual line's call forward number. These numbers are associated with the location of the virtual line specified in the request URL, can be active or inactive, and are assigned to an owning entity.

  • Read

    Get Virtual Line Call Intercept Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as a virtual line's call intercept number.

  • Read

    Retrieve DoNotDisturb Settings for a Virtual Line

    Retrieve DoNotDisturb Settings for a Virtual Line. Silence incoming calls with the Do Not Disturb feature. When enabled, callers hear the busy signal. This API requires a full, read-only or location administrator auth token with a scope of telephonyconfigread.

  • Read

    Retrieve a Virtual Line's Outbound Billing Plan

    Not supported for Webex for Government (FedRAMP). Retrieve the Cisco Calling Plan outbound billing plan setting for a virtual line. Cisco Calling Plan outbound billing identifies whether outbound calls for the virtual line are billed through Cisco Calling Plan.

  • Read

    Get Answer Settings for a Virtual Line

    Get the answer settings for a specific virtual line. Answer settings allow administrators to configure automatic call answering behavior for a virtual line, including preferred answer endpoint and whether auto answer is enabled.

  • Read

    Get Available Preferred Answer Endpoints for a Virtual Line

    Get the list of available preferred answer endpoints for a specific virtual line. This API returns all available endpoints in a single response.

  • Write

    Create a Virtual Line

    Create new Virtual Line for the given location. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.

  • Write

    Create Access Codes for a Virtual Line

    Create a new access codes for the virtual line. Access codes are used to bypass permissions. This API requires a full, user, or location administrator auth token with the spark-admin:telephonyconfigwrite scope.

  • Write

    Create Digit Pattern for a Virtual Profile

    Create a new digit pattern for a virtual profile. Digit patterns are used to bypass permissions. Creating the digit pattern requires a full, user, or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Write

    Configure Call Intercept Greeting for a Virtual Line

    Configure a virtual line's Call Intercept Greeting by uploading a Waveform Audio File Format, .wav, encoded audio file. Your request will need to be a multipart/form-data request rather than JSON, using the audio/wav Content-Type.

  • Write

    Configure Busy Voicemail Greeting for a Virtual Line

    Configure a virtual line's Busy Voicemail Greeting by uploading a Waveform Audio File Format, .wav, encoded audio file. Your request will need to be a multipart/form-data request rather than JSON, using the audio/wav Content-Type.

  • Write

    Configure No Answer Voicemail Greeting for a Virtual Line

    Configure a virtual line's No Answer Voicemail Greeting by uploading a Waveform Audio File Format, .wav, encoded audio file. Your request will need to be a multipart/form-data request rather than JSON, using the audio/wav Content-Type.

  • Write

    Reset Voicemail PIN for a Virtual Line

    Reset a voicemail PIN for a virtual line. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. A voicemail PIN is used to retrieve your voicemail messages.

  • Destructive

    Configure Call Recording Settings for a Virtual Line

    Configure virtual line's Call Recording settings. The Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.

  • Destructive

    Update a Virtual Line

    Update the designated Virtual Line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.

  • Destructive

    Delete a Virtual Line

    Delete the designated Virtual Line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.

  • Destructive

    Update Directory Search for a Virtual Line

    Update the directory search for a designated Virtual Line. Virtual line is a capability in Webex Calling that allows administrators to configure multiple lines to Webex Calling users.

  • Destructive

    Configure Caller ID Settings for a Virtual Line

    Configure a virtual line's Caller ID settings. Caller ID settings control how a virtual line's information is displayed when making outgoing calls.

  • Destructive

    Configure Call Waiting Settings for a Virtual Line

    Configure a virtual line's Call Waiting settings. With this feature, a virtual line can place an active call on hold and answer an incoming call. When enabled, while you are on an active call, a tone alerts you of an incoming call and you can choose to answer or ignore the call.

  • Destructive

    Configure Call Forwarding Settings for a Virtual Line

    Configure a virtual line's Call Forwarding settings. Three types of call forwarding are supported: + Always - forwards all incoming calls to the destination you choose.

  • Destructive

    Configure Incoming Permission Settings for a Virtual Line

    Configure a virtual line's Incoming Permission settings. You can change the incoming calling permissions for a virtual line if you want them to be different from your organization's default.

  • Destructive

    Modify a Virtual Line's Outgoing Calling Permissions Settings

    Modify a virtual line's Outgoing Calling Permissions settings. Outgoing calling permissions regulate behavior for calls placed to various destinations and default to the local level settings.

  • Destructive

    Modify Access Codes for a Virtual Line

    Modify a virtual line's access codes. Access codes are used to bypass permissions. This API requires a full, user, or location administrator auth token with the spark-admin:telephonyconfigwrite scope.

  • Destructive

    Delete Access Codes for a Virtual Line

    Deletes all access codes for the virtual line. Access codes are used to bypass permissions. This API requires a full, user, or location administrator auth token with the spark-admin:telephonyconfigwrite scope.

  • Destructive

    Modify Transfer Numbers for a Virtual Line

    Modify a virtual line's transfer numbers. When calling a specific call type, this virtual line will be automatically transferred to another number. The virtual line assigned the Auto Transfer Number can then approve the call and send it through or reject the call type.

  • Destructive

    Modify the Digit Pattern Category Control Settings for a Virtual Profile

    Modifies whether this virtual profile uses the specified digit patterns when placing outbound calls or not.

  • Destructive

    Delete All Digit Patterns for a Virtual Profile

    Delete all digit patterns for a virtual profile. Digit patterns are used to bypass permissions. Deleting the digit patterns requires a full, user, or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Modify a Digit Pattern for a Virtual Profile

    Modify a digit patterns for a virtual profile. Digit patterns are used to bypass permissions. Updating the digit pattern requires a full, user, or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Delete a Digit Pattern for a Virtual Profile

    Delete a digit pattern for a virtual profile. Digit patterns are used to bypass permissions. Deleting the digit pattern requires a full, user, or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Configure Call Intercept Settings for a Virtual Line

    Configures a virtual line's Call Intercept settings. The intercept feature gracefully takes a virtual line's phone out of service, while providing callers with informative announcements and alternative routing options.

  • Destructive

    Modify Agent's Caller ID Information

    Modify Agent's Caller ID Information. Each Agent is able to set their outgoing Caller ID as either the designated Call Queue's Caller ID or the Hunt Group's Caller ID or their own configured Caller ID.

  • Destructive

    Configure Voicemail Settings for a Virtual Line

    Configure a virtual line's voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via voicemail. Optionally, notifications can be sent to a mobile phone via text or email.

  • Destructive

    Modify a Virtual Line's Voicemail Passcode

    Modify a virtual line's voicemail passcode. The voicemail passcode is used to secure access to the virtual line's voicemail messages. Administrators can update this passcode to maintain security or assist users who have forgotten their passcode.

  • Destructive

    Configure Music on Hold Settings for a Virtual Line

    Configure a virtual line's music on hold settings. Music on hold is played when a caller is put on hold, or the call is parked. To configure music on hold settings for a virtual line, music on hold setting must be enabled for this location.

  • Destructive

    Configure Push-to-Talk Settings for a Virtual Line

    Configure a virtual line's Push-to-Talk settings. Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people in different parts of your organization.

  • Destructive

    Configure Call Bridge Settings for a Virtual Line

    Configure a virtual line's call bridge settings. Call bridge settings allow administrators to configure warning tones that play when a call is bridged or transferred, helping users identify when they are being connected to another party.

  • Destructive

    Configure Barge in Settings for a Virtual Line

    Configure a virtual line's barge in settings. The Barge In feature enables you to use a Feature Access Code (FAC) to answer a call that was directed to another subscriber, or barge-in on the call if it was already answered. Barge In can be used across locations.

  • Destructive

    Configure a Virtual Line's Privacy Settings

    Configure a virtual line's privacy settings for the specified virtual line ID. The privacy feature enables the virtual line's line to be monitored by others and determine if they can be reached by Auto Attendant services.

  • Destructive

    Modify DoNotDisturb Settings for a Virtual Line

    Modify DoNotDisturb Settings for a Virtual Line. Silence incoming calls with the Do Not Disturb feature. When enabled, callers hear the busy signal. This API requires a full, user or location administrator auth token with the spark-admin:telephonyconfigwrite scope.

  • Destructive

    Modify a Virtual Line's Outbound Billing Plan

    Not supported for Webex for Government (FedRAMP). Modify the Cisco Calling Plan outbound billing plan setting for a virtual line. Cisco Calling Plan outbound billing identifies whether outbound calls for the virtual line are billed through Cisco Calling Plan.

  • Destructive

    Update Answer Settings for a Virtual Line

    Modify the answer settings for a specific virtual line. Answer settings allow administrators to configure automatic call answering behavior for a virtual line, including preferred answer endpoint and whether auto answer is enabled.

Caller Reputation Provider

  • Read

    Get Caller Reputation Provider Service Settings

    Retrieves the configuration and status of the caller reputation provider service for Webex Calling.

  • Read

    Get Caller Reputation Provider Status

    Retrieves the current status of the caller reputation provider integration for Webex Calling.

  • Read

    Get Caller Reputation Provider Providers

    Retrieves the list of available caller reputation providers and their regions for Webex Calling.

  • Write

    Unlock Caller Reputation Provider

    Unlocks the caller reputation provider for Webex Calling.

  • Destructive

    Update Caller Reputation Provider Service Settings

    Updates the configuration of the caller reputation provider service for Webex Calling.

Webhook Interest Registrations

  • Read

    Get Webhook Interest Registration

    Returns the webhook interest registration associated with the authenticated user and the client derived from the access token, including the list of interests and the date/time at which the registration expires. The client identifier is not supplied by the caller.

  • Write

    Create a Webhook Interest Registration

    Adds or updates a webhook interest registration associated with the authenticated user and the client derived from the access token. At least one item in interests is required and duration is optional. The client identifier is not supplied in the request.

  • Destructive

    Delete Webhook Interest Registration

    Deletes the webhook interest registration associated with the authenticated user and the client derived from the access token. The client identifier is not supplied by the caller.

Workspace Call Settings (1/2)

  • Read

    Retrieve Call Forwarding Settings for a Workspace

    Retrieve Call Forwarding Settings for a Workspace. Three types of call forwarding are supported: + Always - forwards all incoming calls to the destination you choose.

  • Read

    Retrieve Call Waiting Settings for a Workspace

    Retrieve Call Waiting Settings for a Workspace. Call Waiting allows workspaces to handle multiple simultaneous calls. Workspaces with Call Waiting enabled can place a call on hold to answer or initiate another call.

  • Read

    Read Caller ID Settings for a Workspace

    Retrieve a workspace's Caller ID settings. Caller ID settings control how a workspace's information is displayed when making outgoing calls.

  • Read

    List numbers associated with a specific workspace

    List the PSTN phone numbers associated with a specific workspace, by ID, within the organization. Also shows the location and organization associated with the workspace.

  • Read

    Retrieve Incoming Permission Settings for a Workspace

    Retrieve Incoming Permission settings for a Workspace. Incoming permission settings allow modifying permissions for a workspace that can be different from the organization's default to manage different call types.

  • Read

    Retrieve Outgoing Permission Settings for a Workspace

    Retrieve Outgoing Permission settings for a Workspace. Turn on outgoing call settings for this workspace to override the calling settings from the location that are used by default.

  • Read

    Retrieve Access Codes for a Workspace

    Retrieve Access codes for a Workspace. Access codes are used to bypass permissions.

  • Read

    Read Call Intercept Settings for a Workspace

    Retrieves Workspace's Call Intercept Settings The intercept feature gracefully takes a workspace's phone out of service, while providing callers with informative announcements and alternative routing options.

  • Read

    Retrieve Transfer Numbers Settings for a Workspace

    Retrieve Transfer Numbers Settings for a Workspace. When calling a specific call type, this workspace will be automatically transferred to another number. The person assigned the Auto Transfer Number can then approve the call and send it through or reject the call type.

  • Write

    Create Access Codes for a Workspace

    Create new Access codes for the given workspace. Access codes are used to bypass permissions.

  • Destructive

    Modify Call Forwarding Settings for a Workspace

    Modify call forwarding settings for a Workspace. Three types of call forwarding are supported: + Always - forwards all incoming calls to the destination you choose.

  • Destructive

    Modify Call Waiting Settings for a Workspace

    Modify Call Waiting Settings for a Workspace. Call Waiting allows workspaces to handle multiple simultaneous calls. Workspaces with Call Waiting enabled can place a call on hold to answer or initiate another call.

  • Destructive

    Configure Caller ID Settings for a Workspace

    Configure workspace's Caller ID settings. Caller ID settings control how a workspace's information is displayed when making outgoing calls.

  • Destructive

    Modify Incoming Permission Settings for a Workspace

    Modify Incoming Permission settings for a Workspace. Incoming permission settings allow modifying permissions for a workspace that can be different from the organization's default to manage different call types.

  • Destructive

    Modify Outgoing Permission Settings for a Workspace

    Modify Outgoing Permission settings for a Place. Turn on outgoing call settings for this workspace to override the calling settings from the location that are used by default.

  • Destructive

    Modify Access Codes for a Workspace

    Modify Access codes for a workspace. Access codes are used to bypass permissions.

  • Destructive

    Delete all Access Codes for a Workspace

    Deletes all Access codes for the given workspace. Access codes are used to bypass permissions.

  • Destructive

    Configure Call Intercept Settings for a Workspace

    Configures a Workspace's Call Intercept Settings The intercept feature gracefully takes a workspace's phone out of service, while providing callers with informative announcements and alternative routing options.

  • Destructive

    Modify Transfer Numbers Settings for a Workspace

    Modify Transfer Numbers Settings for a place. When calling a specific call type, this workspace will be automatically transferred to another number. The person assigned the Auto Transfer Number can then approve the call and send it through or reject the call type.

Workspace Call Settings

  • Read

    Retrieve Monitoring Settings for a Workspace

    Retrieve the monitoring settings for a workspace, which show specified people, places, virtual lines, or call park extensions that are being monitored.

  • Read

    Get Available Speed Dials for Workspace Monitoring

    Get available speed dials for Workspace monitoring configuration. This API allows administrators to retrieve a list of members that can be added as speed dials for monitoring a specific workspace.

  • Read

    Get Available Members for Workspace Monitoring

    Get available members for workspace monitoring. This API allows administrators to retrieve a list of members that can be added to the monitoring list for a specific workspace.

  • Destructive

    Modify Monitoring Settings for a Workspace

    Modifies the monitoring settings of the workspace. Monitors the line status of specified people, places, virtual lines or call park extension. The line status indicates if a person, place or virtual line is on a call and if a call has been parked on that extension.

Workspace Call Settings (2/2)

  • Read

    Retrieve Music On Hold Settings for a Workspace

    Retrieve Music On Hold Settings for a Workspace. Music on hold is played when a caller is put on hold, or the call is parked.

  • Read

    Retrieve all Digit Patterns for a Workspace

    Retrieve all digit patterns for a Workspace. Digit patterns are used to bypass permissions. This API requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Retrieve a Digit Pattern details for the Workspace

    Retrieve the designated digit pattern. Digit patterns are used to bypass permissions. This API requires a full or read-only administrator or location administrator auth token with a scope of spark-admin:telephonyconfigread.

  • Read

    Retrieve Call Recording Settings for a Workspace

    Retrieve call recording settings for a workspace. The Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.

  • Read

    Get Workspace Available Phone Numbers

    List standard numbers that are available to be assigned as a workspace's phone number. By default, this API returns numbers from all locations that are unassigned.

  • Read

    Get Workspace ECBN Available Phone Numbers

    List standard numbers that are available to be assigned as a workspace's emergency callback number. These numbers are associated with the location of the workspace specified in the request URL, can be active or inactive, and are assigned to an owning entity.

  • Read

    Get Workspace Call Forward Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as a workspace's call forward number. These numbers are associated with the location of the workspace specified in the request URL, can be active or inactive, and are assigned to an owning entity.

  • Read

    Get Workspace Call Intercept Available Phone Numbers

    List the service and standard PSTN numbers that are available to be assigned as a workspace's call intercept number. These numbers are associated with the location of the workspace specified in the request URL, can be active or inactive, and are assigned to an owning entity.

  • Read

    Retrieve Anonymous Call Settings for a Workspace

    Retrieve Anonymous Call Settings for a Workspace. Anonymous Call Rejection, when enabled, blocks all incoming calls from unidentified or blocked caller IDs.

  • Read

    Retrieve Barge In Call Settings for a Workspace

    Retrieve Barge In Call Settings for a Workspace. Barge In, when enabled, allows you to use the Feature Access Code (FAC) on your desk phone to answer someone else’s phone call or barge in on a call they’ve already answered.

  • Read

    Retrieve DoNotDisturb Settings for a Workspace

    Retrieve DoNotDisturb Settings for a Workspace. Silence incoming calls with the Do Not Disturb feature. When enabled, callers hear the busy signal.

  • Read

    Retrieve Call Bridge Warning Tone Settings for a Workspace

    Retrieve Call Bridge Warning Tone Settings for a Workspace. Call Bridge Warning Tone, when enabled, ensures that users hear a warning tone when other users bridge into an active call on the same shared line appearance.

  • Read

    Read Push-to-Talk Settings for a Workspace

    Retrieve Push-to-Talk settings for a workspace. Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people/workspaces in different parts of your organization.

  • Read

    Retrieve Privacy Settings for a Workspace

    Retrieve Privacy Settings for a Workspace. The privacy feature enables the Workspaces line to be monitored by others and determine if they can be reached by Auto Attendant services.

  • Read

    Read Voicemail Settings for a Workspace

    Retrieve a workspace Voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, .wav, format.

  • Read

    Retrieve Sequential Ring Criteria for a Workspace

    Retrieve sequential ring criteria for a workspace. The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.

  • Read

    Read Call Policy Settings for a Workspace

    Retrieve a workspace Call Policies settings. The call policy feature enables administrator to configure call policy settings such as Connected Line Identification Privacy on Redirected Calls for a professional workspace.

  • Read

    Retrieve Sequential Ring Settings for a Workspace

    Retrieve sequential ring settings for a workspace. The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.

  • Read

    Retrieve Simultaneous Ring Settings for a Workspace

    Retrieve Simultaneous Ring Settings for a Workspace. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.

  • Read

    Retrieve Simultaneous Ring Criteria for a Workspace

    Retrieve Simultaneous Ring Criteria Settings for a Workspace. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.

  • Read

    Retrieve Selective Reject Settings for a Workspace

    Retrieve Selective Reject Settings for a Workspace. With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.

  • Read

    Retrieve Selective Reject Criteria for a Workspace

    Retrieve Selective Reject Criteria Settings for a Workspace. With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.

  • Read

    Retrieve Selective Accept Settings for a Workspace

    Retrieve Selective Accept Settings for a Workspace. With the Selective Accept feature, you can accept calls at specific times from specific callers. Schedules can also be set up for this feature during certain times of the day or days of the week.

  • Read

    Retrieve Selective Accept Criteria for a Workspace

    Retrieve Selective Accept Criteria Settings for a Workspace. With the Selective Accept feature, you can accept calls at specific times from specific callers. Schedules can also be set up for this feature during certain times of the day or days of the week.

  • Read

    Retrieve Priority Alert Settings for a Workspace

    Retrieve Priority Alert Settings for a Workspace. The priority alert feature enables administrators to configure priority alert settings for a professional workspace.

  • Read

    Retrieve Priority Alert Criteria for a Workspace

    Retrieve Priority Alert Criteria Settings for a Workspace. The priority alert feature enables administrators to configure priority alert settings for a professional workspace.

  • Read

    Retrieve Selective Forward Settings for a Workspace

    Retrieve Selective Forward Call Settings for a Workspace. With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.

  • Read

    Retrieve Selective Forward Criteria for a Workspace

    Retrieve Selective Forward Criteria Settings for a Workspace. With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.

  • Read

    Get Workspace Fax Message Available Phone Numbers

    List standard numbers that are available to be assigned as a workspace's FAX message number. These numbers are associated with the location of the workspace specified in the request URL, can be active or inactive, and are unassigned.

  • Read

    Get Workspace Secondary Available Phone Numbers

    List standard numbers that are available to be assigned as a workspace's secondary number. These numbers are associated with the location of the workspace specified in the request URL, can be active or inactive, and are unassigned.

  • Read

    Retrieve a Workspace's Outbound Billing Plan

    Not supported for Webex for Government (FedRAMP). Retrieve the Cisco Calling Plan outbound billing plan setting for a workspace. Cisco Calling Plan outbound billing identifies whether outbound calls for the workspace are billed through Cisco Calling Plan.

  • Read

    Get Answer Settings for a Workspace

    Get the answer settings for a specific workspace. Answer settings allow administrators to configure automatic call answering behavior for a workspace, including preferred answer endpoint and whether auto answer is enabled.

  • Read

    Get Available Preferred Answer Endpoints for a Workspace

    Get the list of available preferred answer endpoints for a specific workspace. This API returns all available endpoints in a single response.

  • Write

    Create Digit Pattern for a Workspace

    Create a new digit pattern for the given workspace. Digit patterns are used to bypass permissions. This API requires a full or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Write

    Upload Call Intercept Announcement file for a Workspace

    Upload call intercept announcement file for a workspace. The upload announcement feature for a call intercept is used to play custom announcements for a workspace. Your request will need to be a multipart/form-data request rather than JSON, using the audio/wav Content-Type.

  • Write

    Configure Busy Voicemail Greeting for a Place

    Configure a workspace's Busy Voicemail Greeting by uploading a Waveform Audio File Format, .wav, encoded audio file. Your request will need to be a multipart/form-data request rather than JSON, using the audio/wav Content-Type.

  • Write

    Configure No Answer Voicemail Greeting for a Place

    Configure a workspace's No Answer Voicemail Greeting by uploading a Waveform Audio File Format, .wav, encoded audio file. Your request will need to be a multipart/form-data request rather than JSON, using the audio/wav Content-Type.

  • Write

    Create Sequential Ring Criteria for a Workspace

    Create sequential ring criteria for a workspace. The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.

  • Write

    Create Simultaneous Ring Criteria for a Workspace

    Create Simultaneous Ring Criteria Settings for a Workspace. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.

  • Write

    Create Selective Reject Criteria for a Workspace

    Create Selective Reject Criteria Settings for a Workspace. With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.

  • Write

    Create Selective Accept Criteria for a Workspace

    Create Selective Accept Criteria Settings for a Workspace. With the Selective Accept feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.

  • Write

    Create Priority Alert Criteria for a Workspace

    Create Priority Alert Criteria Settings for a Workspace. The priority alert feature enables administrators to configure priority alert settings for a professional workspace.

  • Write

    Create Selective Forward Criteria for a Workspace

    Create Selective Forward Call Criteria Settings for a Workspace. With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.

  • Destructive

    Modify Music On Hold Settings for a Workspace

    Modify music on hold settings for a Workspace. Music on hold is played when a caller is put on hold, or the call is parked. To configure music on hold setting for a workspace, music on hold setting must be enabled for this location.

  • Destructive

    Delete a Specific Access Code for a Workspace

    Deletes a specific access code for the given workspace. Access codes are used to bypass permissions. This API requires a full, device or location administrator auth token with the scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Modify the Digit Pattern Category Control Settings for the Workspace

    Modifies whether this workspace uses the specified digit patterns when placing outbound calls or not. Updating the digit pattern category control settings requires a full or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Delete all Digit Patterns for a Workspace

    Delete all digit patterns for a Workspace. Digit patterns are used to bypass permissions. This API requires a full or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Modify a Digit Pattern for the Workspace

    Modify the designated digit pattern. Digit patterns are used to bypass permissions. This API requires a full or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Delete a Digit Pattern for the Workspace

    Delete a digit pattern for a Workspace. Digit patterns are used to bypass permissions. This API requires a full or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Modify Call Recording Settings for a Workspace

    Modify call forwarding settings for a workspace. The Call Recording feature provides a hosted mechanism to record the calls placed and received on the Carrier platform for replay and archival. This feature is helpful for quality assurance, security, training, and more.

  • Destructive

    Modify Anonymous Call Settings for a Workspace

    Modify Anonymous Call Settings for a Workspace. Anonymous Call Rejection, when enabled, blocks all incoming calls from unidentified or blocked caller IDs.

  • Destructive

    Modify Barge In Call Settings for a Workspace

    Modify Barge In Call Settings for a Workspace. Barge In, when enabled, allows you to use the Feature Access Code (FAC) on your desk phone to answer someone else’s phone call or barge in on a call they’ve already answered.

  • Destructive

    Modify DoNotDisturb Settings for a Workspace

    Modify DoNotDisturb Settings for a Workspace. Silence incoming calls with the Do Not Disturb feature. When enabled, callers hear the busy signal.

  • Destructive

    Modify Call Bridge Warning Tone Settings for a Workspace

    Modify Call Bridge Warning Tone Settings for a Workspace. Call Bridge Warning Tone, when enabled, ensures that users hear a warning tone when other users bridge into an active call on the same shared line appearance.

  • Destructive

    Configure Push-to-Talk Settings for a Workspace

    Configure Push-to-Talk settings for a workspace. Push-to-Talk allows the use of desk phones as either a one-way or two-way intercom that connects people/workspaces in different parts of your organization.

  • Destructive

    Modify Privacy Settings for a Workspace

    Modify Privacy Settings for a Workspace. The privacy feature enables the Workspaces line to be monitored by others and determine if they can be reached by Auto Attendant services.

  • Destructive

    Configure Voicemail Settings for a Workspace

    Configure a workspace Voicemail settings. The voicemail feature transfers callers to voicemail based on your settings. You can then retrieve voice messages via Voicemail. Voicemail audio is sent in Waveform Audio File Format, .wav, format.

  • Destructive

    Modify Voicemail Passcode for a Workspace

    Modify voicemail passcode for a workspace. Modifying the voicemail passcode for a workspace requires a full administrator, device administrator or location administrator auth token with a scope of spark-admin:telephonyconfigwrite.

  • Destructive

    Modify Sequential Ring Criteria for a Workspace

    Modify sequential ring criteria for a workspace. The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.

  • Destructive

    Delete Sequential Ring Criteria for a Workspace

    Delete sequential ring criteria for a workspace. The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.

  • Destructive

    Configure Call Policy Settings for a Workspace

    Configure a workspace Call Policies settings. The call policy feature enables administrator to configure call policy settings such as Connected Line Identification Privacy on Redirected Calls for a professional workspace.

  • Destructive

    Modify Sequential Ring Settings for a Workspace

    Modify sequential ring settings for a workspace. The sequential ring feature enables you to create a list of up to five phone numbers. When the workspace receives incoming calls, these numbers will ring one after another.

  • Destructive

    Modify Simultaneous Ring Settings for a Workspace

    Modify Simultaneous Ring Settings for a Workspace. The Simultaneous Ring feature allows you to configure the workspace phones of your choice to ring simultaneously. Schedules can also be set up to ring these phones during certain times of the day or days of the week.

  • Destructive

    Modify Simultaneous Ring Criteria for a Workspace

    Modify Simultaneous Ring Criteria Settings for a Workspace. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.

  • Destructive

    Delete Simultaneous Ring Criteria for a Workspace

    Delete simultaneous ring criteria Settings for a workspace. The Simultaneous Ring feature allows you to configure your office phone and other phones of your choice to ring simultaneously.

  • Destructive

    Modify Selective Reject Settings for a Workspace

    Modify Selective Reject Settings for a Workspace. With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.

  • Destructive

    Modify Selective Reject Criteria for a Workspace

    Modify Selective Reject Criteria Settings for a Workspace. With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.

  • Destructive

    Delete Selective Reject Criteria for a Workspace

    Delete Selective Reject criteria Settings for a workspace. With the Selective Reject feature, you can reject calls at specific times from specific callers. This setting takes precedence over Selectively Accept Calls.

  • Destructive

    Assign or Unassign numbers associated with a specific workspace

    Assign or unassign alternate phone numbers associated with a specific workspace. Each location has a set of phone numbers that can be assigned to people, workspaces, or features.

  • Destructive

    Modify Selective Accept Settings for a Workspace

    Modify Selective Accept Settings for a Workspace. With the Selective Accept feature, you can accept calls at specific times from specific callers. Schedules can also be set up for this feature during certain times of the day or days of the week.

  • Destructive

    Modify Selective Accept Criteria for a Workspace

    Modify Selective Accept Criteria Settings for a Workspace. With the Selective Accept feature, you can accept calls at specific times from specific callers Schedules can also be set up for this feature during certain times of the day or days of the week.

  • Destructive

    Delete Selective Accept Criteria for a Workspace

    Delete Selective Accept criteria Settings for a workspace. With the Selective Accept feature, you can accept calls at specific times from specific callers. Schedules can also be set up for this feature during certain times of the day or days of the week.

  • Destructive

    Configure Priority Alert Settings for a Workspace

    Configure a workspace Priority Alert Settings. The priority alert feature enables administrator to configure priority alert settings for a professional workspace.

  • Destructive

    Modify Priority Alert Criteria for a Workspace

    Modify Priority Alert Criteria Settings for a Workspace. The priority alert feature enables administrators to configure priority alert settings for a professional workspace.

  • Destructive

    Delete Priority Alert Criteria for a Workspace

    Delete Priority Alert criteria Settings for a workspace. The priority alert feature enables administrators to configure priority alert settings for a professional workspace.

  • Destructive

    Modify Selective Forward Settings for a Workspace

    Modify Selective Forward Call Settings for a Workspace. With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.

  • Destructive

    Modify Selective Forward Criteria for a Workspace

    Modify Selective Forward Call Criteria Settings for a Workspace. With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.

  • Destructive

    Delete Selective Forward Criteria for a Workspace

    Delete Selective Forward Call criteria Settings for a workspace. With the Selective Forward feature, you can forward calls at specific times from specific callers. This setting takes precedence over call forwarding.

  • Destructive

    Modify a Workspace's Outbound Billing Plan

    Not supported for Webex for Government (FedRAMP). Modify the Cisco Calling Plan outbound billing plan setting for a workspace. Cisco Calling Plan outbound billing identifies whether outbound calls for the workspace are billed through Cisco Calling Plan.

  • Destructive

    Update Answer Settings for a Workspace

    Modify the answer settings for a specific workspace. Answer settings allow administrators to configure automatic call answering behavior for a workspace, including preferred answer endpoint and whether auto answer is enabled.

Agent Summaries

  • Read

    List summaries

    Lists summaries based on the requested search type.

Agent Wellbeing

  • Write

    Subscribe for realtime burnout events

    This endpoint provides real-time burnout events that are generated for agents belonging to the organization. It gives us a WebSocket URL to which we can connect to receive the real-time burnout events.

  • Write

    Record the realtime burnout events

    The endpoint need to be invoked by Partners and Third-Party that will subscribe to the Agent Burnout system, in order to take certain action based on the agent burnout index calculated.

AI Feature

  • Read

    Get specific Question mapped to AutoCSAT by ID

    Retrieve an existing Auto CSAT mapped Question by ID in a given organization.

  • Read

    Get specific AI Feature resource by ID

    Retrieve an existing AI Feature resource by ID in a given organization.

  • Read

    List AI Feature resource(s)

    Retrieve a list of AI Feature resource(s) in a given organization.Only one entry per organization can exist for AI Feature resource.

  • Read

    List Question mapped to AutoCSAT(s)

    Retrieve a list of Auto CSAT mapped Question(s) in a given organization.

  • Write

    Create a new Question mapped to AutoCSAT

    Create a new Auto CSAT mapped Question in a given organization.

  • Write

    Bulk save Question mapped to AutoCSAT

    Create, Update or delete Auto CSAT mapped Question(s) in bulk for Auto CSAT resource in a given organization.

  • Write

    Partially update AI Feature resource by ID

    Partially update AI Feature resource by ID in a given organization.

  • Destructive

    Delete specific Question mapped to AutoCSAT by ID

    Delete an existing Auto CSAT mapped Question by ID in a given organization.

Business Hour

  • Read

    List Business Hours resources

    Retrieve a list of Business Hours resources in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Read

    Get specific Business Hours resource by ID

    Retrieve an existing Business Hours resource by ID in a given organization.

  • Read

    List references for a specific Business Hours resource

    Retrieve a list of all entities that have reference to an existing Business Hours resource by ID in a given organization.

  • Read

    List Business Hours resources

    Retrieve a list of Business Hours resources in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Write

    Create a new Business Hours resource

    Create a new Business Hours resource in a given organization.

  • Write

    Bulk save Business Hours resources

    Create, Update or delete Business Hours resources in bulk in a given organization.

  • Destructive

    Update specific Business Hours resource by ID

    Update an existing Business Hours resource by ID in a given organization.

  • Destructive

    Delete specific Business Hours resource by ID

    Delete an existing Business Hours resource by ID in a given organization.

Holiday List

  • Read

    List Holiday Lists

    Retrieve a list of Holiday Lists in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Read

    Get specific Holiday List by ID

    Retrieve an existing Holiday List by ID in a given organization.

  • Read

    List references for a specific Holiday List

    Retrieve a list of all entities that have reference to an existing Holiday List by ID in a given organization.

  • Read

    List Holiday Lists

    Retrieve a list of Holiday Lists in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Write

    Create a new Holiday List

    Create a new Holiday List in a given organization.

  • Write

    Bulk save Holiday Lists

    Create, Update or delete Holiday Lists in bulk in a given organization.

  • Destructive

    Update specific Holiday List by ID

    Update an existing Holiday List by ID in a given organization.

  • Destructive

    Delete specific Holiday List by ID

    Delete an existing Holiday List by ID in a given organization.

Overrides

  • Read

    List Overrides resource(s)

    Retrieve a list of Overrides resource(s) in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Read

    Get specific Overrides resource by ID

    Retrieve an existing Overrides resource by ID in a given organization.

  • Read

    List references for a specific Overrides resource

    Retrieve a list of all entities that have reference to an existing Overrides resource by ID in a given organization.

  • Read

    List Overrides resource(s)

    Retrieve a list of Overrides resource(s) in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Write

    Create a new Overrides resource

    Create a new Overrides resource in a given organization.

  • Write

    Bulk save Overrides resource(s)

    Create, Update or delete Overrides resource(s) in bulk in a given organization.

  • Destructive

    Update specific Overrides resource by ID

    Update an existing Overrides resource by ID in a given organization.

  • Destructive

    Delete specific Overrides resource by ID

    Delete an existing Overrides resource by ID in a given organization.

Address Book

  • Read

    Get specific Address Book Entry by ID

    Retrieve an existing Address Book Entry by ID in a given organization.

  • Read

    List references for a specific Address Book

    Retrieve a list of all entities that have reference to an existing Address Book by ID in a given organization.

  • Read

    List Address Book Entry(s)

    Retrieve a list of Address Book Entry(s) in a given organization.

  • Read

    List Address Book(s)

    Retrieve a list of Address Book(s) in a given organization.

  • Read

    Get specific Address Book by ID

    Retrieve an existing Address Book by ID in a given organization.

  • Write

    Create a new Address Book Entry

    Create a new Address Book Entry in a given organization.

  • Write

    Bulk save Address Book Entry(s)

    Create, Update or delete Address Book Entry(s) in bulk for an Address Book in a given organization.

  • Write

    Create a new Address Book

    Create a new Address Book in a given organization.

  • Destructive

    Update specific Address Book Entry by ID

    Update an existing Address Book Entry by ID in a given organization.

  • Destructive

    Delete specific Address Book Entry by ID

    Delete an existing Address Book Entry by ID in a given organization.

  • Destructive

    Update specific Address Book by ID

    Update an existing Address Book by ID in a given organization.

  • Destructive

    Delete specific Address Book by ID

    Delete an existing Address Book by ID in a given organization.

Agent Personal Greeting Files

  • Read

    List Greeting Files

    Retrieve a list of Greeting Files in a given organization.

  • Read

    Get specific Greeting File by ID

    Retrieve an existing Greeting File by ID in a given organization.

  • Read

    List Greeting Files

    Retrieve a list of Greeting Files in a given organization.

  • Write

    Create a new Greeting File

    Create a new Greeting File in a given organization.

  • Write

    Partially update Greeting File by ID

    Partially update Greeting File by ID in a given organization.

  • Destructive

    Delete references of an agent from greeting files

    Removes all references of the specified agent (ciUserId) from greeting files in the given organization. Typically invoked when an agent is deleted or unassigned. in a given organization.

  • Destructive

    Update specific Greeting File by ID

    Update an existing Greeting File by ID in a given organization.

  • Destructive

    Delete specific Greeting File by ID

    Delete an existing Greeting File by ID in a given organization.

Asset

  • Read

    Get specific Asset by ID

    Retrieve an existing Asset by ID in a given organization. Set includeChannelName to true to include the channel name in the response.

  • Read

    List references for a specific Asset

    Retrieve a list of all entities that have reference to an existing Asset by ID in a given organization. For example, Entry Points.

  • Read

    List Assets

    Retrieve a list of Assets in a given organization. Supports pagination metadata. Set includeChannelName to true to include the channel name in the response. Set excludeEPAssociated to true to return only assets that are not associated with any Entry Point.

  • Write

    Create a new Asset

    Create a new Asset in a given organization. Supports work item assets with the specified channel and data schema.

  • Write

    Bulk save Assets

    Create, Update or delete Assets in bulk in a given organization. Supports CREATE, UPDATE, and DELETE actions in a single request.

  • Write

    Partially update Asset by ID

    Partially update Asset by ID in a given organization. Supported only for CUSTOMMESSAGING assets. Send only the fields to change; absent fields retain their current values. webhookConfig is optional; omit it to keep the existing credentials. For WORKITEM assets, use PUT instead.

  • Destructive

    Update specific Asset by ID

    Update an existing Asset by ID in a given organization. Supported for WORKITEM assets. For CUSTOMMESSAGING assets, use PATCH instead.

  • Destructive

    Delete specific Asset by ID

    Delete an existing Asset by ID in a given organization. Validates whether the asset is associated with any flow before deletion.

Audio Files

  • Read

    Get specific Audio File by ID

    Retrieve an existing Audio File by ID in a given organization.

  • Read

    List references for a specific Audio File

    Retrieve a list of all entities that have reference to an existing Audio File by ID in a given organization.

  • Read

    List Audio File(s)

    Retrieve a list of Audio File(s) in a given organization.

  • Write

    Create a new Audio File

    Create a new Audio File in a given organization.

  • Write

    Partially update Audio File by ID

    Partially update Audio File by ID in a given organization.

  • Destructive

    Update specific Audio File by ID

    Update an existing Audio File by ID in a given organization.

  • Destructive

    Delete specific Audio File by ID

    Delete an existing Audio File by ID in a given organization.

Auxiliary Code

  • Read

    Get specific Auxiliary Code by ID

    Retrieve an existing Auxiliary Code by ID in a given organization.

  • Read

    List references for a specific Auxiliary Code

    Retrieve a list of all entities that have reference to an existing Auxiliary Code by ID in a given organization.

  • Read

    List Auxiliary Code(s)

    Retrieve a list of Auxiliary Code(s) in a given organization.

  • Write

    Create a new Auxiliary Code

    Create a new Auxiliary Code in a given organization.

  • Write

    Bulk save Auxiliary Code(s)

    Create, Update or delete Auxiliary Code(s) in bulk in a given organization.

  • Write

    Bulk partial update Auxiliary Code(s)

    Update some or all properties for multiple Auxiliary codes in bulk in a given organization.

  • Destructive

    Purge inactive Auxiliary Code(s)

    Purge inactive Auxiliary Code(s) older than the configured interval for a given organization.

  • Destructive

    Update specific Auxiliary Code by ID

    Update an existing Auxiliary Code by ID in a given organization.

  • Destructive

    Delete specific Auxiliary Code by ID

    Delete an existing Auxiliary Code by ID in a given organization.

Call Monitoring Request

  • Read

    Get specific Call Monitoring by ID

    Retrieve an existing Call Monitoring by ID in a given organization.

  • Read

    List Call Monitoring Configurations

    Retrieve a list of Call Monitoring Configurations in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Write

    Create a new Call Monitoring

    Create a new Call Monitoring in a given organization.

  • Write

    Partially update Call Monitoring by ID

    Partially update Call Monitoring by ID in a given organization.

  • Destructive

    Delete References Call Monitoring

    POST /organization/{orgid}/call-monitoring/delete-reference

  • Destructive

    Update specific Call Monitoring by ID

    Update an existing Call Monitoring by ID in a given organization.

  • Destructive

    Delete specific Call Monitoring by ID

    Delete an existing Call Monitoring by ID in a given organization.

Channel

  • Read

    Get specific Channel by ID

    Retrieve an existing Channel by ID in a given organization. Set includeLogoUrlVersioned to true to include logoUrlVersioned in the response.

  • Read

    List references for a specific Channel

    Retrieve a list of all entities that have reference to an existing Channel by ID in a given organization. Includes Asset and Entry Point entities that reference the channel.

  • Read

    List Channels

    Retrieve a list of Channels in a given organization. Supports pagination metadata. Set includeLogoUrlVersioned to true to include logoUrlVersioned in the response. Note: Returning array fields in the List (Get All) API response is deprecated.

  • Write

    Create a new Channel

    Create a new Channel in a given organization. Supports custom channels for work items.

  • Write

    Bulk save Channels

    Create, Update or delete Channels in bulk in a given organization.

  • Write

    Partially update Channel by ID

    Partially update a channel by ID. Only the supplied fields are changed; absent fields retain their current values. Patchable fields: name, description, logoType (MOMENTUM only), logoIconName.

  • Destructive

    Update specific Channel by ID

    Update an existing Channel by ID in a given organization.

  • Destructive

    Delete specific Channel by ID

    Delete an existing Channel by ID in a given organization.

Contact Number

  • Read

    List all contact numbers(property - number)

    Retrieve a list of only contact numbers(property - number) from Contact Number(s) without pagination in a given organization.

  • Read

    Get specific Contact Number by ID

    Retrieve an existing Contact Number by ID in a given organization.

  • Read

    List Contact Number(s)

    Retrieve a list of Contact Number(s) in a given organization.

  • Write

    Create a new Contact Number

    Create a new Contact Number in a given organization.

  • Write

    Bulk save Contact Number(s)

    Create, Update or delete Contact Number(s) in bulk in a given organization.

  • Destructive

    Update specific Contact Number by ID

    Update an existing Contact Number by ID in a given organization.

  • Destructive

    Delete specific Contact Number by ID

    Delete an existing Contact Number by ID in a given organization.

Contact Service Queue

  • Read

    List skill-based Contact Service Queues by skill profile ID (public)

    Retrieve a list of skill-based Contact Service Queues associated with a given skill profile ID, accessible to authorized clients in a given organization.

  • Read

    List skill-based Contact Service Queues by dynamic skills and skill profile

    Retrieve a list of skill-based Contact Service Queues that match the given dynamic skills and skill profile criteria in a given organization.

  • Read

    List skill-based Contact Service Queues by skill profile ID and user ID

    Retrieve a list of skill-based Contact Service Queues associated with the given skill profile ID and user ID combination in a given organization.

  • Read

    List manually assignable Contact Service Queues

    Retrieve a list of Contact Service Queues that are eligible for manual contact assignment based on the provided criteria in a given organization.

  • Read

    Get specific Contact Service Queue by ID

    Retrieve an existing Contact Service Queue by ID in a given organization.

  • Read

    List references for a specific Contact Service Queue

    Retrieve a list of all entities that have reference to an existing Contact Service Queue by ID in a given organization.

  • Read

    List Contact Service Queues

    Retrieve a list of Contact Service Queues in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Read

    List agent-based Contact Service Queues by user ID

    Retrieve a list of agent-based Contact Service Queues by user ID in a given organization.

  • Read

    List skill-based Contact Service Queues by user ID

    Retrieve a list of skill-based Contact Service Queues by user ID in a given organization.

  • Read

    List team-based Contact Service Queues by user ID

    Retrieve a list of team-based Contact Service Queues by user ID in a given organization.

  • Read

    List queue mapping summary grouped by Assistant Skill

    Retrieve a list of queue mapping summary for a specified list of Assistant Skills specified in a given organization. The summary currently includes mapped queue count, and the last assigned time of queue mapping.

  • Read

    Get specific Contact Service Queue by ID

    Retrieve an existing Contact Service Queue by ID in a given organization.

  • Write

    Bulk save Contact Service Queues

    Create, Update or delete Contact Service Queues in bulk in a given organization.

  • Write

    Bulk partial update Contact Service Queues

    Update some or all properties for multiple Contact Service Queues in bulk in a given organization.

  • Write

    Bulk save Contact Service Queues

    Create, Update or delete Contact Service Queues in bulk in a given organization.

  • Write

    Create a new Contact Service Queue

    Create a new Contact Service Queue in a given organization.

  • Write

    Add or remove agents/users to/from an agent based queue

    This API can be used by a contact center supervisor to add or remove agents to or from an agent-based queue that they can access through their user profile access rights. Additionally, the request payload should contain the user ID(s) managed by the supervisor.

  • Destructive

    Delete references from Contact Service Queues

    Removes the references to the specified entities (such as teams, sites, or agents) from Contact Service Queues for a given organization.

  • Destructive

    Purge inactive Contact Service Queues

    Purge inactive Contact Service Queues older than the configured interval for a given organization.

  • Destructive

    Delete specific Contact Service Queue by ID

    Delete an existing Contact Service Queue by ID in a given organization.

  • Destructive

    Update specific Contact Service Queue by ID

    Update an existing Contact Service Queue by ID in a given organization.

Entry Point

  • Read

    Get specific Entry Point by ID

    Retrieve an existing Entry Point by ID in a given organization.

  • Read

    List references for a specific Entry Point

    Retrieve a list of all entities that have reference to an existing Entry Point by ID in a given organization.

  • Read

    List Entry Point(s)

    Retrieve a list of Entry Point(s) in a given organization. Note: Array fields are removed from List API. If all fields are required please fetch Id's and use get-by-id API.

  • Write

    Create a new Entry Point

    Create a new Entry Point in a given organization.

  • Write

    Bulk save Entry Point(s)

    Create, Update or delete Entry Point(s) in bulk in a given organization.

  • Destructive

    Purge inactive Entry Point(s)

    Purge inactive Entry Point(s) older than the configured interval for a given organization.

  • Destructive

    Delete specific Entry Point by ID

    Delete an existing Entry Point by ID in a given organization.

  • Destructive

    Update specific Entry Point by ID

    Update an existing Entry Point by ID in a given organization.

Desktop Layout

  • Read

    Get specific Desktop Layout by ID

    Retrieve an existing Desktop Layout by ID in a given organization.

  • Read

    List Desktop Layout(s)

    Retrieve a list of Desktop Layout(s) in a given organization. Json file content field won't be avalible in get all even though it is showing in sample response structure. and it will be avialable only in get by id.

  • Write

    Bulk save Desktop Layout(s)

    Create, Update or delete Desktop Layout(s) in bulk in a given organization.

  • Destructive

    Update specific Desktop Layout by ID

    Update an existing Desktop Layout by ID in a given organization.

Dial Number

  • Read

    List references for a specific Dialed Number Mapping

    Retrieve a list of all entities that have reference to an existing Dialed Number Mapping by ID in a given organization.

  • Read

    List Dialed Number Mapping(s)

    Retrieve a list of Dialed Number Mapping(s) in a given organization.

  • Read

    List only dialed numbers(property - dialledNumber) from Dialed Number Mapping(s)

    Retrieve a list of only dialed numbers(property - dialledNumber) from Dialed Number Mapping(s) without pagination in a given organization.

  • Read

    Get specific Dialed Number Mapping by ID

    Retrieve an existing Dialed Number Mapping by ID in a given organization.

  • Read

    List Dialed Number Mapping(s)

    Retrieve a list of Dialed Number Mapping(s) in a given organization.

  • Read

    List Dialed Number Mapping(s)

    Retrieve a list of Dialed Number Mapping(s) in a given organization.

  • Write

    Bulk save Dialed Number Mapping(s)

    Create, Update or delete Dialed Number Mapping(s) in bulk in a given organization.

  • Destructive

    Delete all Dialed Number Mapping(s)

    Delete all Dialed Number Mapping(s) in a given organization.

  • Destructive

    Update specific Dialed Number Mapping by ID

    Update an existing Dialed Number Mapping by ID in a given organization.

Desktop Profile

  • Read

    Get specific Desktop Profile by ID

    Retrieve an existing Desktop Profile by ID in a given organization.

  • Read

    List references for a specific Desktop Profile

    Retrieve a list of all entities that have reference to an existing Desktop Profile by ID in a given organization.

  • Read

    List Desktop Profiles

    Retrieve a list of Desktop Profiles in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Write

    Create a new Desktop Profile

    Create a new Desktop Profile in a given organization.

  • Write

    Bulk save Desktop Profiles

    Create, Update or delete Desktop Profiles in bulk in a given organization.

  • Destructive

    Purge inactive Desktop Profiles

    Purge inactive Desktop Profiles older than the configured interval for a given organization.

  • Destructive

    Update specific Desktop Profile by ID

    Update an existing Desktop Profile by ID in a given organization.

  • Destructive

    Delete specific Desktop Profile by ID

    Delete an existing Desktop Profile by ID in a given organization.

Global Variables

  • Read

    Get reportable count for Global Variable(s)

    Get count for all the reportable Global Variable(s) in a given organization.

  • Read

    Get specific Global Variable by ID

    Retrieve an existing Global Variable by ID in a given organization.

  • Read

    List references for a specific Global Variable

    Retrieve a list of all entities that have reference to an existing Global Variable by ID in a given organization.

  • Read

    List Global Variable(s)

    Retrieve a list of Global Variable(s) in a given organization.

  • Write

    Create a new Global Variable

    Create a new Global Variable in a given organization.

  • Write

    Bulk save Global Variable(s)

    Export all Global Variable(s) in a given organization.

  • Destructive

    Purge inactive Global Variable(s)

    Purge inactive Global Variable(s) older than the configured interval for a given organization.

  • Destructive

    Update specific Global Variable by ID

    Update an existing Global Variable by ID in a given organization. Required fields in payload are agentEditable, variableType, agentViewable, reportable, active, defaultValue.

  • Destructive

    Delete specific Global Variable by ID

    Delete an existing Global Variable by ID in a given organization.

Multimedia Profile

  • Read

    List Multimedia Profile(s)

    Retrieve a list of Multimedia Profile(s) in a given organization.

  • Read

    Get specific Multimedia Profile by ID

    Retrieve an existing Multimedia Profile by ID in a given organization.

  • Read

    List references for a specific Multimedia Profile

    Retrieve a list of all entities that have reference to an existing Multimedia Profile by ID in a given organization.

  • Read

    List Multimedia Profile(s)

    Retrieve a list of Multimedia Profile(s) in a given organization.

  • Write

    Create a new Multimedia Profile

    Create a new Multimedia Profile in a given organization.

  • Write

    Bulk save Multimedia Profile(s)

    Create, Update or delete Multimedia Profile(s) in bulk in a given organization.

  • Destructive

    Purge inactive Multimedia Profile(s)

    Purge inactive Multimedia Profile(s) older than the configured interval for a given organization.

  • Destructive

    Update specific Multimedia Profile by ID

    Update an existing Multimedia Profile by ID in a given organization.

  • Destructive

    Delete specific Multimedia Profile by ID

    Delete an existing Multimedia Profile by ID in a given organization.

Organization Setting

  • Read

    Get specific Organization Setting by ID

    Retrieve an existing Organization Setting by ID in a given organization.

  • Read

    List Organization Settings

    Retrieve a list of Organization Settings in a given organization.

  • Write

    Partially update Organization Setting by ID

    Partially update Organization Setting by ID in a given organization. Requests authenticated with a user token can modify only fields designated as user-modifiable.

  • Destructive

    Update specific Organization Setting by ID

    Update an existing Organization Setting by ID in a given organization. Requests authenticated with a user token can modify only fields designated as user-modifiable.

Outdial ANI

  • Read

    List Outdial ANIs

    Retrieve a list of Outdial ANIs in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Read

    List Outdial ANI Entries

    Retrieve a list of Outdial ANI Entries in a given organization.

  • Read

    Get specific Outdial ANI by ID

    Retrieve an existing Outdial ANI by ID in a given organization.

  • Read

    List references for a specific Outdial ANI

    Retrieve a list of all entities that have reference to an existing Outdial ANI by ID in a given organization.

  • Read

    Get specific Outdial ANI Entry by ID

    Retrieve an existing Outdial ANI Entry by ID in a given organization.

  • Read

    List Outdial ANIs

    Retrieve a list of Outdial ANIs in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Read

    List Outdial ANI Entries

    Retrieve a list of Outdial ANI Entries in a given organization.

  • Write

    Create a new Outdial ANI

    Create a new Outdial ANI in a given organization.

  • Write

    Bulk save Outdial ANIs

    Create, Update or delete Outdial ANIs in bulk in a given organization.

  • Write

    Create a new Outdial ANI Entry

    Create a new Outdial ANI Entry in a given organization.

  • Write

    Bulk save Outdial ANI Entries

    Create, Update or delete Outdial ANI Entries in bulk for an Address Book in a given organization.

  • Destructive

    Update specific Outdial ANI by ID

    Update an existing Outdial ANI by ID in a given organization.

  • Destructive

    Delete specific Outdial ANI by ID

    Delete an existing Outdial ANI by ID in a given organization.

  • Destructive

    Update specific Outdial ANI Entry by ID

    Update an existing Outdial ANI Entry by ID in a given organization.

  • Destructive

    Delete specific Outdial ANI Entry by ID

    Delete an existing Outdial ANI Entry by ID in a given organization.

Resource Collection

  • Read

    Get specific Resource Collection by ID

    Retrieve an existing Resource Collection by ID in a given organization.

  • Read

    List references for a specific Resource Collection

    Retrieve a list of all entities that have reference to an existing resource collection by ID in a given organization.

  • Read

    List Resource Collections

    Retrieve a list of resource collections in a given organization.

  • Write

    Create a new Resource Collection

    Create a new resource collection in a given organization.

  • Write

    Bulk partial update Resource Collections

    Update some or all properties for resource collections in bulk for a given organization.

  • Write

    Update resource with default resource collection

    Update resource with default resource collection. Ensure resource should not associated to any resource collection and resource should not be updated and not older than 15 min. Only single Resource Collection is allowed to update.

  • Destructive

    Update specific Resource Collection by ID

    Update an existing resource collection by ID in a given organization.

  • Destructive

    Delete specific Resource Collection by ID

    Delete an existing resource collection by ID in a given organization.

Skill

  • Read

    Get specific Skill by ID

    Retrieve an existing Skill by ID in a given organization.

  • Read

    List references for a specific Skill

    Retrieve a list of all entities that have reference to an existing Skill by ID in a given organization.

  • Read

    List Skills

    Retrieve a list of Skills in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Write

    Create a new Skill

    Create a new Skill in a given organization.

  • Write

    Bulk save Skills

    Create, Update or delete Skills in bulk in a given organization.

  • Destructive

    Purge inactive Skills

    Purge inactive Skills older than the configured interval for a given organization.

  • Destructive

    Update specific Skill by ID

    Update an existing Skill by ID in a given organization.

  • Destructive

    Delete specific Skill by ID

    Delete an existing Skill by ID in a given organization.

Skill Profile

  • Read

    List Skill Profile(s)

    Retrieve a list of Skill Profile(s) in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Read

    Get specific Skill Profile by ID

    Retrieve an existing Skill Profile by ID in a given organization.

  • Read

    List references for a specific Skill Profile

    Retrieve a list of all entities that have reference to an existing Skill Profile by ID in a given organization.

  • Read

    List Skill Profile(s)

    Retrieve a list of Skill Profile(s) in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Write

    Create a new Skill Profile

    Create a new Skill Profile in a given organization.

  • Write

    Bulk save Skill Profile(s)

    Create, Update or delete Skill Profile(s) in bulk in a given organization.

  • Destructive

    Update specific Skill Profile by ID

    Update an existing Skill Profile by ID in a given organization.

  • Destructive

    Delete specific Skill Profile by ID

    Delete an existing Skill Profile by ID in a given organization.

Team

  • Read

    List Teams

    Retrieve a list of Teams in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Read

    Get specific Team by ID

    Retrieve an existing Team by ID in a given organization.

  • Read

    List references for a specific Team

    Retrieve a list of all entities that have reference to an existing Team by ID in a given organization.

  • Read

    List Teams

    Retrieve a list of Teams in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Write

    Create a new Team

    Create a new Team in a given organization.

  • Write

    Bulk save Teams

    Create, Update or delete Teams in bulk in a given organization.

  • Destructive

    Purge inactive Teams

    Purge inactive Teams older than the configured interval for a given organization.

  • Destructive

    Update specific Team by ID

    Update an existing Team by ID in a given organization.

  • Destructive

    Delete specific Team by ID

    Delete an existing Team by ID in a given organization.

Tenant Configuration

  • Read

    Get specific Tenant Configuration by ID

    Retrieve an existing Tenant Configuration by ID in a given organization.

  • Read

    List Tenant Configuration

    Retrieve a list of Tenant Configuration in a given organization.

  • Destructive

    Update specific Tenant Configuration by ID

    Update an existing Tenant Configuration by ID in a given organization. Requests authenticated with a user token can modify only fields designated as user-modifiable.

User Profiles

  • Read

    List references for a specific User Profile

    Retrieve a list of all entities that have reference to an existing user profile by ID in a given organization.

  • Read

    List user profiles

    Retrieve a list of user profiles in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Read

    Get specific User Profile by ID

    Retrieve an existing user profile by ID in a given organization.

  • Read

    Get specific User Profile ACL by ID

    Retrieve an existing User Profile ACL by ID in a given organization.

  • Write

    Create a new User Profile

    Create a new user profile in a given organization.

  • Write

    Bulk save User Profiles

    Create, Update or delete user profiles in bulk in a given organization.

  • Destructive

    Update specific User Profile by ID

    Update an existing user profile by ID in a given organization.

  • Destructive

    Delete specific User Profile by ID

    Delete an existing user profile by ID in a given organization.

Users

  • Read

    List users by call monitoring id

    Fetch paginated users associated to the selected call monitoring team filters while enforcing team ACL.

  • Read

    Get users by dynamic skill ID

    Fetches all users assigned to a specific dynamic skill with search and pagination support. Returns user details with the specific dynamic skill value.

  • Read

    Get the agents matching skill requirements criteria

    This API can be used to fetch the agents who match the provided skill requirements criteria. Maximum of 50 skill requirements criteria can be passed in the request.

  • Read

    List Users with details

    Retrieve an existing User's first name, last name and email by list of IDs in a given organization.

  • Read

    List Users along with profile

    Retrieve a list of Users along with their User Profiles in a given organization.

  • Read

    Get specific User along with profile by ID

    Retrieve an existing User along with the corresponding User Profile by ID in a given organization.

  • Read

    Get specific User by ID

    Retrieve an existing Users by ID in a given organization.

  • Read

    List references for a specific User

    Retrieve a list of all entities that have reference to an existing User by ID in a given organization.

  • Read

    List Users

    Retrieve a list of Users in a given organization. Note: Returning array fields in the List (Get All) API response is deprecated. To retrieve the complete resource with all fields, please use the Get-by-ID API instead.

  • Read

    Get specific User by CI User ID

    Retrieve an existing User using the CI ID in a given organization.

  • Write

    Bulk partial update Users

    Update some or all properties for multiple users in bulk for a given organization.

  • Write

    Bulk partial update Users with dynamic skills

    Assign or unassign a dynamic skill to/from multiple users in bulk for a given organization.

  • Write

    Partially update User by ID

    Partially update User by ID in a given organization.

  • Write

    Reskill Agents

    Reskill agents by assigning or unassigning skills.

  • Destructive

    Update specific User by ID

    Update an existing User by ID in a given organization.

Work Types

  • Read

    Get specific Work Type by ID

    Retrieve an existing Work Type by ID in a given organization.

  • Read

    List references for a specific Work Type

    Retrieve a list of all entities that have reference to an existing Work Type by ID in a given organization.

  • Read

    List Work Type(s)

    Retrieve a list of Work Type(s) in a given organization.

  • Write

    Create a new Work Type

    Create a new Work Type in a given organization.

  • Write

    Bulk save Work Type(s)

    Create, Update or delete Work Type(s) in bulk in a given organization.

  • Destructive

    Purge inactive Work Type(s)

    Purge inactive Work Type(s) older than the configured interval for a given organization.

  • Destructive

    Update specific Work Type by ID

    Update an existing Work Type by ID in a given organization.

  • Destructive

    Delete specific Work Type by ID

    Delete an existing Work Type by ID in a given organization.

Estimated Wait Time

  • Read

    Get Estimated Wait Time

    Retrieve Estimated Wait Time information for a specified look back interval for a specific orgId and queueId combination, with ability to customomize maxCV and minValidSamples (See description above).

External Data Updates

  • Destructive

    Update Task Global Variables

    Updates numeric global variable values associated with a completed Webex Contact Center task. The request must identify the organization and task along with its start and end timestamps. The task should have ended within two days prior to the time of making the request.

Notification

  • Write

    Subscribe Notification

    Access this endpoint when the user has to register for a WebSocket Session. Requires one of the following accepted registration scopes: cjp:user or cloud-contact-center:podconv. The cjp-hybrid-conn:read scope is also accepted when CCE authentication is enabled.

Queues

  • Read

    Get Queue Statistics

    Retrieve Queue statistics for a given interval of time. An important thing to note is that each stat produced is for a specified time window (last 15, 30, or 60 minutes etc) and is not cumulative.

Realtime

  • Write

    Subscribe Realtime Notification

    Access this endpoint when the user has to register for a WebSocket Session to receive realtime events. Requires one of the following accepted registration scopes: cjp:user or cloud-contact-center:podconv.

Search

  • Read

    Search tasks

    The /search API is a GraphQL endpoint that enables customers to fetch data from Webex Contact Center.

Search Metadata

  • Read

    Get Search Metadata

    Returns schema metadata for the Webex Contact Center Search GraphQL API, describing supported queries, fields, nested structures, data types, filters, sorting options, grouping capabilities, and aggregation operations.

Subscriptions

  • Read

    List Subscriptions

    Retrieve all subscriptions for a given organization. Requires cjp:configread scope.

  • Read

    Get Subscription

    Retrieve a subscription for a given subscription ID. Requires cjp:configread scope.

  • Read

    List Event Types

    Retrieve all available event types for an organization. Requires cjp:configread scope.

  • Read

    List Subscriptions

    Retrieve all subscriptions for a given organization. Requires cjp:configread scope.

  • Read

    Get Subscription

    Retrieve a subscription for a given subscription ID. Requires cjp:configread scope.

  • Read

    List Event Types

    Retrieve all available event types for an organization along with information about the currently supported resource versions. Requires cjp:configread scope.

  • Write

    Register Subscription

    Create a subscription which would allow consumers to listen to events. If creating a subscription causes the org-level limit to be exceeded, the subscription registration will be denied. Requires cjp:configwrite scope.

  • Write

    Update Subscription

    Updates some of the properties in a subscription, for a given subscription ID. Requires cjp:configwrite scope.

  • Write

    Register Subscription

    Create a subscription which would allow consumers to listen to events. If creating a subscription causes the org-level limit to be exceeded, the subscription registration will be denied. Requires cjp:configwrite scope.

  • Write

    Update Subscription

    Updates some of the properties in a subscription, for a given subscription ID. Requires cjp:configwrite scope.

  • Destructive

    Delete Subscription

    Deletes a subscription for a given subscription ID. Requires cjp:configwrite scope.

  • Destructive

    Delete Subscription

    Deletes a subscription for a given subscription ID. Requires cjp:configwrite scope.

Agents

  • Read

    Get Agent Activities

    Retrieve agent activities. Requires a bearer access token authorized to access the requested organization and agent data. Results are sorted by start time in ascending order. Maximum number of records that can be fetched for the given from and to is 10,000.

  • Read

    Get Agent Statistics

    Retrieve agent statistics for the specified time duration and interval. Requires a bearer access token authorized to access the requested organization and agent data.

  • Write

    Login

    Allows the user to login to their desktop. It does not allow a duplicate login and sends an error message over websocket if an active session already exists. Requires the 'cjp:user' scope.

  • Write

    Reload

    Requests restoration of the active agent session, including agent state and assigned interaction context. This asynchronous API returns 202 Accepted when the request is accepted for processing; the restoration result is delivered over WebSocket.

  • Write

    Buddy Agents List

    Returns the list of agents in the given state and media according to agent profile settings. Requires an agent or supervisor access token with the 'cjp:user' scope.

  • Write

    Login

    Allows the user to login to their desktop. It does not allow a duplicate login and sends an error message over websocket if an active session already exists. Requires the 'cjp:user' scope.

  • Write

    Reload

    Requests restoration of the active agent session, including agent state and assigned interaction context. This asynchronous API returns 202 Accepted when the request is accepted for processing; the restoration result is delivered over WebSocket.

  • Destructive

    Logout

    Allows the user to logout from their Desktop. This API needs to be called once the WSS session has been successfully established. Self logout for an agent or supervisor requires the 'cjp:user' scope.

  • Destructive

    State Change

    Allows the user to toggle between the Idle and Available states. Self state changes for an agent, supervisor or Licensed Administrator with agent capability enabled, require the 'cjp:user' scope and an active agent session.

  • Destructive

    Logout

    Allows the user to logout from their Desktop. This API needs to be called once the WSS session has been successfully established. Self logout for an agent or supervisor requires the 'cjp:user' scope.

  • Destructive

    State Change

    Allows the user to toggle between the Idle and Available states for the requested channels. Self state changes for an agent or supervisor require the 'cjp:user' scope and an active agent session.

Call Monitoring

  • Read

    Fetch Monitoring Sessions

    Fetches all active monitoring subscriptions for the requesting user.

  • Write

    BargeIn Request

    Creates a barge-in request to join a call that is already being monitored.

  • Write

    Whisper Coach Request

    Creates a Whisper Coach request to coach an agent on a call that is already being monitored.

  • Write

    End Monitoring Request

    Ends an ongoing monitoring session. Requires the 'cloud-contact-center:podconv' scope and either the 'cjp.supervisor' role with a supervisor profile or, when Licensed Administrator access is enabled, the 'cjp.admin' or 'idfulladmin' role together with the 'cjp.premiumagent' role…

  • Write

    Hold Monitoring Request

    Places the monitoring session for a call on hold. Requires the 'cloud-contact-center:podconv' scope and either the 'cjp.supervisor' role with a supervisor profile or, when Licensed Administrator access is enabled, the 'cjp.admin' or 'idfulladmin' role together with the 'cjp.prem…

  • Write

    Unhold Monitoring Request

    Resumes a monitoring session that is on hold. Requires the 'cloud-contact-center:podconv' scope and either the 'cjp.supervisor' role with a supervisor profile or, when Licensed Administrator access is enabled, the 'cjp.admin' or 'idfulladmin' role together with the 'cjp.premiuma…

  • Destructive

    Delete Monitoring Request

    Deletes a monitoring request. Requires the 'cloud-contact-center:podconv' scope and either the 'cjp.supervisor' role with a supervisor profile or, when Licensed Administrator access is enabled, the 'cjp.admin' or 'idfulladmin' role together with the 'cjp.premiumagent' role and a…

Callbacks

  • Read

    Get scheduled callbacks

    Allows the user to list scheduled callbacks for a given customer number or assignee agent, excluding those whose scheduled trigger time has already passed. Requires 'cjp:user' scope for authorization.

  • Read

    Get scheduled callback by Id

    Retrieve an existing scheduled callback by Id, excluding those whose scheduled trigger time has already passed. Requires 'cjp:user' scope for authorization.

  • Write

    Schedule a Callback

    Creates a new callback request for a customer. Authorization requires the cjp:user scope. The callback default endpoint (EP) and default ANI must be configured as mandatory settings to successfully make API calls.

  • Destructive

    Update scheduled callback by Id

    Update an existing scheduled callback by Id,those whose scheduled trigger time has already passed cannot be updated. Requires 'cjp:user' scope for authorization.

  • Destructive

    Delete scheduled callback by Id

    Delete an existing scheduled callback by Id, those whose scheduled trigger time has already passed cannot be deleted. Requires 'cjp:user' scope for authorization.

Tasks

  • Read

    Get Tasks

    Retrieve open and closed tasks. Sorted by createdTime ascending. Uses offset-based pagination. For this API, response compression using gzip can be enabled by including 'Accept-Encoding' header in the request with its value as 'gzip'.

  • Write

    Create Task

    This API is to create a task for work or handling assignments. Represents both inbound tasks (originating from customer-facing channels) and outbound tasks (originating from contact center to customer-facing channel). Requires 'cjp:user' scope for authorization.

  • Write

    Update Task

    This API is to update a task. Represents both inbound tasks (originating from customer-facing channels) and outbound tasks (originating from contact center to customer-facing channel).

  • Write

    Accept Task

    Access this endpoint when the user has to accept either an inbound or an outbound requests. The request can be social, a chat or an email. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:podconv' for authorization.

  • Write

    End Task

    Access this endpoint when the user has to end either an inbound or an outbound requests. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:podconv' for authorization. For a list of possible response messages, see the Call Control API Guide.

  • Write

    Wrap Up Task

    Access this endpoint when the user has to wrap up a call. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:podconv' for authorization. For a list of possible response messages, see the Call Control API Guide.

  • Write

    Hold Task

    Access this endpoint when the user has to hold a call. When an user is in consulting state, the task will be put on hold. It is not applicable for chats and emails. Requires one of the following scopes 'cjp:user','cloud-contact-center:podconv' for authorization.

  • Write

    Unhold Task

    Access this endpoint when the user has to resume a call from hold. When an user is done consulting, the previously held interaction with the customer should be resumed. It is not applicable for chats and emails.

  • Write

    Pause Task

    Access this endpoint when users such as administrators, supervisors, or agents with an agent license need to pause a task that cannot be handled immediately. This API is supported only for non-real-time digital channels, such as email, social, etc.

  • Write

    Resume Task

    Access this endpoint when users such as administrators, supervisors, or agents with an agent license need to resume a previously paused task. This API is supported only for non-real-time digital channels, such as email, social, etc. Authorization requires the cjp:user scope.

  • Write

    Reject Task

    Access this endpoint when the user has to reject a task. Once a task is rejected, the status of the user goes to idle from available. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:podconv' for authorization.

  • Write

    Pause Recording Task

    When configured by the administrator, telephony tasks are often being recorded for various reasons. When an user is handling sensitive customer information, he/she might want to pause the recording and later on resume recording.

  • Write

    Resume Recording Task

    When configured by the administrator, telephony tasks are often being recorded for various reasons. When an user is handling sensitive customer information, he/she might resume the recording after the pause.

  • Write

    Transfer Task

    Access this endpoint when the user has to transfer a call to another user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:podconv' scope for authorization. For a list of possible response messages, see the Call Control API Guide.

  • Write

    Consult Task

    Access this endpoint when the user has to consult a call to another user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:podconv' for authorization. For a list of possible response messages, see the Call Control API Guide.

  • Write

    Consult Conference Task

    Access this endpoint when the user has to initiate a conference with the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:podconv' for authorization. For a list of possible response messages, see the Call Control API Guide.

  • Write

    Consult Transfer Task

    Access this endpoint when the user has to transfer a call to the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:podconv' for authorization. For a list of possible response messages, see the Call Control API Guide.

  • Write

    Consult Accept Task

    Access this endpoint when the user has to accept a call to the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:podconv' for authorization. For a list of possible response messages, see the Call Control API Guide.

  • Write

    Assign Task

    Access this endpoint when users such as administrators, supervisors, or agents with an agent license need to assign tasks to themselves. Authorization requires the cjp:user scope. For a list of potential response messages, refer to the Call Control API Guide.

  • Write

    Consult End Task

    Access this endpoint when the user has to end a call with the consulting user. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:podconv' for authorization. For a list of possible response messages, see the Call Control API Guide.

  • Write

    Exit Conference Task

    Access this endpoint when the user wants to exit from a conference call. Requires one of the following scopes 'cjp:user' or 'cloud-contact-center:podconv' for authorization. For a list of possible response messages, see the Call Control API Guide.

  • Write

    Drop Participant From Conference

    Access this endpoint when the user needs to drop a specific participant from an active conference associated with a task. This operation removes only the targeted participant while keeping the remaining parties in the conference. Requires cjp:user scope for authorization.

  • Write

    Accept Preview Task

    API to accept the preview campaign task offered to the agent.

  • Write

    Skip Preview Task

    API to skip the preview campaign task offered to the agent.

  • Write

    Create Task

    This feature is currently in Beta. Contact your Cisco team if you want access to this feature. Creates a new contact center task using the v2 task contract.

  • Write

    Append Task Message

    This feature is currently in Beta. Contact your Cisco team if you want access to this feature. Appends an inbound message to an existing workItem or customMessaging task. Use this API after the initial task has been created through Create Task. Requires cjp:taskwrite OAuth scope.

  • Destructive

    Remove Preview Task

    API to remove the preview campaign task offered to the agent

Activities

  • Read

    List Activity Definitions

    List all available activity types with their full schemas, including inputs, outputs, ports, and descriptions. The response is sufficient on its own to construct nodes — there is no separate schema endpoint. Scope: cjp:configread

  • Read

    Describe an Activity

    Retrieve a single activity's full definition, including inputs, outputs, named ports, and the JSON Schema for its inputs — all returned inline. Scope: cjp:configread

  • Read

    Get Activity Input Choices

    Resolve choices for an activity input. Use this when an activity input requires a value from a predefined or dynamically resolved set (e.g., available queues, audio files, agents).

Flows

  • Read

    List Flows or Subflows

    Returns a list of flows in response. Channel-based filtering can be applied with the searchBy query parameter (for example, channelType|telephony, channelType|workItem, channelType|customMessaging, channelType|genericAction).

  • Read

    Search Flows

    Returns a list of flows in response. The search is case-sensitive. Scope: cjp:configread. Roles: [Organizational Full Admin, Supervisor, Contact Center Service Admin, User Admin]

  • Read

    Validate a Flow or Subflow

    Dry-run validate a flow/subflow definition without persisting it. Use this to check correctness before importing. Include associatedChannels to preserve the channel metadata that import and export payloads round-trip.

  • Read

    Get a Flow or Subflow

    Retrieve the current draft of a flow/subflow as a flow document. To fetch a specific published version, use the :export endpoint. The response includes channel metadata (for example, associatedChannels) used by channel-specific activities such as customMessaging.

  • Read

    Validate an Existing Flow or Subflow Draft

    Validate the current draft of an existing flow/subflow (read-only operation). Validation reads the draft as stored. Drafts where associatedChannels is missing or empty are treated as telephony flows, and validation does not derive the effective channel from associatedChannels.

  • Read

    Export a Flow or Subflow

    Export a flow/subflow as a flow document for backup, migration, or version control. The exported payload includes associatedChannels metadata to preserve channel-specific activity behavior (for example, customMessaging) during re-import.

  • Write

    Publish a Flow or Subflow

    Returns the published flow in response. The Publish API validates the basic structure of the flows. We recommend manually verifying the published flows before proceeding with live traffic. Scope: cjp:configwrite.

  • Write

    Lock a Flow or Subflow

    Lock a flow to prevent concurrent edits by other users. Locks expire after 15 minutes of inactivity. Scope: cjp:configwrite. Roles: [Organizational Full Admin, Contact Center Service Admin]

  • Write

    Unlock a Flow or Subflow

    Release the lock on a flow to allow other users to edit it. Scope: cjp:configwrite. Roles: [Organizational Full Admin, Contact Center Service Admin]

  • Write

    Import a Flow or Subflow

    Import a new flow/subflow from a flow definition. Creates the flow/subflow in draft state and returns the assigned flow metadata, including flowId.

  • Write

    Save a Flow or Subflow Draft

    Save a complete flow/subflow document as the current draft, replacing the existing draft. Submitted associatedChannels values are not persisted on save; the draft preserves the existing stored channel metadata.

  • Write

    Patch a Flow or Subflow Draft

    Apply partial updates to an existing flow/subflow draft without replacing the entire document. The patch body is a Patch Draft Contract — server-side merge, idempotent, and re-validated after the merge.

  • Destructive

    Delete a Flow or Subflow

    Permanently deletes a flow or subflow. Flows deleted via this API are removed permanently and cannot be recovered. Scope: cjp:configwrite. Roles: [Organizational Full Admin, Contact Center Service Admin]

Functions

  • Read

    List Custom Functions

    List or search custom functions in the organization. Without filters, returns all custom functions. Supports filtering by name, language, and status, plus sorting and pagination. Scope: cjp:configread

  • Read

    Get a Custom Function

    Retrieve a custom function by its ID. Use versionOrTag to fetch a specific published version, or omit it to get the draft. Scope: cjp:configread

  • Read

    Export a Custom Function

    Export a custom function for the given version or publish tag. Returns the plain function-definition JSON (name, language, runtime, description, source code, inputs, and outputs), suitable for re-importing via the import API. Scope: cjp:configread

  • Write

    Create a Custom Function

    Create a new custom function. The source code is provided as an escaped string and the runtime defaults to the highest supported runtime for the given language. Scope: cjp:configwrite

  • Write

    Import a Custom Function

    Import a custom function from a previously exported function-definition JSON file, uploaded as the multipart file part (not a zip or base64 envelope). Use overwrite=true to replace any existing function with the same name. Scope: cjp:configwrite

  • Write

    Unlock a Custom Function

    Release the edit lock on a custom function so that other users can edit it. Scope: cjp:configwrite

  • Write

    Lock a Custom Function

    Acquire an edit lock on a custom function to prevent concurrent writes by other users. Scope: cjp:configwrite

  • Write

    Publish a Custom Function

    Publish the latest draft of a custom function under one or more tags (Dev, Test, Latest, Live). Ensure the function has been created or updated before calling this API. Scope: cjp:configwrite

  • Destructive

    Update a Custom Function

    Update an existing custom function by ID. Replaces the draft source code and metadata with the supplied body. Scope: cjp:configwrite

  • Destructive

    Delete a Custom Function

    Delete a custom function by ID. Use isForceDeletion=true to delete even when the function is referenced by one or more flows. Scope: cjp:configwrite

Templates

  • Read

    List Flow Templates

    List available flow templates that can be used to create new flows. Scope: cjp:configread

  • Read

    Get a Flow Template

    Retrieve a specific flow template by its ID. Use this to inspect a template's flow structure before creating a flow from it. Scope: cjp:configread

Journey Customer Identification API

  • Read

    Get all or a specific Person Details

    Get Person Details in JDS. If personId is provided by query parameter, this returns the Person whose personId matches the parameter. If not, this will return ALL the Persons within the organization and workspace.

  • Read

    Search for an Identity via aliases

    Get one or more Person Details searched by aliases in JDS. Multiple aliases should be separated by a comma. Role and Scope: Requires id full admin role with cjp:configwrite or cjp:configread scope. Or it requires any role with cjp:user, cjp:configwrite or cjp:configread scope.

  • Write

    Add/Remove/Replace details of a Person

    The Patch Api can be used to add/remove identities (email, phone, customerId, temporaryId, and socialId) or replace firstName and lastName of an Individual. We support only add, replace, and remove operations. For more information on Patch Requests, see this JSON PATCH guide.

  • Write

    Add one/more Identities to a person

    This Patch Api can be used to add identities(email, phone, customerId) to a person. Role and Scope: Requires id full admin or any role with cjp:configwrite scope.

  • Write

    Create a Person

    This API helps to create a Person in JDS. Role and Scope: Requires id full admin OR any role with cjp:configwrite scope.

  • Write

    Merges Identities to a Primary Identity

    Merges one/more Identities to a Primary Individual in JDS. Role and Scope: Requires id full admin role with cjp:configwrite scope.

  • Write

    Creates or merges aliases to an Individual in JDS

    This API enables you to consolidate multiple customer identifiers into a single, unified profile effortlessly.

  • Destructive

    Delete specific Person by id

    Delete Person Details searched by Person id in JDS. Role and Scope: Requires id full admin or any role with cjp:configwrite scope

  • Destructive

    Remove one/more Identities from a person

    This Patch Api can be used to remove identities(email, phone, customerId) from a person. Role and Scope: Requires id full admin or any role with cjp:configwrite scope.

Journey Data Ingestion API

  • Write

    Journey Event Posting

    Journey Event Posting API accepts events that describe what occurred, when, and by whom on every interaction across touch points and applications. Data Ingestion is based on Cloud Events specification for describing event data in a common way.

Journey Profile Creation & Insights API

  • Read

    Get A specific Template searched by template id

    Get Template details by template Id in JDS. Role and Scope: Requires id full admin role with cjp:configwrite or cjp:configread scope. Or requires any role with cjp:user, cjp:configwrite or cjp:configwrite scope.

  • Read

    Get All Template Details

    Get Template details by Organization Id and workspaceId in JDS. Role and Scope: Requires id full admin role with cjp:configwrite or cjp:configread scope. Or requires any role with cjp:user, cjp:configwrite or cjp:configread scope.

  • Read

    Get A specific Template searched by template name

    Get Template details by template Name in JDS. Role and Scope: Requires id full admin role with cjp:configwrite or cjp:configread scope. Or requires any role with cjp:user, cjp:configwrite or cjp:configread scope.

  • Read

    Historic Progressive Profile View by Template Name

    Get Historic Progressive Profile View in JDS. Role and Scope: Requires id full admin role with cjds:adminorgwrite or cjds:adminorgread scope. Or requires any role with cjp:user, cjp:configwrite or cjp:configread scope.

  • Read

    Historic Progressive Profile View

    Get Historic Progressive Profile View in JDS. Role and Scope: Requires id full admin role with cjds:adminorgwrite or cjds:adminorgread scope. Or requires any role with cjp:user, cjp:configwrite or cjp:configread scope.

  • Read

    Historic Progressive Profile View By Template Name

    Get Historic Progressive Profile View in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:adminorgread or cjds:adminorgwrite scopes or cjp:configread or cjp:configwrite scopes

  • Read

    Historic Progressive Profile View By Template Id

    Get Historic Progressive Profile View in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:adminorgread or cjds:adminorgwrite scopes or cjp:configread or cjp:configwrite scopes

  • Read

    Stream Progressive profile Views By Template Name

    Real-time streaming enables API consumers to listen for Progressive profile Views as it created/updated as part of the Journey; these may be transformed, value-added/enriched, and ready to be consumed or forwarded to another destination.

  • Read

    Stream Progressive profile Views By Template Id

    Real-time streaming enables API consumers to listen for Progressive profile Views as it created/updated as part of the Journey; these may be transformed, value-added/enriched, and ready to be consumed or forwarded to another destination.

  • Read

    Historic Journey Events

    Getting Historic Customer Journey Events from Pinot. These events are append-only, immutable data ledger that can be queried to retrieve snapshot of latest events that moment in time or historically to play-back events as they occurred to understand or analyze Journeys using ML/…

  • Read

    Stream Events By Identity

    Real-time streaming enables API consumers to listen for events as it arrives as part of the Journey; these may be transformed, value-added/enriched, and ready to be consumed or forwarded to another destination. Optionally accepts filter and data parameters slice/dice further.

  • Write

    Create Template

    Creates a Profile View Template in JDS. Role and Scope: Requires id full admin or any role with cjp:configwrite scope.

  • Destructive

    Update existing ProfileViewTemplate

    Update existing Profile View Template in JDS. Role and Scope: Requires id full admin or any role with cjp:configwrite scope.

  • Destructive

    Delete Template by template Id

    Delete Template By template id in JDS. Role and Scope: Requires id full admin or any role with cjp:configwrite scope.

Journey Subscription API

  • Read

    Get WXCC Subscription

    Get WXCC Subscription in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:adminorgread or cjds:adminorgwrite scopes or cjp:configread or cjp:configwrite scopes

  • Write

    Create WXCC Subscription

    Create WXCC Subscription in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:adminorgwrite or cjp:configwrite scopes

  • Destructive

    Delete WXCC Subscription

    Delete WXCC Subscription in JDS. Use the cjp scope if you have a contact center license; otherwise, use the cjds scope. It requires the appropriate cjds:adminorgwrite or cjp:configwrite scopes

Journey Trigger Actions API

  • Read

    Get all Journey Actions

    Get all Journey Actions in JDS. Role and Scope: Requires id full admin or any role with cjp:configwrite or cjp:configread scope.

  • Read

    Get all Journey Actions for a template

    Get all Journey Actions for a template in JDS. Role and Scope: It requires id full admin or any role with cjp:configread or cjp:configwrite scope.

  • Read

    Get specific Journey Action By Name

    Get specific Journey Action By Name in JDS. Role and Scope:It requires id full admin or any role with cjp:configread or cjp:configwrite scope.

  • Read

    Get specific Journey Action By ActionId

    Get specific Journey Action By ActionId in JDS. Role and Scope: It requires id full admin role with cjp:configread or cjp:configwrite scope.

  • Write

    Create a new Journey Action

    Create a new Journey Action in JDS. Role and Scope: It requires id full admin or any role with cjp:configwrite scope.

  • Destructive

    Update existing Journey Action

    Update existing Journey Action in JDS. Role and Scope: It requires id full admin or any role with cjp:configwrite scope.

  • Destructive

    Delete Journey Action configuration By ActionId

    Delete Journey Action configuration By ActionId in JDS. Role and Scope: It requires id full admin role with cjp:configwrite scope.

Campaign Manager

  • Read

    Get Valid Campaign Times

    Gets valid campaign times for a campaign and agent. This request is accepted for asynchronous processing.

  • Write

    Start Campaign Request

    A start campaign API allows businesses to programmatically start outbound campaigns using their own software applications.

  • Destructive

    Update Campaign Request

    By using an update campaign API, businesses can automate the process of modifying and managing outbound campaigns, and integrate campaign updates into their existing workflows or applications.

  • Destructive

    Stop Campaign Request

    The stop campaign API enables businesses to automate the process of managing outbound campaigns and integrate campaign deletion into their existing workflows or applications. Requires 'cjp.configwrite' scope and one of the following roles: 'cjp.admin','idfulladmin','atlas-portal.

Captures

  • Read

    List Captures

    Retrieve a list of Captures given a set of task IDs. Captures Availability Not all tasks will have captures by default and they will be available based on the organization's configurations and retention policy.

DNC Management

  • Read

    Get Phone Number from DNC List

    Retrieves details of a specific phone number from the specified Do Not Contact (DNC) list. This operation allows you to check if a number is present in the list and view associated metadata.

  • Write

    Add Phone Number to DNC List

    Adds a phone number to the specified Do Not Contact (DNC) list. This operation helps ensure compliance with applicable rules & regulations by preventing outbound calls to specific numbers. Note: Phone numbers must be in E.164 format (e.g., +1234567890).

  • Destructive

    Remove Phone Number from DNC List

    Removes a phone number from the specified Do Not Contact (DNC) list. This operation allows administrators to remove numbers that should no longer be blocked from receiving calls. Note: Phone numbers must be URL-encoded and in E.164 format (e.g., +1234567890 for +1234567890).

Campaign Group

  • Read

    List Campaigns by Campaign Group

    Retrieves the list of campaigns that belong to the specified campaign group. Results are paginated and can optionally be filtered by campaign status. Note: The campaignStatus filter is case-insensitive. Allowed values are Draft, Running, Pending, Paused, Completed, Ended.

Contact List Management

  • Read

    Get Contact Lists within a Campaign

    Retrieves all contact lists within a campaign, with optional filters for status and source. This is the v3 endpoint. Each contact list entry includes contactListRecordsProcessed (total processed records).

  • Read

    Get Contact Lists within a Campaign

    Retrieves all contact lists within a campaign. Use the optional status and source query parameters to filter results.

  • Write

    Create contact list

    Creates and activates a contact list for a campaign. The system can activate a contact list even if there are no contact records within it.

  • Write

    Create contacts within a contact list

    Creates contacts within a contact list (only if that contact list was created using API method). If the contact record is invalid, it will be added as INVALID and reflected in the 'Processed' and 'Invalid' counts. This is an Asynchronous operation.

  • Write

    Update a contact's status within a contact list

    Updates a contact's status within a contact list. After update, system overwrites 'Latest Telephony Outcome' to blank and 'Latest Business Outcome' to 'Closed via API call' if status is CLOSED. This is an Asynchronous operation.

  • Write

    Update contact status across the campaign chain

    Synchronously closes the specified contacts and returns the outcome in the same response.

  • Write

    Update contact list status

    Updates the status of a contact list (e.g., EXPIRED). Note: This value is not case-sensitive.

Broad Works Billing Reports

  • Read

    List BroadWorks Billing Reports

    Search for reports. There are a number of filter options which can be combined in a single request.

  • Read

    Get a BroadWorks Billing Report

    Retrieve a specific billing reconciliation report.

  • Write

    Create a BroadWorks Billing Report

    Generate a monthly reconciliation report. Partners who have moved to extended wholesale subscription model should generate reports via Wholesale Billing Reports.

  • Destructive

    Delete a BroadWorks Billing Report

    Delete a monthly reconciliation report using a report ID.

Broad Works Enterprises

  • Read

    List BroadWorks Enterprises

    List the provisioned enterprises for a Service Provider. This API also lets a Service Provider search for their provisioned enterprises on Webex. A search on enterprises can be performed by either a full or partial enterprise identifier.

  • Read

    Get Directory Sync Status for an Enterprise

    This API lets a Partner Admin get the most recent directory sync status for a customer's Broadworks enterprise on Webex.

  • Write

    Trigger Directory Sync for an Enterprise

    This API lets a Partner Admin trigger a directory sync for the customer's Broadworks enterprise on Webex.

  • Write

    Trigger Directory Sync for a User

    This API lets a Partner Admin trigger a directory sync for an external user (real or virtual user) on Broadworks enterprise with Webex.

  • Destructive

    Update Directory Sync for a BroadWorks Enterprise

    This API lets a Partner Admin enable or disable directory sync for the customer's Broadworks enterprise on Webex.

Broad Works Subscribers

  • Read

    List BroadWorks Subscribers

    This API lets a Service Provider search for their associated subscribers. There are a number of filter options that can be combined in a single request.

  • Read

    Get a BroadWorks Subscriber

    This API lets a Service Provider retrieve details of a provisioned BroadWorks subscriber on Webex.

  • Write

    Provision a BroadWorks Subscriber

    Provision a new BroadWorks subscriber for Webex services. This API lets a Service Provider map a BroadWorks subscriber to a new or existing Webex user and assign the required licenses and entitlements for Webex and Meetings.

  • Write

    Precheck a Broadworks Subscriber Provisioning

    Verify the likely success of provisioning a broadworks subscriber. The Prerequisite for using this API is to have at least one Broadworks Cluster configured against partner using Partner Hub.

  • Destructive

    Update a BroadWorks Subscriber

    This API lets a Service Provider update certain details of a provisioned BroadWorks subscriber on Webex.

  • Destructive

    Remove a BroadWorks Subscriber

    This API will allow a Service Provider to remove the mapping between a BroadWorks Subscriber and Webex user.

Broad Works Workspaces

  • Write

    Provision a BroadWorks Workspace

    Provision a new BroadWorks workspace for Cisco Webex services. This API allows a Service Provider to provision a workspace for an existing customer.

  • Destructive

    Update a Broadworks Workspace

    Update certain details of a provisioned BroadWorks workspace on Cisco Webex.

  • Destructive

    Remove a BroadWorks Workspace

    Remove the mapping between a BroadWorks workspace and Cisco Webex device.

Wholesale Billing Reports

  • Read

    List Wholesale Billing Reports

    Search for associated wholesale billing reconciliation reports.

  • Read

    Get a Wholesale Billing Report

    Retrieve a specific wholesale billing reconciliation report.

  • Write

    Create a Wholesale Billing Report

    Generate a wholesale billing reconciliation report.

  • Destructive

    Delete a Wholesale Billing Report

    Delete a monthly reconciliation report by report ID.

Wholesale Provisioning

  • Read

    List Wholesale Customers

    Return a list of wholesale customers. There are a number of filter options, which can be combined in a single request.

  • Read

    Get a Wholesale Customer

    Retrieves details of a provisioned Wholesale customer on Cisco Webex.

  • Read

    List Wholesale Sub-partners

    Lists all of the associated sub-partners. There are a number of filter and pagination options that can be combined in a single request.

  • Read

    List Wholesale Subscribers

    Allows a Service Provider to search for their associated subscribers. There are a number of filter options, which can be combined in a single request.

  • Read

    Get a Wholesale Subscriber

    Retrieves details of a provisioned Wholesale subscriber on Cisco Webex.

  • Write

    Provision a Wholesale Customer

    Provision a Wholesale customer for Cisco Webex services. This API will allow a Service Provider to map the Wholesale customer and assign the required licenses and entitlements for Webex, Calling and Meetings.

  • Write

    Precheck a Wholesale Customer Provisioning

    Allows the Partner sales team to verify likely success of provisioning a Wholesale customer.

  • Write

    Provision a Wholesale Subscriber

    Provision a new Wholesale subscriber for Cisco Webex services. This API allows a Service Provider to map the Wholesale subscriber to a Cisco Webex Wholesale customer and assign the required licenses and entitlements for Webex, Calling and Meetings.

  • Write

    Precheck a Wholesale Subscriber Provisioning

    Allows the Partner sales team to verify likely success of provisioning a wholesale subscriber.

  • Destructive

    Update a Wholesale Customer

    Updates certain details of a provisioned Wholesale customer for Cisco Webex services. The Wholesale customer provisioning is asynchronous and thus a background task is created when this endpoint is invoked.

  • Destructive

    Remove a Wholesale Customer

    Removes the mapping between a Wholesale Customer and a Cisco Webex organization..

  • Destructive

    Update a Wholesale Subscriber

    Updates certain details of a provisioned Wholesale subscriber. Note: The provisioningParameters attributes should only be supplied when changing from the webexmeetings package to any calling-enabled package.

  • Destructive

    Remove a Wholesale Subscriber

    Removes the mapping between Wholesale Subscriber and a Webex user.

UCM Profile

  • Read

    Read the List of UC Manager Profiles

    List all calling UC Manager Profiles for the organization. UC Manager Profiles are applicable if your organization uses Jabber in Team Messaging mode or Calling in Webex (Unified CM).

See How connections work for access and permissions, or browse all integrations.