Reference of all available methods

The following table contains a reference of all methods defined in the SDK with a short description of the operation. The method name is a link to the method documentation.

Method

api.close

api.admin_audit.list_event_categories

List Admin Audit Event Categories

api.admin_audit.list_events

List Admin Audit Events

api.attachment_actions.details

Shows details for a attachment action, by ID

api.authorizations.delete

Deletes an authorization, by authorization ID or client ID and org ID

api.authorizations.list

Lists all authorizations for a user

api.cdr.get_cdr_history

Provides Webex Calling Detailed Call History data for your organization

api.device_configurations.list

Lists all device configurations associated with the given device ID

api.device_configurations.update

Update Device Configurations

api.devices.activation_code

Create a Device Activation Code

api.devices.create_by_mac_address

Create a phone by it’s MAC address in a specific workspace or for a person

api.devices.delete

Delete a Device

api.devices.details

Get Device Details

api.devices.list

List Devices

api.devices.modify_device_tags

Modify Device Tags

api.devices.settings_jobs.change

Change device settings across organization or locations jobs

api.devices.settings_jobs.errors

List change device settings job errors

api.devices.settings_jobs.list

List change device settings jobs

api.devices.settings_jobs.status

Get change device settings job status

api.events.details

Shows details for an event, by event ID

api.events.list

List events in your organization

api.groups.create

Create a new group using the provided settings

api.groups.delete_group

Delete a group

api.groups.details

Get group details

api.groups.list

List groups in your organization

api.groups.members

Query members of a group

api.groups.update

update group information

api.guests.create

Create a Guest

api.guests.guest_count

Get Guest Count

api.licenses.assign_licenses_to_users

Assign Licenses to Users

api.licenses.assigned_users

Get users license is assigned to, by license ID

api.licenses.details

Shows details for a license, by ID

api.licenses.list

List all licenses for a given organization

api.locations.by_name

Get a location by name

api.locations.create

Create a new Location for a given organization

api.locations.create_floor

Create a Location Floor

api.locations.delete_floor

Delete a Location Floor

api.locations.details

Shows details for a location, by ID

api.locations.floor_details

Get Location Floor Details

api.locations.list

List locations for an organization

api.locations.list_floors

List Location Floors

api.locations.update

Update details for a location, by ID

api.locations.update_floor

Update a Location Floor

api.meetings.create

Creates a new meeting

api.meetings.delete

Deletes a meeting with a specified meeting ID

api.meetings.get

Retrieves details for a meeting with a specified meeting ID

api.meetings.join

Retrieves a meeting join link for a meeting with a specified meetingId, meetingNumber, or webLink that allows

api.meetings.list

Retrieves details for meetings with a specified meeting number, web link, meeting type, etc

api.meetings.list_of_series

Lists scheduled meeting and meeting instances of a meeting series identified by meetingSeriesId

api.meetings.list_survey_results

Retrieves results for a meeting survey identified by meetingId

api.meetings.list_tracking_codes

Lists tracking codes on a site by a meeting host

api.meetings.patch

Updates details for a meeting with a specified meeting ID

api.meetings.survey

Retrieves details for a meeting survey identified by meetingId

api.meetings.update

Updates details for a meeting with a specified meeting ID

api.meetings.update_simultaneous_interpretation

Updates simultaneous interpretation options of a meeting with a specified meeting ID

api.meetings.chats.delete

Deletes the meeting chats of a finished meeting instance specified by meetingId

api.meetings.chats.list

Lists the meeting chats of a finished meeting instance specified by meetingId

api.meetings.closed_captions.download_snippets

Download meeting closed caption snippets from the meeting closed caption specified by closedCaptionId formatted

api.meetings.closed_captions.list

Lists closed captions of a finished meeting instance specified by meetingId

api.meetings.closed_captions.list_snippets

Lists snippets of a meeting closed caption specified by closedCaptionId

api.meetings.invitees.create_invitee

Invite a person to attend a meeting

api.meetings.invitees.create_invitees

Invite people to attend a meeting in bulk

api.meetings.invitees.delete

Removes a meeting invitee identified by a meetingInviteeId specified in the URI

api.meetings.invitees.invitee_details

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

api.meetings.invitees.list

Lists meeting invitees for a meeting with a specified meetingId

api.meetings.invitees.update

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

api.meetings.participants.admit_participants

To admit participants into a live meeting in bulk

api.meetings.participants.list_participants

List all participants in a live or post meeting

api.meetings.participants.participant_details

Get a meeting participant details of a live or post meeting

api.meetings.participants.query_participants_with_email

Query participants in a live meeting, or after the meeting, using participant’s email

api.meetings.participants.update_participant

To mute, un-mute, expel, or admit a participant in a live meeting

api.meetings.preferences.audio_options

Retrieves audio options for the authenticated user

api.meetings.preferences.details

Retrieves meeting preferences for the authenticated user

api.meetings.preferences.personal_meeting_room_options

Retrieves the Personal Meeting Room options for the authenticated user

api.meetings.preferences.scheduling_options

Retrieves scheduling options for the authenticated user

api.meetings.preferences.site_list

Retrieves the list of Webex sites that the authenticated user is set up to use

api.meetings.preferences.update_audio_options

Updates audio options for the authenticated user

api.meetings.preferences.update_default_site

Updates the default site for the authenticated user

api.meetings.preferences.update_personal_meeting_room_options

Update a single meeting

api.meetings.preferences.update_scheduling_options

Updates scheduling options for the authenticated user

api.meetings.preferences.update_video_options

Updates video options for the authenticated user

api.meetings.preferences.video_options

Retrieves video options for the authenticated user

api.meetings.qanda.list

Lists questions and answers from a meeting, when ready

api.meetings.qanda.list_answers

Lists the answers to a specific question asked in a meeting

api.meetings.qualities.meeting_qualities

Get quality data for a meeting, by meetingId

api.meetings.recordings.delete_a_recording

Delete a Recording

api.meetings.recordings.get_recording_details

Get Recording Details

api.meetings.recordings.list_recordings

List Recordings

api.meetings.recordings.list_recordings_for_an_admin_or_compliance_officer

List Recordings For an Admin or Compliance Officer

api.meetings.recordings.move_recordings_into_the_recycle_bin

Move Recordings into the Recycle Bin

api.meetings.recordings.purge_recordings_from_recycle_bin

Purge Recordings from Recycle Bin

api.meetings.recordings.restore_recordings_from_recycle_bin

Restore Recordings from Recycle Bin

api.meetings.transcripts.delete

Removes a transcript with a specified transcript ID

api.meetings.transcripts.download

Download a meeting transcript from the meeting transcript specified by transcriptId

api.meetings.transcripts.list

Lists available transcripts of an ended meeting instance

api.meetings.transcripts.list_compliance_officer

Lists available or deleted transcripts of an ended meeting instance for a specific site

api.meetings.transcripts.list_snippets

Lists snippets of a meeting transcript specified by transcriptId

api.meetings.transcripts.snippet_detail

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

api.meetings.transcripts.update_snippet

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

api.membership.create

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

api.membership.delete

Deletes a membership by ID

api.membership.details

Get details for a membership by ID

api.membership.list

Lists all room memberships

api.membership.update

Updates properties for a membership by ID

api.messages.create

Post a plain text, rich text or html message, and optionally, a file attachment, to a room

api.messages.delete

Delete a message, by message ID

api.messages.details

Show details for a message, by message ID

api.messages.edit

Update a message you have posted not more than 10 times

api.messages.list

Lists all messages in a room

api.messages.list_direct

List all messages in a 1:1 (direct) room

api.organizations.delete

Delete Organization

api.organizations.details

Get Organization Details

api.organizations.list

List all organizations visible by your account

api.people.create

Create a Person

api.people.delete_person

Remove a person from the system

api.people.details

Shows details for a person, by ID

api.people.list

List people in your organization

api.people.me

Show the profile for the authenticated user

api.people.update

Update details for a person, by ID

api.person_settings.devices

Get all devices for a person

api.person_settings.reset_vm_pin

Reset Voicemail PIN

api.person_settings.agent_caller_id.available_queues

Retrieve the list of the person’s available call queues and the associated Caller ID information

api.person_settings.agent_caller_id.read

Retrieve a call queue agent’s Caller ID information

api.person_settings.agent_caller_id.update

Modify a call queue agent’s Caller ID information

api.person_settings.appservices.configure

Modify a Person’s Application Services Settings

api.person_settings.appservices.read

Retrieve a Person’s Application Services Settings

api.person_settings.barge.configure

Configure Barge In Settings

api.person_settings.barge.read

Retrieve Barge In Settings

api.person_settings.call_bridge.configure

Configure Call Bridge Settings

api.person_settings.call_bridge.read

Read Call Bridge Settings

api.person_settings.call_intercept.configure

Configure Call Intercept Settings

api.person_settings.call_intercept.greeting

Configure Call Intercept Greeting

api.person_settings.call_intercept.read

Read Call Intercept Settings

api.person_settings.call_recording.configure

Configure Call Recording Settings for a entity

api.person_settings.call_recording.read

Read Call Recording Settings

api.person_settings.call_waiting.configure

Configure Call Waiting Settings

api.person_settings.call_waiting.read

Read Call Waiting Settings for

api.person_settings.caller_id.configure

Configure a Caller ID Settings

api.person_settings.caller_id.configure_settings

Configure a Caller ID Settings

api.person_settings.caller_id.read

Retrieve Caller ID Settings

api.person_settings.calling_behavior.configure

Configure a Person’s Calling Behavior

api.person_settings.calling_behavior.read

Read Person’s Calling Behavior

api.person_settings.dnd.configure

Configure Do Not Disturb Settings for a Person

api.person_settings.dnd.read

Read Do Not Disturb Settings for a Person

api.person_settings.exec_assistant.configure

Modify Executive Assistant Settings for a Person

api.person_settings.exec_assistant.read

Retrieve Executive Assistant Settings for a Person

api.person_settings.forwarding.configure

Configure an Entity’s Call Forwarding Settings

api.person_settings.forwarding.read

Retrieve an entity’s Call Forwarding Settings

api.person_settings.hoteling.configure

Configure Hoteling Settings for a Person

api.person_settings.hoteling.read

Read Hoteling Settings for a Person

api.person_settings.monitoring.configure

Configure Call Waiting Settings for a Person

api.person_settings.monitoring.read

Retrieve a Person’s Monitoring Settings

api.person_settings.numbers.read

Get a person’s phone numbers including alternate numbers

api.person_settings.numbers.update

Assign or unassign alternate phone numbers to a person

api.person_settings.permissions_in.configure

Configure incoming permissions settings

api.person_settings.permissions_in.read

Read Incoming Permission Settings

api.person_settings.permissions_out.configure

Configure Outgoing Calling Permissions Settings

api.person_settings.permissions_out.read

Retrieve Outgoing Calling Permissions Settings

api.person_settings.permissions_out.access_codes.create

Create new Access codes

api.person_settings.permissions_out.access_codes.delete

Delete Access Code

api.person_settings.permissions_out.access_codes.modify

Modify Access Codes

api.person_settings.permissions_out.access_codes.read

Retrieve Access codes

api.person_settings.permissions_out.digit_patterns.create

Create Digit Patterns

api.person_settings.permissions_out.digit_patterns.delete

Delete a Digit Pattern

api.person_settings.permissions_out.digit_patterns.delete_all

Delete all Digit Patterns

api.person_settings.permissions_out.digit_patterns.details

Retrieve Digit Pattern Details

api.person_settings.permissions_out.digit_patterns.get_digit_patterns

Retrieve Digit Patterns

api.person_settings.permissions_out.digit_patterns.update

Modify Digit Patterns

api.person_settings.permissions_out.digit_patterns.update_category_control_settings

Modify the Digit Pattern Category Control Settings for the entity

api.person_settings.permissions_out.transfer_numbers.configure

Modify Transfer Numbers Settings for a Place

api.person_settings.permissions_out.transfer_numbers.read

Retrieve Transfer Numbers Settings

api.person_settings.preferred_answer.modify

Modify Preferred Answer Endpoint

api.person_settings.preferred_answer.read

Get Preferred Answer Endpoint

api.person_settings.privacy.configure

Configure Call Waiting Settings for a Person

api.person_settings.privacy.read

Get a person’s Privacy Settings

api.person_settings.push_to_talk.configure

Configure Push-to-Talk Settings for a Person

api.person_settings.push_to_talk.read

Read Push-to-Talk Settings for a Person

api.person_settings.receptionist.configure

Modify Executive Assistant Settings for a Person

api.person_settings.receptionist.read

Read Receptionist Client Settings for a Person

api.person_settings.schedules.create

Create a Schedule

api.person_settings.schedules.delete_schedule

Delete a Schedule

api.person_settings.schedules.details

Get Details for a Schedule

api.person_settings.schedules.event_create

Create a Schedule Event

api.person_settings.schedules.event_delete

Delete a Schedule Event

api.person_settings.schedules.event_details

Get Details for a Schedule Event

api.person_settings.schedules.event_update

Update a Schedule Event

api.person_settings.schedules.list

List of Schedules for a Person or location

api.person_settings.schedules.update

Update a Schedule

api.person_settings.voicemail.configure

Configure Voicemail Settings for a Person

api.person_settings.voicemail.configure_busy_greeting

Configure Busy Voicemail Greeting for a Person

api.person_settings.voicemail.configure_no_answer_greeting

Configure No Answer Voicemail Greeting for a Person

api.person_settings.voicemail.modify_passcode

Modify a person’s voicemail passcode

api.person_settings.voicemail.read

Read Voicemail Settings for a Person

api.reports.create

Create a new report

api.reports.delete

Remove a report from the system

api.reports.details

Shows details for a report, by report ID

api.reports.download

Download a report from the given URL and yield the rows as dicts

api.reports.list

Lists all reports

api.reports.list_templates

List all the available report templates that can be generated

api.room_tabs.create_tab

Add a tab with a specified URL to a room

api.room_tabs.delete_tab

Deletes a Room Tab with the specified ID

api.room_tabs.list_tabs

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

api.room_tabs.tab_details

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

api.room_tabs.update_tab

Updates the content URL of the specified Room Tab ID

api.rooms.create

Creates a room

api.rooms.delete

Deletes a room, by ID

api.rooms.details

Shows details for a room, by ID

api.rooms.list

List rooms

api.rooms.meeting_details

Shows Webex meeting details for a room such as the SIP address, meeting URL, toll-free and toll dial-in numbers

api.rooms.update

Updates details for a room, by ID

api.scim.bulk.bulk_request

User bulk API

api.scim.users.create

Create a user

api.scim.users.delete

Delete a user

api.scim.users.details

Get a user

api.scim.users.patch

Update a user with PATCH

api.scim.users.search

Search users

api.scim.users.search_all

Same operation as search() but returns a generator of ScimUsers instead of paginated resources

api.scim.users.update

Update a user with PUT

api.status.active_scheduled_maintenances

Get a list of any active maintenances

api.status.all_incidents

Get a list of the 50 most recent incidents

api.status.all_scheduled_maintenances

Get a list of the 50 most recent scheduled maintenances

api.status.components

Get the components for the status page

api.status.status

Get the status rollup for the whole page

api.status.summary

Get a summary of the status page, including a status indicator, component statuses, unresolved incidents,

api.status.unresolved_incidents

Get a list of any unresolved incidents

api.status.upcoming_scheduled_maintenances

Scheduled maintenances are planned outages, upgrades, or general notices that you’re working on

api.team_memberships.create

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

api.team_memberships.delete

Deletes a team membership, by ID

api.team_memberships.details

Shows details for a team membership, by ID

api.team_memberships.list

Lists all team memberships for a given team, specified by the teamId query parameter

api.team_memberships.membership

Updates a team membership, by ID

api.teams.create

Creates a team

api.teams.delete

Deletes a team, by ID

api.teams.details

Shows details for a team, by ID

api.teams.list

Lists teams to which the authenticated user belongs

api.teams.update

Updates details for a team, by ID

api.telephony.device_settings

Get device override settings for an organization

api.telephony.phone_number_details

get summary (counts) of phone numbers

api.telephony.phone_numbers

Get Phone Numbers for an Organization with given criteria

api.telephony.read_list_of_announcement_languages

List all languages supported by Webex Calling for announcements and voice prompts

api.telephony.route_choices

List all Routes for the organization

api.telephony.supported_devices

Gets the list of supported devices for an organization location

api.telephony.test_call_routing

Validates that an incoming call can be routed

api.telephony.ucm_profiles

Read the List of UC Manager Profiles

api.telephony.validate_extensions

Validate the List of Extensions

api.telephony.validate_phone_numbers

Validate the list of phone numbers in an organization

api.telephony.access_codes.create

Create access code in location

api.telephony.access_codes.delete_all

Delete Outgoing Permission Location Access Codes

api.telephony.access_codes.delete_codes

Delete Access Code Location

api.telephony.access_codes.read

Get Location Access Code

api.telephony.announcements_repo.delete

Delete an announcement greeting

api.telephony.announcements_repo.details

Fetch details of a binary announcement greeting by its ID at an organization level

api.telephony.announcements_repo.list

Fetch a list of binary announcement greetings at an organization as well as location level

api.telephony.announcements_repo.modify

Modify an existing announcement greeting

api.telephony.announcements_repo.upload_announcement

Upload a binary file to the announcement repository at organization or location level

api.telephony.announcements_repo.usage

Retrieves repository usage for announcements for an organization

api.telephony.auto_attendant.by_name

Get auto attendant info by name

api.telephony.auto_attendant.create

Create an Auto Attendant

api.telephony.auto_attendant.delete_auto_attendant

elete the designated Auto Attendant

api.telephony.auto_attendant.details

Get Details for an Auto Attendant

api.telephony.auto_attendant.list

Read the List of Auto Attendants

api.telephony.auto_attendant.update

Update an Auto Attendant

api.telephony.call_intercept.configure

Put Location Intercept

api.telephony.call_intercept.read

Get Location Intercept

api.telephony.call_recording.read

Get Call Recording Settings

api.telephony.call_recording.read_location_compliance_announcement

Get Details for the location compliance announcement setting

api.telephony.call_recording.read_org_compliance_announcement

Get Details for the organization compliance announcement setting

api.telephony.call_recording.read_terms_of_service

Get Call Recording Terms Of Service Settings

api.telephony.call_recording.update

Update Call Recording Settings

api.telephony.call_recording.update_location_compliance_announcement

Update the location compliance announcement

api.telephony.call_recording.update_org_compliance_announcement

Update the organization compliance announcement

api.telephony.call_recording.update_terms_of_service

Update Call Recording Terms Of Service Settings

api.telephony.callpark.available_agents

Get available agents from Call Parks

api.telephony.callpark.available_recalls

Get available recall hunt groups from Call Parks

api.telephony.callpark.call_park_settings

Get Call Park Settings

api.telephony.callpark.create

Create a Call Park

api.telephony.callpark.delete_callpark

Delete a Call Park

api.telephony.callpark.details

Get Details for a Call Park

api.telephony.callpark.list

Read the List of Call Parks

api.telephony.callpark.update

Update a Call Park

api.telephony.callpark.update_call_park_settings

Update Call Park settings

api.telephony.callpark_extension.create

Create new Call Park Extensions for the given location

api.telephony.callpark_extension.delete

Delete the designated Call Park Extension

api.telephony.callpark_extension.details

Get Details for a Call Park Extension

api.telephony.callpark_extension.list

Read the List of Call Park Extensions

api.telephony.callpark_extension.update

Update the designated Call Park Extension

api.telephony.calls.answer

Answer an incoming call

api.telephony.calls.barge_in

Barge-in on another user’s answered call

api.telephony.calls.call_details

Get the details of the specified active call for the user

api.telephony.calls.call_history

List Call History

api.telephony.calls.dial

Initiate an outbound call to a specified destination

api.telephony.calls.divert

Divert a call to a destination or a user’s voicemail

api.telephony.calls.hangup

Hangup a call

api.telephony.calls.hold

Hold a connected call

api.telephony.calls.list_calls

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

api.telephony.calls.park

Park a connected call

api.telephony.calls.pause_recording

Pause recording on a call

api.telephony.calls.pickup

Picks up an incoming call to another user

api.telephony.calls.push

Pushes a call from the assistant to the executive the call is associated with

api.telephony.calls.reject

Reject an unanswered incoming call

api.telephony.calls.resume

Resume a held call

api.telephony.calls.resume_recording

Resume recording a call

api.telephony.calls.retrieve
param destination:

Identifies where the call is parked

api.telephony.calls.start_recording

Start recording a call

api.telephony.calls.stop_recording

Stop recording a call

api.telephony.calls.transfer

Transfer two calls together

api.telephony.calls.transmit_dtmf

Transmit DTMF digits to a call

api.telephony.dect_devices.add_a_handset

Add a Handset to a DECT Network

api.telephony.dect_devices.available_members

Search Available Members

api.telephony.dect_devices.base_station_details

Get the details of a specific DECT Network Base Station

api.telephony.dect_devices.create_base_stations

Create Multiple Base Stations

api.telephony.dect_devices.create_dect_network

Create a DECT Network

api.telephony.dect_devices.dect_network_details

Get DECT Network Details

api.telephony.dect_devices.dect_networks_associated_with_person

GET List of DECT networks associated with a Person

api.telephony.dect_devices.dect_networks_associated_with_virtual_line

Get List of Dect Networks Handsets for a Virtual Line

api.telephony.dect_devices.dect_networks_associated_with_workspace

GET List of DECT networks associated with a workspace

api.telephony.dect_devices.delete_base_station

Delete a specific DECT Network Base Station

api.telephony.dect_devices.delete_bulk_base_stations

Delete bulk DECT Network Base Stations

api.telephony.dect_devices.delete_dect_network

Delete DECT Network

api.telephony.dect_devices.delete_handset

Delete specific DECT Network Handset Details

api.telephony.dect_devices.delete_handsets

Delete multiple handsets

api.telephony.dect_devices.handset_details

Get Specific DECT Network Handset Details

api.telephony.dect_devices.list_base_stations

Get a list of DECT Network Base Stations

api.telephony.dect_devices.list_dect_networks

Get the List of DECT Networks for an organization

api.telephony.dect_devices.list_handsets

Get List of Handsets for a DECT Network ID

api.telephony.dect_devices.update_dect_network

Update DECT Network

api.telephony.dect_devices.update_dect_network_settings

Update DECT Network from settings

api.telephony.dect_devices.update_handset

Update DECT Network Handset

api.telephony.devices.apply_changes

Apply Changes for a specific device

api.telephony.devices.available_members

Search members that can be assigned to the device

api.telephony.devices.create_line_key_template

Create a Line Key Template

api.telephony.devices.dect_devices

Read the DECT device type list

api.telephony.devices.delete_line_key_template

Delete a Line Key Template

api.telephony.devices.details

Get Webex Calling Device Details

api.telephony.devices.device_settings

Get override settings for a device

api.telephony.devices.get_device_layout

Get Device Layout by Device ID

api.telephony.devices.get_person_device_settings

Get Device Settings for a Person

api.telephony.devices.get_workspace_device_settings

Get Device Settings for a Workspace

api.telephony.devices.line_key_template_details

Get details of a Line Key Template

api.telephony.devices.list_line_key_templates

Read the list of Line Key Templates

api.telephony.devices.members

Get Device Members

api.telephony.devices.modify_device_layout

Modify Device Layout by Device ID

api.telephony.devices.modify_line_key_template

Modify a Line Key Template

api.telephony.devices.preview_apply_line_key_template

Preview Apply Line Key Template

api.telephony.devices.update_device_settings

Modify override settings for a device

api.telephony.devices.update_members

Modify member details on the device

api.telephony.devices.update_person_device_settings

Update Device Settings for a Person

api.telephony.devices.update_workspace_device_settings

Update Device Settings for a Workspace

api.telephony.devices.validate_macs

Validate a list of MAC addresses

api.telephony.huntgroup.by_name

Get hunt group info by name

api.telephony.huntgroup.create

Create a Hunt Group

api.telephony.huntgroup.delete_huntgroup

Delete a Hunt Group

api.telephony.huntgroup.details

Get Details for a Hunt Group

api.telephony.huntgroup.list

Read the List of Hunt Groups

api.telephony.huntgroup.update

Update a Hunt Group

api.telephony.jobs.apply_line_key_templates.apply

Apply a Line key Template

api.telephony.jobs.apply_line_key_templates.errors

Get job errors for an Apply Line Key Template job

api.telephony.jobs.apply_line_key_templates.list

Get List of Apply Line Key Template jobs

api.telephony.jobs.apply_line_key_templates.status

Get the job status of an Apply Line Key Template job

api.telephony.jobs.device_settings.change

Change device settings across organization or locations jobs

api.telephony.jobs.device_settings.errors

List change device settings job errors

api.telephony.jobs.device_settings.list

List change device settings jobs

api.telephony.jobs.device_settings.status

Get change device settings job status

api.telephony.jobs.manage_numbers.abandon

Abandon the Manage Numbers Job

api.telephony.jobs.manage_numbers.errors

Lists all error details of Manage Numbers job

api.telephony.jobs.manage_numbers.initiate_job

Starts the numbers move from one location to another location

api.telephony.jobs.manage_numbers.list

Lists all Manage Numbers jobs for the given organization in order of most recent one to oldest one

api.telephony.jobs.manage_numbers.pause

Pause the running Manage Numbers Job

api.telephony.jobs.manage_numbers.resume

Resume the paused Manage Numbers Job

api.telephony.jobs.manage_numbers.status

Returns the status and other details of the job

api.telephony.jobs.rebuild_phones.errors

Get Job Errors for a Rebuild Phones Job

api.telephony.jobs.rebuild_phones.list

List Rebuild Phones Jobs

api.telephony.jobs.rebuild_phones.rebuild_phones_configuration

Rebuild Phones Configuration

api.telephony.jobs.rebuild_phones.status

Get the Job Status of a Rebuild Phones Job

api.telephony.location.change_announcement_language

Change Announcement Language

api.telephony.location.details

Shows Webex Calling details for a location, by ID

api.telephony.location.device_settings

Get device override settings for a location

api.telephony.location.enable_for_calling

Enable a location by adding it to Webex Calling

api.telephony.location.generate_password

Generates an example password using the effective password settings for the location

api.telephony.location.list

Lists Webex Calling locations for an organization with Webex Calling details

api.telephony.location.update

Update Webex Calling details for a location, by ID

api.telephony.location.validate_extensions

Validate extensions for a specific location

api.telephony.location.intercept.configure

Put Location Intercept

api.telephony.location.intercept.read

Get Location Intercept

api.telephony.location.internal_dialing.read

Get current configuration for routing unknown extensions to the Premises as internal calls

api.telephony.location.internal_dialing.update

Modify current configuration for routing unknown extensions to the Premises as internal calls

api.telephony.location.internal_dialing.url

api.telephony.location.moh.create
param location_id:

Add new access code for this location

api.telephony.location.moh.delete_codes

Delete Access Code Location

api.telephony.location.moh.read

Get Music On Hold

api.telephony.location.moh.update

Get Music On Hold

api.telephony.location.number.activate

Activate the specified set of phone numbers in a location for an organization

api.telephony.location.number.add

Adds a specified set of phone numbers to a location for an organization

api.telephony.location.number.remove

Remove the specified set of phone numbers from a location for an organization

api.telephony.location.receptionist_contacts_directory.create

Creates a new Receptionist Contact Directory for a location

api.telephony.location.receptionist_contacts_directory.delete

Delete a Receptionist Contact Directory from a location

api.telephony.location.receptionist_contacts_directory.list

List all Receptionist Contact Directories for a location

api.telephony.location.voicemail.read

Get Location Voicemail

api.telephony.location.voicemail.update

Get Location Voicemail

api.telephony.locations.change_announcement_language

Change Announcement Language

api.telephony.locations.details

Shows Webex Calling details for a location, by ID

api.telephony.locations.device_settings

Get device override settings for a location

api.telephony.locations.enable_for_calling

Enable a location by adding it to Webex Calling

api.telephony.locations.generate_password

Generates an example password using the effective password settings for the location

api.telephony.locations.list

Lists Webex Calling locations for an organization with Webex Calling details

api.telephony.locations.update

Update Webex Calling details for a location, by ID

api.telephony.locations.validate_extensions

Validate extensions for a specific location

api.telephony.locations.intercept.configure

Put Location Intercept

api.telephony.locations.intercept.read

Get Location Intercept

api.telephony.locations.internal_dialing.read

Get current configuration for routing unknown extensions to the Premises as internal calls

api.telephony.locations.internal_dialing.update

Modify current configuration for routing unknown extensions to the Premises as internal calls

api.telephony.locations.internal_dialing.url

api.telephony.locations.moh.create
param location_id:

Add new access code for this location

api.telephony.locations.moh.delete_codes

Delete Access Code Location

api.telephony.locations.moh.read

Get Music On Hold

api.telephony.locations.moh.update

Get Music On Hold

api.telephony.locations.number.activate

Activate the specified set of phone numbers in a location for an organization

api.telephony.locations.number.add

Adds a specified set of phone numbers to a location for an organization

api.telephony.locations.number.remove

Remove the specified set of phone numbers from a location for an organization

api.telephony.locations.receptionist_contacts_directory.create

Creates a new Receptionist Contact Directory for a location

api.telephony.locations.receptionist_contacts_directory.delete

Delete a Receptionist Contact Directory from a location

api.telephony.locations.receptionist_contacts_directory.list

List all Receptionist Contact Directories for a location

api.telephony.locations.voicemail.read

Get Location Voicemail

api.telephony.locations.voicemail.update

Get Location Voicemail

api.telephony.organisation_voicemail.read

Get Voicemail Settings

api.telephony.organisation_voicemail.update

Update the organization’s voicemail settings

api.telephony.paging.create

Create a new Paging Group

api.telephony.paging.delete_paging

Delete a Paging Group

api.telephony.paging.details

Get Details for a Paging Group

api.telephony.paging.list

Read the List of Paging Groups

api.telephony.paging.update

Update the designated Paging Group

api.telephony.permissions_out.configure

Configure Outgoing Calling Permissions Settings

api.telephony.permissions_out.read

Retrieve Outgoing Calling Permissions Settings

api.telephony.permissions_out.digit_patterns.create

Create Digit Patterns

api.telephony.permissions_out.digit_patterns.delete

Delete a Digit Pattern

api.telephony.permissions_out.digit_patterns.delete_all

Delete all Digit Patterns

api.telephony.permissions_out.digit_patterns.details

Retrieve Digit Pattern Details

api.telephony.permissions_out.digit_patterns.get_digit_patterns

Retrieve Digit Patterns

api.telephony.permissions_out.digit_patterns.update

Modify Digit Patterns

api.telephony.permissions_out.digit_patterns.update_category_control_settings

Modify the Digit Pattern Category Control Settings for the entity

api.telephony.permissions_out.transfer_numbers.configure

Modify Transfer Numbers Settings for a Place

api.telephony.permissions_out.transfer_numbers.read

Retrieve Transfer Numbers Settings

api.telephony.pickup.available_agents

Get available agents from Call Pickups

api.telephony.pickup.create

Create a Call Pickup

api.telephony.pickup.delete_pickup

Delete a Call Pickup

api.telephony.pickup.details

Get Details for a Call Pickup

api.telephony.pickup.list

Read the List of Call Pickups

api.telephony.pickup.update

Update a Call Pickup

api.telephony.pnc.read

Get Private Network Connect

api.telephony.pnc.update

Get Private Network Connect

api.telephony.prem_pstn.validate_pattern

Validate a Dial Pattern

api.telephony.prem_pstn.dial_plan.create

Create a Dial Plan for the organization

api.telephony.prem_pstn.dial_plan.delete_all_patterns

Delete all dial patterns from the Dial Plan

api.telephony.prem_pstn.dial_plan.delete_dial_plan

Delete a Dial Plan for the organization

api.telephony.prem_pstn.dial_plan.details

Get a Dial Plan for the organization

api.telephony.prem_pstn.dial_plan.list

List all Dial Plans for the organization

api.telephony.prem_pstn.dial_plan.modify_patterns

Modify dial patterns for the Dial Plan

api.telephony.prem_pstn.dial_plan.patterns

List all Dial Patterns for the organization

api.telephony.prem_pstn.dial_plan.update

Modify a Dial Plan for the organization

api.telephony.prem_pstn.route_group.create

Creates a Route Group for the organization

api.telephony.prem_pstn.route_group.delete_route_group

Remove a Route Group from an Organization based on id

api.telephony.prem_pstn.route_group.details

Reads a Route Group for the organization based on id

api.telephony.prem_pstn.route_group.list

List all Route Groups for an organization

api.telephony.prem_pstn.route_group.update

Modifies an existing Route Group for an organization based on id

api.telephony.prem_pstn.route_group.usage

List the number of “Call to” on-premises Extensions, Dial Plans, PSTN Connections, and Route Lists used by a

api.telephony.prem_pstn.route_group.usage_call_to_extension

List “Call to” on-premises Extension Locations for a specific route group

api.telephony.prem_pstn.route_group.usage_dial_plan

List Dial Plan Locations for a specific route group

api.telephony.prem_pstn.route_group.usage_location_pstn

List PSTN Connection Locations for a specific route group

api.telephony.prem_pstn.route_group.usage_route_lists

List Route Lists for a specific route group

api.telephony.prem_pstn.route_list.create

Create a Route List for the organization

api.telephony.prem_pstn.route_list.delete_all_numbers

api.telephony.prem_pstn.route_list.delete_route_list

Delete Route List for a Customer

api.telephony.prem_pstn.route_list.details

Get Route List Details

api.telephony.prem_pstn.route_list.list

List all Route Lists for the organization

api.telephony.prem_pstn.route_list.numbers

Get numbers assigned to a Route List

api.telephony.prem_pstn.route_list.update

Modify the details for a Route List

api.telephony.prem_pstn.route_list.update_numbers

Modify numbers for a specific Route List of a Customer

api.telephony.prem_pstn.trunk.create

Create a Trunk for the organization

api.telephony.prem_pstn.trunk.delete_trunk

Delete a Trunk for the organization

api.telephony.prem_pstn.trunk.details

Get a Trunk for the organization

api.telephony.prem_pstn.trunk.list

List all Trunks for the organization

api.telephony.prem_pstn.trunk.trunk_types

List all TrunkTypes with DeviceTypes for the organization

api.telephony.prem_pstn.trunk.update

Modify a Trunk for the organization

api.telephony.prem_pstn.trunk.usage

Get Local Gateway Usage Count

api.telephony.prem_pstn.trunk.usage_call_to_extension

Get local gateway call to on-premises extension usage for a trunk

api.telephony.prem_pstn.trunk.usage_dial_plan

Get Local Gateway Dial Plan Usage for a Trunk

api.telephony.prem_pstn.trunk.usage_location_pstn

Get Local Gateway Dial Plan Usage for a Trunk

api.telephony.prem_pstn.trunk.usage_route_group

Get Local Gateway Dial Plan Usage for a Trunk

api.telephony.prem_pstn.trunk.validate_fqdn_and_domain

Validate Local Gateway FQDN and Domain for the organization trunks

api.telephony.schedules.create

Create a Schedule

api.telephony.schedules.delete_schedule

Delete a Schedule

api.telephony.schedules.details

Get Details for a Schedule

api.telephony.schedules.event_create

Create a Schedule Event

api.telephony.schedules.event_delete

Delete a Schedule Event

api.telephony.schedules.event_details

Get Details for a Schedule Event

api.telephony.schedules.event_update

Update a Schedule Event

api.telephony.schedules.list

List of Schedules for a Person or location

api.telephony.schedules.update

Update a Schedule

api.telephony.virtual_lines.assigned_devices

Get List of Devices assigned for a Virtual Line

api.telephony.virtual_lines.create

Create a Virtual Line

api.telephony.virtual_lines.dect_networks

Get List of Dect Networks Handsets for a Virtual Line

api.telephony.virtual_lines.delete

Delete a Virtual Line

api.telephony.virtual_lines.details

Get Details for a Virtual Line

api.telephony.virtual_lines.get_phone_number

Get Phone Number assigned for a Virtual Line

api.telephony.virtual_lines.list

List all Virtual Lines for the organization

api.telephony.virtual_lines.update

Update a Virtual Line

api.telephony.virtual_lines.update_directory_search

Update Directory search for a Virtual Line

api.telephony.virtual_lines.call_bridge.configure

Configure Call Bridge Settings

api.telephony.virtual_lines.call_bridge.read

Read Call Bridge Settings

api.telephony.virtual_lines.call_intercept.configure

Configure Call Intercept Settings

api.telephony.virtual_lines.call_intercept.greeting

Configure Call Intercept Greeting

api.telephony.virtual_lines.call_intercept.read

Read Call Intercept Settings

api.telephony.virtual_lines.call_recording.configure

Configure Call Recording Settings for a entity

api.telephony.virtual_lines.call_recording.read

Read Call Recording Settings

api.telephony.virtual_lines.call_waiting.configure

Configure Call Waiting Settings

api.telephony.virtual_lines.call_waiting.read

Read Call Waiting Settings for

api.telephony.virtual_lines.caller_id.configure

Configure a Caller ID Settings

api.telephony.virtual_lines.caller_id.configure_settings

Configure a Caller ID Settings

api.telephony.virtual_lines.caller_id.read

Retrieve Caller ID Settings

api.telephony.virtual_lines.forwarding.configure

Configure an Entity’s Call Forwarding Settings

api.telephony.virtual_lines.forwarding.read

Retrieve an entity’s Call Forwarding Settings

api.telephony.virtual_lines.permissions_in.configure

Configure incoming permissions settings

api.telephony.virtual_lines.permissions_in.read

Read Incoming Permission Settings

api.telephony.virtual_lines.permissions_out.configure

Configure Outgoing Calling Permissions Settings

api.telephony.virtual_lines.permissions_out.read

Retrieve Outgoing Calling Permissions Settings

api.telephony.virtual_lines.permissions_out.access_codes.create

Create new Access codes

api.telephony.virtual_lines.permissions_out.access_codes.delete

Delete Access Code

api.telephony.virtual_lines.permissions_out.access_codes.modify

Modify Access Codes

api.telephony.virtual_lines.permissions_out.access_codes.read

Retrieve Access codes

api.telephony.virtual_lines.permissions_out.digit_patterns.create

Create Digit Patterns

api.telephony.virtual_lines.permissions_out.digit_patterns.delete

Delete a Digit Pattern

api.telephony.virtual_lines.permissions_out.digit_patterns.delete_all

Delete all Digit Patterns

api.telephony.virtual_lines.permissions_out.digit_patterns.details

Retrieve Digit Pattern Details

api.telephony.virtual_lines.permissions_out.digit_patterns.get_digit_patterns

Retrieve Digit Patterns

api.telephony.virtual_lines.permissions_out.digit_patterns.update

Modify Digit Patterns

api.telephony.virtual_lines.permissions_out.digit_patterns.update_category_control_settings

Modify the Digit Pattern Category Control Settings for the entity

api.telephony.virtual_lines.permissions_out.transfer_numbers.configure

Modify Transfer Numbers Settings for a Place

api.telephony.virtual_lines.permissions_out.transfer_numbers.read

Retrieve Transfer Numbers Settings

api.telephony.voice_messaging.delete

Delete a specfic voicemail message for the user

api.telephony.voice_messaging.list

Get the list of all voicemail messages for the user

api.telephony.voice_messaging.mark_as_read

Update the voicemail message(s) as read for the user

api.telephony.voice_messaging.mark_as_unread

Update the voicemail message(s) as unread for the user

api.telephony.voice_messaging.summary

Get a summary of the voicemail messages for the user

api.telephony.voicemail_groups.create

Create new voicemail group for the given location for a customer

api.telephony.voicemail_groups.delete

Delete the designated voicemail group

api.telephony.voicemail_groups.details

Retrieve voicemail group details for a location

api.telephony.voicemail_groups.list

List the voicemail group information for the organization

api.telephony.voicemail_groups.update

Modifies the voicemail group location details for a particular location for a customer

api.telephony.voicemail_rules.read

Get Voicemail Rules

api.telephony.voicemail_rules.update

Update Voicemail Rules

api.telephony.voiceportal.passcode_rules

Get VoicePortal Passcode Rule

api.telephony.voiceportal.read
param location_id:

Location to which the voice portal belongs

api.telephony.voiceportal.update

Update VoicePortal

api.webhook.create

Creates a webhook

api.webhook.details

Get Webhook Details

api.webhook.list

List all of your webhooks

api.webhook.update

Updates a webhook, by ID

api.webhook.webhook_delete

Deletes a webhook, by ID

api.workspace_locations.create

Create a location

api.workspace_locations.delete

Delete a Workspace Location

api.workspace_locations.details

Get a Workspace Location Details

api.workspace_locations.list

List workspace locations

api.workspace_locations.update

Update a Workspace Location

api.workspace_locations.floors.create

Create a Workspace Location Floor

api.workspace_locations.floors.delete

Delete a Workspace Location Floor

api.workspace_locations.floors.details

Get a Workspace Location Floor Details

api.workspace_locations.floors.list
param location_id:

api.workspace_locations.floors.update

Updates details for a floor, by ID

api.workspace_personalization.get_personalization_task

Get Personalization Task

api.workspace_personalization.personalize_a_workspace

Personalize a Workspace

api.workspace_settings.call_bridge.configure

Configure Call Bridge Settings

api.workspace_settings.call_bridge.read

Read Call Bridge Settings

api.workspace_settings.call_intercept.configure

Configure Call Intercept Settings

api.workspace_settings.call_intercept.greeting

Configure Call Intercept Greeting

api.workspace_settings.call_intercept.read

Read Call Intercept Settings

api.workspace_settings.call_waiting.configure

Configure Call Waiting Settings

api.workspace_settings.call_waiting.read

Read Call Waiting Settings for

api.workspace_settings.caller_id.configure

Configure a Caller ID Settings

api.workspace_settings.caller_id.configure_settings

Configure a Caller ID Settings

api.workspace_settings.caller_id.read

Retrieve Caller ID Settings

api.workspace_settings.devices.list

Get all devices for a workspace

api.workspace_settings.devices.modify_hoteling

Modify devices for a workspace

api.workspace_settings.forwarding.configure

Configure an Entity’s Call Forwarding Settings

api.workspace_settings.forwarding.read

Retrieve an entity’s Call Forwarding Settings

api.workspace_settings.monitoring.configure

Configure Call Waiting Settings for a Person

api.workspace_settings.monitoring.read

Retrieve a Person’s Monitoring Settings

api.workspace_settings.numbers.read

List the PSTN phone numbers associated with a specific workspace, by ID, within the organization

api.workspace_settings.permissions_in.configure

Configure incoming permissions settings

api.workspace_settings.permissions_in.read

Read Incoming Permission Settings

api.workspace_settings.permissions_out.configure

Configure Outgoing Calling Permissions Settings

api.workspace_settings.permissions_out.read

Retrieve Outgoing Calling Permissions Settings

api.workspace_settings.permissions_out.access_codes.create

Create new Access codes

api.workspace_settings.permissions_out.access_codes.delete

Delete Access Code

api.workspace_settings.permissions_out.access_codes.modify

Modify Access Codes

api.workspace_settings.permissions_out.access_codes.read

Retrieve Access codes

api.workspace_settings.permissions_out.digit_patterns.create

Create Digit Patterns

api.workspace_settings.permissions_out.digit_patterns.delete

Delete a Digit Pattern

api.workspace_settings.permissions_out.digit_patterns.delete_all

Delete all Digit Patterns

api.workspace_settings.permissions_out.digit_patterns.details

Retrieve Digit Pattern Details

api.workspace_settings.permissions_out.digit_patterns.get_digit_patterns

Retrieve Digit Patterns

api.workspace_settings.permissions_out.digit_patterns.update

Modify Digit Patterns

api.workspace_settings.permissions_out.digit_patterns.update_category_control_settings

Modify the Digit Pattern Category Control Settings for the entity

api.workspace_settings.permissions_out.transfer_numbers.configure

Modify Transfer Numbers Settings for a Place

api.workspace_settings.permissions_out.transfer_numbers.read

Retrieve Transfer Numbers Settings

api.workspaces.capabilities

Shows the capabilities for a workspace by ID

api.workspaces.create

Create a Workspace

api.workspaces.delete_workspace

Delete a Workspace

api.workspaces.details

Get Workspace Details

api.workspaces.list

List Workspaces

api.workspaces.update

Updates details for a workspace by ID