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 second column of the table has a link to the documentation of the method.

Method

Documentation

api.close

close()

api.attachment_actions.details

Shows details for a attachment action, by ID

details()

api.authorizations.delete

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

delete()

api.authorizations.list

Lists all authorizations for a user

list()

api.cdr.get_cdr_history

Provides Webex Calling Detailed Call History data for your organization

get_cdr_history()

api.device_configurations.list

Lists all device configurations associated with the given device ID

list()

api.device_configurations.update

Update Device Configurations

update()

api.devices.activation_code

Create a Device Activation Code

activation_code()

api.devices.create_by_mac_address

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

create_by_mac_address()

api.devices.delete

Delete a Device

delete()

api.devices.details

Get Device Details

details()

api.devices.list

List Devices

list()

api.devices.modify_device_tags

Modify Device Tags

modify_device_tags()

api.devices.settings_jobs.change

Change device settings across organization or locations jobs

change()

api.devices.settings_jobs.get_status

Get change device settings job status

get_status()

api.devices.settings_jobs.job_errors

List change device settings job errors

job_errors()

api.devices.settings_jobs.list

List change device settings jobs

list()

api.events.details

Shows details for an event, by event ID

details()

api.events.list

List events in your organization

list()

api.groups.create

Create a new group using the provided settings

create()

api.groups.delete_group

Delete a group

delete_group()

api.groups.details

Get group details

details()

api.groups.list

List groups in your organization

list()

api.groups.members

Query members of a group

members()

api.groups.update

update group information

update()

api.licenses.assign_licenses_to_users

Assign Licenses to Users

assign_licenses_to_users()

api.licenses.assigned_users

Get users license is assigned to, by license ID

assigned_users()

api.licenses.details

Shows details for a license, by ID

details()

api.licenses.list

List all licenses for a given organization

list()

api.locations.by_name

Get a location by name

by_name()

api.locations.create

Create a new Location for a given organization

create()

api.locations.create_floor

Create a Location Floor

create_floor()

api.locations.delete_floor

Delete a Location Floor

delete_floor()

api.locations.details

Shows details for a location, by ID

details()

api.locations.floor_details

Get Location Floor Details

floor_details()

api.locations.list

List locations for an organization

list()

api.locations.list_floors

List Location Floors

list_floors()

api.locations.update

Update details for a location, by ID

update()

api.locations.update_floor

Update a Location Floor

update_floor()

api.meetings.create

Creates a new meeting

create()

api.meetings.delete

Deletes a meeting with a specified meeting ID

delete()

api.meetings.get

Retrieves details for a meeting with a specified meeting ID

get()

api.meetings.join

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

join()

api.meetings.list

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

list()

api.meetings.list_of_series

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

list_of_series()

api.meetings.list_survey_results

Retrieves results for a meeting survey identified by meetingId

list_survey_results()

api.meetings.list_tracking_codes

Lists tracking codes on a site by a meeting host

list_tracking_codes()

api.meetings.patch

Updates details for a meeting with a specified meeting ID

patch()

api.meetings.survey

Retrieves details for a meeting survey identified by meetingId

survey()

api.meetings.update

Updates details for a meeting with a specified meeting ID

update()

api.meetings.update_simultaneous_interpretation

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

update_simultaneous_interpretation()

api.meetings.chats.delete

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

delete()

api.meetings.chats.list

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

list()

api.meetings.closed_captions.download_snippets

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

download_snippets()

api.meetings.closed_captions.list

Lists closed captions of a finished meeting instance specified by meetingId

list()

api.meetings.closed_captions.list_snippets

Lists snippets of a meeting closed caption specified by closedCaptionId

list_snippets()

api.meetings.invitees.create_invitee

Invite a person to attend a meeting

create_invitee()

api.meetings.invitees.create_invitees

Invite people to attend a meeting in bulk

create_invitees()

api.meetings.invitees.delete

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

delete()

api.meetings.invitees.invitee_details

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

invitee_details()

api.meetings.invitees.list

Lists meeting invitees for a meeting with a specified meetingId

list()

api.meetings.invitees.update

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

update()

api.meetings.participants.admit_participants

To admit participants into a live meeting in bulk

admit_participants()

api.meetings.participants.list_participants

List all participants in a live or post meeting

list_participants()

api.meetings.participants.participant_details

Get a meeting participant details of a live or post meeting

participant_details()

api.meetings.participants.query_participants_with_email

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

query_participants_with_email()

api.meetings.participants.update_participant

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

update_participant()

api.meetings.preferences.audio_options

Retrieves audio options for the authenticated user

audio_options()

api.meetings.preferences.details

Retrieves meeting preferences for the authenticated user

details()

api.meetings.preferences.personal_meeting_room_options

Retrieves the Personal Meeting Room options for the authenticated user

personal_meeting_room_options()

api.meetings.preferences.scheduling_options

Retrieves scheduling options for the authenticated user

scheduling_options()

api.meetings.preferences.site_list

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

site_list()

api.meetings.preferences.update_audio_options

Updates audio options for the authenticated user

update_audio_options()

api.meetings.preferences.update_default_site

Updates the default site for the authenticated user

update_default_site()

api.meetings.preferences.update_personal_meeting_room_options

Update a single meeting

update_personal_meeting_room_options()

api.meetings.preferences.update_scheduling_options

Updates scheduling options for the authenticated user

update_scheduling_options()

api.meetings.preferences.update_video_options

Updates video options for the authenticated user

update_video_options()

api.meetings.preferences.video_options

Retrieves video options for the authenticated user

video_options()

api.meetings.qanda.list

Lists questions and answers from a meeting, when ready

list()

api.meetings.qanda.list_answers

Lists the answers to a specific question asked in a meeting

list_answers()

api.meetings.qualities.meeting_qualities

Get quality data for a meeting, by meetingId

meeting_qualities()

api.meetings.recordings.delete_a_recording

Delete a Recording

delete_a_recording()

api.meetings.recordings.get_recording_details

Get Recording Details

get_recording_details()

api.meetings.recordings.list_recordings

List Recordings

list_recordings()

api.meetings.recordings.list_recordings_for_an_admin_or_compliance_officer

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

move_recordings_into_the_recycle_bin()

api.meetings.recordings.purge_recordings_from_recycle_bin

Purge Recordings from Recycle Bin

purge_recordings_from_recycle_bin()

api.meetings.recordings.restore_recordings_from_recycle_bin

Restore Recordings from Recycle Bin

restore_recordings_from_recycle_bin()

api.meetings.transcripts.delete

Removes a transcript with a specified transcript ID

delete()

api.meetings.transcripts.download

Download a meeting transcript from the meeting transcript specified by transcriptId

download()

api.meetings.transcripts.list

Lists available transcripts of an ended meeting instance

list()

api.meetings.transcripts.list_compliance_officer

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

list_compliance_officer()

api.meetings.transcripts.list_snippets

Lists snippets of a meeting transcript specified by transcriptId

list_snippets()

api.meetings.transcripts.snippet_detail

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

snippet_detail()

api.meetings.transcripts.update_snippet

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

update_snippet()

api.membership.create

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

create()

api.membership.delete

Deletes a membership by ID

delete()

api.membership.details

Get details for a membership by ID

details()

api.membership.list

Lists all room memberships

list()

api.membership.update

Updates properties for a membership by ID

update()

api.messages.create

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

create()

api.messages.delete

Delete a message, by message ID

delete()

api.messages.details

Show details for a message, by message ID

details()

api.messages.edit

Update a message you have posted not more than 10 times

edit()

api.messages.list

Lists all messages in a room

list()

api.messages.list_direct

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

list_direct()

api.organizations.delete

Delete Organization

delete()

api.organizations.details

Get Organization Details

details()

api.organizations.list

List all organizations visible by your account

list()

api.people.create

Create a Person

create()

api.people.delete_person

Remove a person from the system

delete_person()

api.people.details

Shows details for a person, by ID

details()

api.people.list

List people in your organization

list()

api.people.me

Show the profile for the authenticated user

me()

api.people.update

Update details for a person, by ID

update()

api.person_settings.devices

Get all devices for a person

devices()

api.person_settings.reset_vm_pin

Reset Voicemail PIN

reset_vm_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

available_queues()

api.person_settings.agent_caller_id.ep
meta private:

ep()

api.person_settings.agent_caller_id.read

Retrieve a call queue agent’s Caller ID information

read()

api.person_settings.agent_caller_id.update

Modify a call queue agent’s Caller ID information

update()

api.person_settings.appservices.configure

Modify a Person’s Application Services Settings

configure()

api.person_settings.appservices.read

Retrieve a Person’s Application Services Settings

read()

api.person_settings.barge.configure

Configure a Person’s Barge In Settings

configure()

api.person_settings.barge.read

Retrieve a Person’s Barge In Settings

read()

api.person_settings.call_intercept.configure

Configure Call Intercept Settings for a Person

configure()

api.person_settings.call_intercept.greeting

Configure Call Intercept Greeting for a Person

greeting()

api.person_settings.call_intercept.read

Read Call Intercept Settings for a Person

read()

api.person_settings.call_recording.configure

Configure Call Recording Settings for a Person

configure()

api.person_settings.call_recording.read

Read Call Recording Settings for a Person

read()

api.person_settings.call_waiting.configure

Configure Call Waiting Settings for a Person

configure()

api.person_settings.call_waiting.read

Read Call Waiting Settings for a Person

read()

api.person_settings.caller_id.configure

Configure a Person’s Caller ID Settings

configure()

api.person_settings.caller_id.configure_settings

configure_settings()

api.person_settings.caller_id.read

Retrieve a Person’s Caller ID Settings

read()

api.person_settings.calling_behavior.configure

Configure a Person’s Calling Behavior

configure()

api.person_settings.calling_behavior.read

Read Person’s Calling Behavior

read()

api.person_settings.dnd.configure

Configure Do Not Disturb Settings for a Person

configure()

api.person_settings.dnd.read

Read Do Not Disturb Settings for a Person

read()

api.person_settings.exec_assistant.configure

Modify Executive Assistant Settings for a Person

configure()

api.person_settings.exec_assistant.read

Retrieve Executive Assistant Settings for a Person

read()

api.person_settings.forwarding.configure

Configure a Person’s Call Forwarding Settings

configure()

api.person_settings.forwarding.read

Retrieve a Person’s Call Forwarding Settings

read()

api.person_settings.hoteling.configure

Configure Hoteling Settings for a Person

configure()

api.person_settings.hoteling.read

Read Hoteling Settings for a Person

read()

api.person_settings.monitoring.configure

Configure Call Waiting Settings for a Person

configure()

api.person_settings.monitoring.read

Retrieve a Person’s Monitoring Settings

read()

api.person_settings.numbers.read

Get a person’s phone numbers including alternate numbers

read()

api.person_settings.numbers.update

Assign or unassign alternate phone numbers to a person

update()

api.person_settings.permissions_in.configure

Configure a Person’s Barge In Settings

configure()

api.person_settings.permissions_in.read

Read Incoming Permission Settings for a Person

read()

api.person_settings.permissions_out.configure

Configure a Person’s Outgoing Calling Permissions Settings

configure()

api.person_settings.permissions_out.read

Retrieve a Person’s Outgoing Calling Permissions Settings

read()

api.person_settings.preferred_answer.ep
meta private:

ep()

api.person_settings.preferred_answer.modify

Modify Preferred Answer Endpoint

modify()

api.person_settings.preferred_answer.read

Get Preferred Answer Endpoint

read()

api.person_settings.privacy.configure

Configure Call Waiting Settings for a Person

configure()

api.person_settings.privacy.read

Get a person’s Privacy Settings

read()

api.person_settings.push_to_talk.configure

Configure Push-to-Talk Settings for a Person

configure()

api.person_settings.push_to_talk.read

Read Push-to-Talk Settings for a Person

read()

api.person_settings.receptionist.configure

Modify Executive Assistant Settings for a Person

configure()

api.person_settings.receptionist.read

Read Receptionist Client Settings for a Person

read()

api.person_settings.schedules.create

Create a Schedule

create()

api.person_settings.schedules.delete_schedule

Delete a Schedule

delete_schedule()

api.person_settings.schedules.details

Get Details for a Schedule

details()

api.person_settings.schedules.event_create

Create a Schedule Event

event_create()

api.person_settings.schedules.event_delete

Delete a Schedule Event

event_delete()

api.person_settings.schedules.event_details

Get Details for a Schedule Event

event_details()

api.person_settings.schedules.event_update

Update a Schedule Event

event_update()

api.person_settings.schedules.list

List of Schedules for a Person or location

list()

api.person_settings.schedules.update

Update a Schedule

update()

api.person_settings.voicemail.configure

Configure Voicemail Settings for a Person

configure()

api.person_settings.voicemail.configure_busy_greeting

Configure Busy Voicemail Greeting for a Person

configure_busy_greeting()

api.person_settings.voicemail.configure_no_answer_greeting

Configure No Answer Voicemail Greeting for a Person

configure_no_answer_greeting()

api.person_settings.voicemail.read

Read Voicemail Settings for a Person

read()

api.reports.create

Create a new report

create()

api.reports.delete

Remove a report from the system

delete()

api.reports.details

Shows details for a report, by report ID

details()

api.reports.download

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

download()

api.reports.list

Lists all reports

list()

api.reports.list_templates

List all the available report templates that can be generated

list_templates()

api.room_tabs.create_tab

Add a tab with a specified URL to a room

create_tab()

api.room_tabs.delete_tab

Deletes a Room Tab with the specified ID

delete_tab()

api.room_tabs.list_tabs

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

list_tabs()

api.room_tabs.tab_details

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

tab_details()

api.room_tabs.update_tab

Updates the content URL of the specified Room Tab ID

update_tab()

api.rooms.create

Creates a room

create()

api.rooms.delete

Deletes a room, by ID

delete()

api.rooms.details

Shows details for a room, by ID

details()

api.rooms.list

List rooms

list()

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

meeting_details()

api.rooms.update

Updates details for a room, by ID

update()

api.team_memberships.create

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

create()

api.team_memberships.delete

Deletes a team membership, by ID

delete()

api.team_memberships.details

Shows details for a team membership, by ID

details()

api.team_memberships.list

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

list()

api.team_memberships.membership

Updates a team membership, by ID

membership()

api.teams.create

Creates a team

create()

api.teams.delete

Deletes a team, by ID

delete()

api.teams.details

Shows details for a team, by ID

details()

api.teams.list

Lists teams to which the authenticated user belongs

list()

api.teams.update

Updates details for a team, by ID

update()

api.telephony.device_settings

Get device override settings for an organization

device_settings()

api.telephony.phone_number_details

get summary (counts) of phone numbers

phone_number_details()

api.telephony.phone_numbers

Get Phone Numbers for an Organization with given criteria

phone_numbers()

api.telephony.read_list_of_announcement_languages

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

read_list_of_announcement_languages()

api.telephony.route_choices

List all Routes for the organization

route_choices()

api.telephony.supported_devices

Gets the list of supported devices for an organization location

supported_devices()

api.telephony.test_call_routing

Validates that an incoming call can be routed

test_call_routing()

api.telephony.ucm_profiles

Read the List of UC Manager Profiles

ucm_profiles()

api.telephony.validate_extensions

Validate the List of Extensions

validate_extensions()

api.telephony.validate_phone_numbers

Validate the list of phone numbers in an organization

validate_phone_numbers()

api.telephony.access_codes.create

Create access code in location

create()

api.telephony.access_codes.delete_codes

Delete Access Code Location

delete_codes()

api.telephony.access_codes.read

Get Location Access Code

read()

api.telephony.announcements_repo.delete

Delete an announcement greeting

delete()

api.telephony.announcements_repo.details

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

details()

api.telephony.announcements_repo.list

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

list()

api.telephony.announcements_repo.modify

Modify an existing announcement greeting

modify()

api.telephony.announcements_repo.upload_announcement

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

upload_announcement()

api.telephony.announcements_repo.usage

Retrieves repository usage for announcements for an organization

usage()

api.telephony.auto_attendant.by_name

Get auto attendant info by name

by_name()

api.telephony.auto_attendant.create

Create an Auto Attendant

create()

api.telephony.auto_attendant.delete_auto_attendant

elete the designated Auto Attendant

delete_auto_attendant()

api.telephony.auto_attendant.details

Get Details for an Auto Attendant

details()

api.telephony.auto_attendant.list

Read the List of Auto Attendants

list()

api.telephony.auto_attendant.update

Update an Auto Attendant

update()

api.telephony.call_intercept.configure

Put Location Intercept

configure()

api.telephony.call_intercept.read

Get Location Intercept

read()

api.telephony.callpark.available_agents

Get available agents from Call Parks

available_agents()

api.telephony.callpark.available_recalls

Get available recall hunt groups from Call Parks

available_recalls()

api.telephony.callpark.call_park_settings

Get Call Park Settings

call_park_settings()

api.telephony.callpark.create

Create a Call Park

create()

api.telephony.callpark.delete_callpark

Delete a Call Park

delete_callpark()

api.telephony.callpark.details

Get Details for a Call Park

details()

api.telephony.callpark.list

Read the List of Call Parks

list()

api.telephony.callpark.update

Update a Call Park

update()

api.telephony.callpark.update_call_park_settings

Update Call Park settings

update_call_park_settings()

api.telephony.callpark_extension.create

Create new Call Park Extensions for the given location

create()

api.telephony.callpark_extension.delete

Delete the designated Call Park Extension

delete()

api.telephony.callpark_extension.details

Get Details for a Call Park Extension

details()

api.telephony.callpark_extension.list

Read the List of Call Park Extensions

list()

api.telephony.callpark_extension.update

Update the designated Call Park Extension

update()

api.telephony.calls.answer

Answer an incoming call

answer()

api.telephony.calls.barge_in

Barge-in on another user’s answered call

barge_in()

api.telephony.calls.call_details

Get the details of the specified active call for the user

call_details()

api.telephony.calls.call_history

List Call History

call_history()

api.telephony.calls.dial

Initiate an outbound call to a specified destination

dial()

api.telephony.calls.divert

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

divert()

api.telephony.calls.hangup

Hangup a call

hangup()

api.telephony.calls.hold

Hold a connected call

hold()

api.telephony.calls.list_calls

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

list_calls()

api.telephony.calls.park

Park a connected call

park()

api.telephony.calls.pause_recording

Pause recording on a call

pause_recording()

api.telephony.calls.pickup

Picks up an incoming call to another user

pickup()

api.telephony.calls.push

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

push()

api.telephony.calls.reject

Reject an unanswered incoming call

reject()

api.telephony.calls.resume

Resume a held call

resume()

api.telephony.calls.resume_recording

Resume recording a call

resume_recording()

api.telephony.calls.retrieve
param destination:

Identifies where the call is parked

retrieve()

api.telephony.calls.start_recording

Start recording a call

start_recording()

api.telephony.calls.stop_recording

Stop recording a call

stop_recording()

api.telephony.calls.transfer

Transfer two calls together

transfer()

api.telephony.calls.transmit_dtmf

Transmit DTMF digits to a call

transmit_dtmf()

api.telephony.dect_devices.add_a_handset

Add a Handset to a DECT Network

add_a_handset()

api.telephony.dect_devices.available_members

Search Available Members

available_members()

api.telephony.dect_devices.create_base_stations

Create Multiple Base Stations

create_base_stations()

api.telephony.dect_devices.create_dect_network

Create a DECT Network

create_dect_network()

api.telephony.devices.apply_changes

Apply Changes for a specific device

apply_changes()

api.telephony.devices.available_members

Search members that can be assigned to the device

available_members()

api.telephony.devices.create_line_key_template

Create a Line Key Template

create_line_key_template()

api.telephony.devices.dect_devices

Read the DECT device type list

dect_devices()

api.telephony.devices.delete_line_key_template

Delete a Line Key Template

delete_line_key_template()

api.telephony.devices.device_settings

Get override settings for a device

device_settings()

api.telephony.devices.line_key_template_details

Get details of a Line Key Template

line_key_template_details()

api.telephony.devices.list_line_key_templates

Read the list of Line Key Templates

list_line_key_templates()

api.telephony.devices.members

Get Device Members

members()

api.telephony.devices.modify_line_key_template

Modify a Line Key Template

modify_line_key_template()

api.telephony.devices.preview_apply_line_key_template

Preview Apply Line Key Template

preview_apply_line_key_template()

api.telephony.devices.update_device_settings

Modify override settings for a device

update_device_settings()

api.telephony.devices.update_members

Modify member details on the device

update_members()

api.telephony.devices.validate_macs

Validate a list of MAC addresses

validate_macs()

api.telephony.huntgroup.by_name

Get hunt group info by name

by_name()

api.telephony.huntgroup.create

Create a Hunt Group

create()

api.telephony.huntgroup.delete_huntgroup

Delete a Hunt Group

delete_huntgroup()

api.telephony.huntgroup.details

Get Details for a Hunt Group

details()

api.telephony.huntgroup.list

Read the List of Hunt Groups

list()

api.telephony.huntgroup.update

Update a Hunt Group

update()

api.telephony.jobs.apply_line_key_templates.apply

Apply a Line key Template

apply()

api.telephony.jobs.apply_line_key_templates.job_errors

Get job errors for an Apply Line Key Template job

job_errors()

api.telephony.jobs.apply_line_key_templates.job_status

Get the job status of an Apply Line Key Template job

job_status()

api.telephony.jobs.apply_line_key_templates.list_jobs

Get List of Apply Line Key Template jobs

list_jobs()

api.telephony.jobs.device_settings.change

Change device settings across organization or locations jobs

change()

api.telephony.jobs.device_settings.get_status

Get change device settings job status

get_status()

api.telephony.jobs.device_settings.job_errors

List change device settings job errors

job_errors()

api.telephony.jobs.device_settings.list

List change device settings jobs

list()

api.telephony.jobs.manage_numbers.abandon_job

Abandon the Manage Numbers Job

abandon_job()

api.telephony.jobs.manage_numbers.initiate_job

Starts the numbers move from one location to another location

initiate_job()

api.telephony.jobs.manage_numbers.job_status

Returns the status and other details of the job

job_status()

api.telephony.jobs.manage_numbers.list_job_errors

Lists all error details of Manage Numbers job

list_job_errors()

api.telephony.jobs.manage_numbers.list_jobs

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

list_jobs()

api.telephony.jobs.manage_numbers.pause_job

Pause the running Manage Numbers Job

pause_job()

api.telephony.jobs.manage_numbers.resume_job

Resume the paused Manage Numbers Job

resume_job()

api.telephony.location.change_announcement_language

Change Announcement Language

change_announcement_language()

api.telephony.location.details

Shows Webex Calling details for a location, by ID

details()

api.telephony.location.device_settings

Get device override settings for a location

device_settings()

api.telephony.location.enable_for_calling

Enable a location by adding it to Webex Calling

enable_for_calling()

api.telephony.location.generate_password

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

generate_password()

api.telephony.location.list

Lists Webex Calling locations for an organization with Webex Calling details

list()

api.telephony.location.update

Update Webex Calling details for a location, by ID

update()

api.telephony.location.validate_extensions

Validate extensions for a specific location

validate_extensions()

api.telephony.location.intercept.configure

Put Location Intercept

configure()

api.telephony.location.intercept.read

Get Location Intercept

read()

api.telephony.location.internal_dialing.read

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

read()

api.telephony.location.internal_dialing.update

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

update()

api.telephony.location.internal_dialing.url

url()

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

Add new access code for this location

create()

api.telephony.location.moh.delete_codes

Delete Access Code Location

delete_codes()

api.telephony.location.moh.read

Get Music On Hold

read()

api.telephony.location.moh.update

Get Music On Hold

update()

api.telephony.location.number.activate

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

activate()

api.telephony.location.number.add

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

add()

api.telephony.location.number.remove

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

remove()

api.telephony.location.receptionist_contacts_directory.create

Creates a new Receptionist Contact Directory for a location

create()

api.telephony.location.receptionist_contacts_directory.delete

Delete a Receptionist Contact Directory from a location

delete()

api.telephony.location.receptionist_contacts_directory.list

List all Receptionist Contact Directories for a location

list()

api.telephony.location.voicemail.read

Get Location Voicemail

read()

api.telephony.location.voicemail.update

Get Location Voicemail

update()

api.telephony.locations.change_announcement_language

Change Announcement Language

change_announcement_language()

api.telephony.locations.details

Shows Webex Calling details for a location, by ID

details()

api.telephony.locations.device_settings

Get device override settings for a location

device_settings()

api.telephony.locations.enable_for_calling

Enable a location by adding it to Webex Calling

enable_for_calling()

api.telephony.locations.generate_password

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

generate_password()

api.telephony.locations.list

Lists Webex Calling locations for an organization with Webex Calling details

list()

api.telephony.locations.update

Update Webex Calling details for a location, by ID

update()

api.telephony.locations.validate_extensions

Validate extensions for a specific location

validate_extensions()

api.telephony.locations.intercept.configure

Put Location Intercept

configure()

api.telephony.locations.intercept.read

Get Location Intercept

read()

api.telephony.locations.internal_dialing.read

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

read()

api.telephony.locations.internal_dialing.update

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

update()

api.telephony.locations.internal_dialing.url

url()

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

Add new access code for this location

create()

api.telephony.locations.moh.delete_codes

Delete Access Code Location

delete_codes()

api.telephony.locations.moh.read

Get Music On Hold

read()

api.telephony.locations.moh.update

Get Music On Hold

update()

api.telephony.locations.number.activate

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

activate()

api.telephony.locations.number.add

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

add()

api.telephony.locations.number.remove

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

remove()

api.telephony.locations.receptionist_contacts_directory.create

Creates a new Receptionist Contact Directory for a location

create()

api.telephony.locations.receptionist_contacts_directory.delete

Delete a Receptionist Contact Directory from a location

delete()

api.telephony.locations.receptionist_contacts_directory.list

List all Receptionist Contact Directories for a location

list()

api.telephony.locations.voicemail.read

Get Location Voicemail

read()

api.telephony.locations.voicemail.update

Get Location Voicemail

update()

api.telephony.organisation_voicemail.read

Get Voicemail Settings

read()

api.telephony.organisation_voicemail.update

Update the organization’s voicemail settings

update()

api.telephony.paging.create

Create a new Paging Group

create()

api.telephony.paging.delete_paging

Delete a Paging Group

delete_paging()

api.telephony.paging.details

Get Details for a Paging Group

details()

api.telephony.paging.list

Read the List of Paging Groups

list()

api.telephony.paging.update

Update the designated Paging Group

update()

api.telephony.permissions_out.configure

Configure a Person’s Outgoing Calling Permissions Settings

configure()

api.telephony.permissions_out.read

Retrieve a Person’s Outgoing Calling Permissions Settings

read()

api.telephony.permissions_out.transfer_numbers.configure

Modify Transfer Numbers Settings for a Place

configure()

api.telephony.permissions_out.transfer_numbers.read

Retrieve Transfer Numbers Settings for a Workspace

read()

api.telephony.pickup.available_agents

Get available agents from Call Pickups

available_agents()

api.telephony.pickup.create

Create a Call Pickup

create()

api.telephony.pickup.delete_pickup

Delete a Call Pickup

delete_pickup()

api.telephony.pickup.details

Get Details for a Call Pickup

details()

api.telephony.pickup.list

Read the List of Call Pickups

list()

api.telephony.pickup.update

Update a Call Pickup

update()

api.telephony.pnc.read

Get Private Network Connect

read()

api.telephony.pnc.update

Get Private Network Connect

update()

api.telephony.prem_pstn.validate_pattern

Validate a Dial Pattern

validate_pattern()

api.telephony.prem_pstn.dial_plan.create

Create a Dial Plan for the organization

create()

api.telephony.prem_pstn.dial_plan.delete_all_patterns

Delete all dial patterns from the Dial Plan

delete_all_patterns()

api.telephony.prem_pstn.dial_plan.delete_dial_plan

Delete a Dial Plan for the organization

delete_dial_plan()

api.telephony.prem_pstn.dial_plan.details

Get a Dial Plan for the organization

details()

api.telephony.prem_pstn.dial_plan.list

List all Dial Plans for the organization

list()

api.telephony.prem_pstn.dial_plan.modify_patterns

Modify dial patterns for the Dial Plan

modify_patterns()

api.telephony.prem_pstn.dial_plan.patterns

List all Dial Patterns for the organization

patterns()

api.telephony.prem_pstn.dial_plan.update

Modify a Dial Plan for the organization

update()

api.telephony.prem_pstn.route_group.create

Creates a Route Group for the organization

create()

api.telephony.prem_pstn.route_group.delete_route_group

Remove a Route Group from an Organization based on id

delete_route_group()

api.telephony.prem_pstn.route_group.details

Reads a Route Group for the organization based on id

details()

api.telephony.prem_pstn.route_group.list

List all Route Groups for an organization

list()

api.telephony.prem_pstn.route_group.update

Modifies an existing Route Group for an organization based on id

update()

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

usage()

api.telephony.prem_pstn.route_group.usage_call_to_extension

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

usage_call_to_extension()

api.telephony.prem_pstn.route_group.usage_dial_plan

List Dial Plan Locations for a specific route group

usage_dial_plan()

api.telephony.prem_pstn.route_group.usage_location_pstn

List PSTN Connection Locations for a specific route group

usage_location_pstn()

api.telephony.prem_pstn.route_group.usage_route_lists

List Route Lists for a specific route group

usage_route_lists()

api.telephony.prem_pstn.route_list.create

Create a Route List for the organization

create()

api.telephony.prem_pstn.route_list.delete_all_numbers

delete_all_numbers()

api.telephony.prem_pstn.route_list.delete_route_list

Delete Route List for a Customer

delete_route_list()

api.telephony.prem_pstn.route_list.details

Get Route List Details

details()

api.telephony.prem_pstn.route_list.list

List all Route Lists for the organization

list()

api.telephony.prem_pstn.route_list.numbers

Get numbers assigned to a Route List

numbers()

api.telephony.prem_pstn.route_list.update

Modify the details for a Route List

update()

api.telephony.prem_pstn.route_list.update_numbers

Modify numbers for a specific Route List of a Customer

update_numbers()

api.telephony.prem_pstn.trunk.create

Create a Trunk for the organization

create()

api.telephony.prem_pstn.trunk.delete_trunk

Delete a Trunk for the organization

delete_trunk()

api.telephony.prem_pstn.trunk.details

Get a Trunk for the organization

details()

api.telephony.prem_pstn.trunk.list

List all Trunks for the organization

list()

api.telephony.prem_pstn.trunk.trunk_types

List all TrunkTypes with DeviceTypes for the organization

trunk_types()

api.telephony.prem_pstn.trunk.update

Modify a Trunk for the organization

update()

api.telephony.prem_pstn.trunk.usage

Get Local Gateway Usage Count

usage()

api.telephony.prem_pstn.trunk.usage_call_to_extension

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

usage_call_to_extension()

api.telephony.prem_pstn.trunk.usage_dial_plan

Get Local Gateway Dial Plan Usage for a Trunk

usage_dial_plan()

api.telephony.prem_pstn.trunk.usage_location_pstn

Get Local Gateway Dial Plan Usage for a Trunk

usage_location_pstn()

api.telephony.prem_pstn.trunk.usage_route_group

Get Local Gateway Dial Plan Usage for a Trunk

usage_route_group()

api.telephony.prem_pstn.trunk.validate_fqdn_and_domain

Validate Local Gateway FQDN and Domain for the organization trunks

validate_fqdn_and_domain()

api.telephony.schedules.create

Create a Schedule

create()

api.telephony.schedules.delete_schedule

Delete a Schedule

delete_schedule()

api.telephony.schedules.details

Get Details for a Schedule

details()

api.telephony.schedules.event_create

Create a Schedule Event

event_create()

api.telephony.schedules.event_delete

Delete a Schedule Event

event_delete()

api.telephony.schedules.event_details

Get Details for a Schedule Event

event_details()

api.telephony.schedules.event_update

Update a Schedule Event

event_update()

api.telephony.schedules.list

List of Schedules for a Person or location

list()

api.telephony.schedules.update

Update a Schedule

update()

api.telephony.virtual_lines.list

List all Virtual Lines for the organization

list()

api.telephony.voice_messaging.delete

Delete a specfic voicemail message for the user

delete()

api.telephony.voice_messaging.list

Get the list of all voicemail messages for the user

list()

api.telephony.voice_messaging.mark_as_read

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

mark_as_read()

api.telephony.voice_messaging.mark_as_unread

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

mark_as_unread()

api.telephony.voice_messaging.summary

Get a summary of the voicemail messages for the user

summary()

api.telephony.voicemail_groups.create

Create new voicemail group for the given location for a customer

create()

api.telephony.voicemail_groups.delete

Delete the designated voicemail group

delete()

api.telephony.voicemail_groups.details

Retrieve voicemail group details for a location

details()

api.telephony.voicemail_groups.ep
param location_id:

ep()

api.telephony.voicemail_groups.list

List the voicemail group information for the organization

list()

api.telephony.voicemail_groups.update

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

update()

api.telephony.voicemail_rules.read

Get Voicemail Rules

read()

api.telephony.voicemail_rules.update

Update Voicemail Rules

update()

api.telephony.voiceportal.passcode_rules

Get VoicePortal Passcode Rule

passcode_rules()

api.telephony.voiceportal.read
param location_id:

Location to which the voice portal belongs

read()

api.telephony.voiceportal.update

Update VoicePortal

update()

api.webhook.create

Creates a webhook

create()

api.webhook.details

Get Webhook Details

details()

api.webhook.list

List all of your webhooks

list()

api.webhook.update

Updates a webhook, by ID

update()

api.webhook.webhook_delete

Deletes a webhook, by ID

webhook_delete()

api.workspace_locations.create

Create a location

create()

api.workspace_locations.delete

Delete a Workspace Location

delete()

api.workspace_locations.details

Get a Workspace Location Details

details()

api.workspace_locations.ep

ep()

api.workspace_locations.list

List workspace locations

list()

api.workspace_locations.update

Update a Workspace Location

update()

api.workspace_locations.floors.create

Create a Workspace Location Floor

create()

api.workspace_locations.floors.delete

Delete a Workspace Location Floor

delete()

api.workspace_locations.floors.details

Get a Workspace Location Floor Details

details()

api.workspace_locations.floors.ep

ep()

api.workspace_locations.floors.list
param location_id:

list()

api.workspace_locations.floors.update

Updates details for a floor, by ID

update()

api.workspace_settings.call_intercept.configure

Configure Call Intercept Settings for a Person

configure()

api.workspace_settings.call_intercept.greeting

Configure Call Intercept Greeting for a Person

greeting()

api.workspace_settings.call_intercept.read

Read Call Intercept Settings for a Person

read()

api.workspace_settings.call_waiting.configure

Configure Call Waiting Settings for a Person

configure()

api.workspace_settings.call_waiting.read

Read Call Waiting Settings for a Person

read()

api.workspace_settings.caller_id.configure

Configure a Person’s Caller ID Settings

configure()

api.workspace_settings.caller_id.configure_settings

configure_settings()

api.workspace_settings.caller_id.read

Retrieve a Person’s Caller ID Settings

read()

api.workspace_settings.devices.list

Get all devices for a workspace

list()

api.workspace_settings.devices.modify_hoteling

Modify devices for a workspace

modify_hoteling()

api.workspace_settings.forwarding.configure

Configure a Person’s Call Forwarding Settings

configure()

api.workspace_settings.forwarding.read

Retrieve a Person’s Call Forwarding Settings

read()

api.workspace_settings.monitoring.configure

Configure Call Waiting Settings for a Person

configure()

api.workspace_settings.monitoring.read

Retrieve a Person’s Monitoring Settings

read()

api.workspace_settings.numbers.ep
meta private:

ep()

api.workspace_settings.numbers.read

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

read()

api.workspace_settings.permissions_in.configure

Configure a Person’s Barge In Settings

configure()

api.workspace_settings.permissions_in.read

Read Incoming Permission Settings for a Person

read()

api.workspace_settings.permissions_out.configure

Configure a Person’s Outgoing Calling Permissions Settings

configure()

api.workspace_settings.permissions_out.read

Retrieve a Person’s Outgoing Calling Permissions Settings

read()

api.workspace_settings.permissions_out.access_codes.create

Create new Access codes for the given workspace

create()

api.workspace_settings.permissions_out.access_codes.delete_codes

Modify Access codes for a workspace

delete_codes()

api.workspace_settings.permissions_out.access_codes.read

Retrieve Access codes for a Workspace

read()

api.workspace_settings.permissions_out.transfer_numbers.configure

Modify Transfer Numbers Settings for a Place

configure()

api.workspace_settings.permissions_out.transfer_numbers.read

Retrieve Transfer Numbers Settings for a Workspace

read()

api.workspaces.capabilities

Shows the capabilities for a workspace by ID

capabilities()

api.workspaces.create

Create a Workspace

create()

api.workspaces.delete_workspace

Delete a Workspace

delete_workspace()

api.workspaces.details

Get Workspace Details

details()

api.workspaces.list

List Workspaces

list()

api.workspaces.update

Updates details for a workspace by ID

update()