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.get_token_expiration_status

Get expiration status for a token

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.converged_recordings.delete

Delete a Recording

api.converged_recordings.details

Get Recording Details

api.converged_recordings.list

List Recordings

api.converged_recordings.list_for_admin_or_compliance_officer

List Recordings for Admin or Compliance officer

api.converged_recordings.metadata

Get Recording metadata

api.converged_recordings.move_recordings_into_the_recycle_bin

Move Recordings into the Recycle Bin

api.converged_recordings.purge_recordings_from_recycle_bin

Purge Recordings from Recycle Bin

api.converged_recordings.reassign

Reassign Recordings

api.converged_recordings.restore_recordings_from_recycle_bin

Restore Recordings from Recycle Bin

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.jobs.activation_emails.errors

Get Bulk Activation Email Resend Job Errors

api.jobs.activation_emails.start

Initiate Bulk Activation Email Resend Job

api.jobs.activation_emails.status

Get Bulk Activation Email Resend Job Status

api.jobs.apply_line_key_templates.apply

Apply a Line key Template

api.jobs.apply_line_key_templates.errors

Get job errors for an Apply Line Key Template job

api.jobs.apply_line_key_templates.list

Get List of Apply Line Key Template jobs

api.jobs.apply_line_key_templates.status

Get the job status of an Apply Line Key Template job

api.jobs.call_recording.errors

Get Job Errors for a Call Recording Job

api.jobs.call_recording.list

List Call Recording Jobs

api.jobs.call_recording.status

Get the Job Status of a Call Recording Job

api.jobs.device_settings.change

Change device settings across organization or locations jobs

api.jobs.device_settings.errors

List change device settings job errors

api.jobs.device_settings.list

List change device settings jobs

api.jobs.device_settings.status

Get change device settings job status

api.jobs.disable_calling_location.errors

Retrieve Errors for a Disable Calling Location Job

api.jobs.disable_calling_location.initiate

Disable a Location for Webex Calling

api.jobs.disable_calling_location.list

Get a List of Disable Calling Location Jobs

api.jobs.disable_calling_location.pause

Pause a Disable Calling Location Job

api.jobs.disable_calling_location.resume

Resume a Paused Disable Calling Location Job

api.jobs.disable_calling_location.status

Get Disable Calling Location Job Status

api.jobs.dynamic_device_settings.errors

List Dynamic Device Settings Job Errors

api.jobs.dynamic_device_settings.list

List dynamic device settings jobs

api.jobs.dynamic_device_settings.status

Get Device Dynamic Settings Job Status

api.jobs.dynamic_device_settings.update_across_org_or_location

Updates dynamic Device Settings Across Organization Or Location

api.jobs.manage_numbers.abandon

Abandon the Manage Numbers Job

api.jobs.manage_numbers.errors

List Manage Numbers Job errors

api.jobs.manage_numbers.initiate_job

Initiate Number Jobs

api.jobs.manage_numbers.list

List Manage Numbers Jobs

api.jobs.manage_numbers.pause

Pause the Manage Numbers Job

api.jobs.manage_numbers.resume

Resume the Manage Numbers Job

api.jobs.manage_numbers.status

Get Manage Numbers Job Status

api.jobs.move_users.abandon

Abandon the Move Users Job

api.jobs.move_users.errors

List Move Users Job errors

api.jobs.move_users.list

List Move Users Jobs

api.jobs.move_users.pause

Pause the Move Users Job

api.jobs.move_users.resume

Resume the Move Users Job

api.jobs.move_users.status

Get Move Users Job Status

api.jobs.move_users.validate_or_initiate

Validate or Initiate Move Users Job

api.jobs.rebuild_phones.errors

Get Job Errors for a Rebuild Phones Job

api.jobs.rebuild_phones.list

List Rebuild Phones Jobs

api.jobs.rebuild_phones.rebuild_phones_configuration

Rebuild Phones Configuration

api.jobs.rebuild_phones.status

Get the Job Status of a Rebuild Phones Job

api.jobs.update_routing_prefix.errors

Get job errors for update routing prefix job

api.jobs.update_routing_prefix.list

Get a List of Update Routing Prefix jobs

api.jobs.update_routing_prefix.status

Get the job status of Update Routing Prefix job

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 Location

api.locations.create_floor

Create a Location Floor

api.locations.delete

Delete Location

api.locations.delete_floor

Delete a Location Floor

api.locations.details

Get Location Details

api.locations.floor_details

Get Location Floor Details

api.locations.list

List Locations

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.me.announcement_languages

Retrieve announcement languages for the authenticated user

api.me.available_numbers_for_location

Get Available Numbers for User’s Location

api.me.call_captions_settings

Get my call captions settings

api.me.calling_services_list

Get My Calling Services List

api.me.country_telephony_config_requirements

Retrieve country-specific telephony configuration requirements

api.me.details

Get My Own Details

api.me.feature_access_codes

Get My Feature Access Codes

api.me.guest_calling_numbers

Retrieve My Guest Calling Numbers

api.me.monitoring_settings

Get My Monitoring Settings

api.me.anon_calls.get

Get Anonymous Call Rejection Settings for User

api.me.anon_calls.modify

Modify Anonymous Call Rejection Settings for User

api.me.barge.configure

Configure Barge-In Settings

api.me.barge.get

Retrieve Barge-In Settings

api.me.call_block.add_number

Add a phone number to user’s Call Block List

api.me.call_block.delete_number

Delete User Call Block Number

api.me.call_block.settings

Get My Call Block Settings

api.me.call_block.state_for_number

Get My Call Block State For Specific Number

api.me.call_center.modify

Modify My Call Center Settings

api.me.call_center.settings

Get My Call Center Settings

api.me.call_notify.criteria_create

Add a Call Notify Criteria

api.me.call_notify.criteria_delete

Delete a Call Notify Criteria

api.me.call_notify.criteria_get

Get Call Notify Criteria Settings

api.me.call_notify.criteria_update

Modify a Call Notify Criteria

api.me.call_notify.get

Get Call Notify Settings for User

api.me.call_notify.update

Modify Call Notify Settings for User

api.me.call_park.settings

Get My Call Park Settings

api.me.call_pickup.settings

Get My Call Pickup Group Settings

api.me.call_policies.settings

Get Call Policies Settings for User

api.me.call_policies.update

Modify Call Policies Settings for User

api.me.call_waiting.get

Get Call Waiting Settings for User

api.me.call_waiting.update

Modify Call Waiting Settings for User

api.me.caller_id.available_caller_id_list

Get My Available Caller ID List

api.me.caller_id.get_selected_caller_id_settings

Read My Selected Caller ID Settings

api.me.caller_id.modify_selected_caller_id_settings

Configure My Selected Caller ID Settings

api.me.caller_id.settings

Get My Caller ID Settings

api.me.caller_id.update

Modify My Caller ID Settings

api.me.dnd.configure

Update Do Not Disturb Settings for User

api.me.dnd.settings

Get Do Not Disturb Settings for User

api.me.endpoints.available_preferred_answer_endpoints

Get List Available Preferred Answer Endpoints

api.me.endpoints.details

Get My Endpoints Details

api.me.endpoints.get_preferred_answer_endpoint

Get Preferred Answer Endpoint

api.me.endpoints.list

Read the List of My Endpoints

api.me.endpoints.modify_preferred_answer_endpoint

Modify Preferred Answer Endpoint

api.me.endpoints.update

Modify My Endpoints Details

api.me.executive.alert_settings

Get User Executive Alert Settings

api.me.executive.assigned_assistants

Get My Executive Assigned Assistants

api.me.executive.call_filtering_criteria

Get User Executive Call Filtering Criteria Settings

api.me.executive.create_call_filtering_criteria

Add User Executive Call Filtering Criteria

api.me.executive.delete_call_filtering_criteria

Delete User Executive Call Filtering Criteria

api.me.executive.executive_assistant_settings

Get My Executive Assistant Settings

api.me.executive.executive_available_assistants

Get My Executive Available Assistants

api.me.executive.executive_call_filtering_settings

Get User Executive Call Filtering Settings

api.me.executive.screening_settings

Get User Executive Screening Settings

api.me.executive.update_alert_settings

Modify User Executive Alert Settings

api.me.executive.update_assigned_assistants

Modify My Executive Assigned Assistants

api.me.executive.update_call_filtering_criteria

Update User Executive Call Filtering Criteria Settings

api.me.executive.update_executive_assistant_settings

Modify My Executive Assistant Settings

api.me.executive.update_executive_call_filtering_settings

Update User Executive Call Filtering Settings

api.me.executive.update_screening_settings

Modify User Executive Screening Settings

api.me.forwarding.configure

Configure My Call Forwarding Settings

api.me.forwarding.settings

Read My Call Forwarding Settings

api.me.go_override.get

Get My WebexGoOverride Settings

api.me.go_override.update

Modify My WebexGoOverride Settings

api.me.mode_management.extend_mode

Extend Current Operating Mode Duration

api.me.mode_management.feature_get

Get Mode Management Feature

api.me.mode_management.get_common_modes

Get Common Modes

api.me.mode_management.get_features

Get Mode Management Features

api.me.mode_management.get_normal_operation_mode

Get Normal Operation Mode

api.me.mode_management.get_operating_mode

Get Operating Mode

api.me.mode_management.switch_mode_for_feature

Switch Mode for Single Feature

api.me.mode_management.switch_mode_multiple_features

Switch Mode for Multiple Features

api.me.mode_management.switch_to_normal_operation

Switch to Normal Operation

api.me.personal_assistant.get

Get My Personal Assistant

api.me.personal_assistant.update

Modify My Personal Assistant

api.me.priority_alert.criteria_create

Add a Priority Alert Criteria

api.me.priority_alert.criteria_delete

Delete a Priority Alert Criteria

api.me.priority_alert.criteria_get

Get Priority Alert Criteria Settings

api.me.priority_alert.criteria_update

Modify Settings for a Priority Alert Criteria

api.me.priority_alert.get

Get Priority Alert Settings

api.me.priority_alert.update

Modify Priority Alert Settings for User

api.me.recording.settings

Get My Call Recording Settings

api.me.schedules.create

Add a User level Schedule for Call Settings

api.me.schedules.delete

Delete a User Schedule

api.me.schedules.event_create

Add an event for a User Schedule

api.me.schedules.event_delete

Delete User a Schedule Event

api.me.schedules.event_get

Get User Schedule Event

api.me.schedules.event_update

Modify User Schedule Event

api.me.schedules.get_location_schedule

Get User’s Location Level Schedule

api.me.schedules.get_user_schedule

Get User Schedule

api.me.schedules.list

Get User (and Location) Schedules

api.me.schedules.update

Modify User Schedule

api.me.selective_accept.criteria_create

Add User Selective Call Accept Criteria

api.me.selective_accept.criteria_delete

Delete a Selective Call Accept Criteria

api.me.selective_accept.criteria_get

Get Selective Call Accept Criteria Settings for User

api.me.selective_accept.criteria_update

Modify a Selective Call Accept Criteria

api.me.selective_accept.get

Get Selective Call Accept Settings for User

api.me.selective_accept.update

Modify Selective Call Accept Settings for User

api.me.selective_forward.criteria_create

Add a Selective Call Forwarding Criteria

api.me.selective_forward.criteria_delete

Delete a Selective Call Forwarding Criteria

api.me.selective_forward.criteria_get

Get Settings for a Selective Call Forwarding Criteria

api.me.selective_forward.criteria_update

Modify Settings for a Selective Call Forwarding Criteria

api.me.selective_forward.get

Get Selective Call Forward Settings for User

api.me.selective_forward.update

Modify Selective Call Forward Settings for User

api.me.selective_reject.criteria_create

Add User Selective Call Reject Criteria

api.me.selective_reject.criteria_delete

Delete a Selective Call Reject Criteria

api.me.selective_reject.criteria_get

Get Selective Call Reject Criteria Settings for User

api.me.selective_reject.criteria_update

Modify a Selective Call Reject Criteria

api.me.selective_reject.get

Get Selective Call Reject Settings for User

api.me.selective_reject.update

Modify Selective Call Reject Settings for User

api.me.sequential_ring.criteria_create

Add User Sequential Ring Criteria

api.me.sequential_ring.criteria_delete

Delete Sequential Ring Criteria

api.me.sequential_ring.criteria_get

Get Sequential Ring Criteria Settings for User

api.me.sequential_ring.criteria_update

Modify Sequential Ring Criteria Settings for User

api.me.sequential_ring.get

Get Sequential Ring Settings for User

api.me.sequential_ring.update

Modify Sequential Ring Settings for User

api.me.sim_ring.criteria_create

Create My Simultaneous Ring Criteria

api.me.sim_ring.criteria_delete

Delete My Simultaneous Ring Criteria

api.me.sim_ring.criteria_get

Retrieve My Simultaneous Ring Criteria

api.me.sim_ring.criteria_update

Modify My Simultaneous Ring Criteria

api.me.sim_ring.get

Retrieve My Simultaneous Ring Settings

api.me.sim_ring.update

Modify My Simultaneous Ring Settings

api.me.snr.create_snr

Add phone number as User’s Single Number Reach

api.me.snr.delete_snr

Delete User’s Single Number Reach Contact Settings

api.me.snr.settings

Get User’s Single Number Reach Settings

api.me.snr.update

Update User’s Single Number Reach Settings

api.me.snr.update_snr

Modify User’s Single Number Reach Contact Settings

api.me.voicemail.configure

Configure Voicemail Settings for a Person

api.me.voicemail.settings

Read Voicemail Settings for a Person

api.me.voicemail.upload_busy_greeting

Upload Voicemail Busy Greeting

api.me.voicemail.upload_no_answer_greeting

Upload Voicemail No Answer Greeting

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.org_contacts.bulk_create_or_update

Bulk Create or Update Contacts

api.org_contacts.bulk_delete

Bulk Delete Contacts

api.org_contacts.create

Create a Contact

api.org_contacts.delete

Delete a Contact

api.org_contacts.get

Get a Contact

api.org_contacts.list

List Contacts

api.org_contacts.update

Update a Contact

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

Delete a Person

api.people.details

Get Person Details

api.people.list

List people in your organization

api.people.me

Show the profile for the authenticated user

api.people.update

Update a Person

api.person_settings.devices

Get all devices for a person

api.person_settings.get_call_captions_settings

Get the user call captions settings

api.person_settings.modify_hoteling_settings_primary_devices

Modify Hoteling Settings for a Person’s Primary Devices

api.person_settings.reset_vm_pin

Reset Voicemail PIN

api.person_settings.update_call_captions_settings

Update the user call captions settings

api.person_settings.agent_caller_id.available_caller_ids

Retrieve Agent’s List of Available Caller IDs

api.person_settings.agent_caller_id.configure

Modify Agent’s Caller ID Information

api.person_settings.agent_caller_id.read

Retrieve Agent’s Caller ID Information

api.person_settings.app_shared_line.get_members

Get Shared-Line Appearance Members

api.person_settings.app_shared_line.search_members

Search Shared-Line Appearance Members

api.person_settings.app_shared_line.search_members_old

Search Shared-Line Appearance Members

api.person_settings.app_shared_line.update_members

Put Shared-Line Appearance Members New

api.person_settings.appservices.configure

Modify a person’s Application Services Settings

api.person_settings.appservices.read

Retrieve a person’s Application Services Settings New

api.person_settings.appservices.shared_line.get_members

Get Shared-Line Appearance Members

api.person_settings.appservices.shared_line.search_members

Search Shared-Line Appearance Members

api.person_settings.appservices.shared_line.search_members_old

Search Shared-Line Appearance Members

api.person_settings.appservices.shared_line.update_members

Put Shared-Line Appearance Members New

api.person_settings.available_numbers.available

Get Available Phone Numbers

api.person_settings.available_numbers.call_forward

Get Call Forward Available Phone Numbers

api.person_settings.available_numbers.call_intercept

Get Call Intercept Available Phone Numbers

api.person_settings.available_numbers.ecbn

Get ECBN Available Phone Numbers

api.person_settings.available_numbers.fax_message

Get Fax Message Available Phone Numbers

api.person_settings.available_numbers.primary

Get Person Primary Available Phone Numbers

api.person_settings.available_numbers.secondary

Get Person Secondary Available Phone Numbers

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 an entity

api.person_settings.dnd.read

Read Do Not Disturb Settings for an entity

api.person_settings.ecbn.configure

Update an entity’s Emergency Callback Number

api.person_settings.ecbn.dependencies

Retrieve an entity’s Emergency Callback Number Dependencies

api.person_settings.ecbn.read

Get an entity’s Emergency Callback Number

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.executive.alert_settings

Get Person Executive Alert Settings

api.person_settings.executive.assigned_assistants

Get Person Executive Assigned Assistants

api.person_settings.executive.create_call_filtering_criteria

Add Person Executive Call Filtering Criteria

api.person_settings.executive.delete_call_filtering_criteria

Delete Person Executive Call Filtering Criteria

api.person_settings.executive.executive_assistant_settings

Get Person Executive Assistant Settings

api.person_settings.executive.executive_available_assistants

Get Person Executive Available Assistants

api.person_settings.executive.executive_call_filtering_settings

Get Person Executive Call Filtering Settings

api.person_settings.executive.get_filtering_criteria

Get Person Executive Call Filtering Criteria Settings

api.person_settings.executive.screening_settings

Get Person Executive Screening Settings

api.person_settings.executive.update_alert_settings

Modify Person Executive Alert Settings

api.person_settings.executive.update_assigned_assistants

Modify Person Executive Assigned Assistants

api.person_settings.executive.update_call_filtering_criteria

Modify Person Executive Call Filtering Criteria Settings

api.person_settings.executive.update_executive_assistant_settings

Modify Person Executive Assistant Settings

api.person_settings.executive.update_executive_call_filtering_settings

Modify Person Executive Call Filtering Settings

api.person_settings.executive.update_screening_settings

Modify Person Executive Screening Settings

api.person_settings.feature_access.read

Read Feature Access Settings for a Person

api.person_settings.feature_access.read_default

Read Default Feature Access Settings for Person

api.person_settings.feature_access.reset

Reset a Person’s Feature Access Configuration to the Organization’s Default Settings

api.person_settings.feature_access.update

Update a Person’s Feature Access Configuration

api.person_settings.feature_access.update_default

Update Default Person Feature Access Configuration

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.mode_management.assign_features

Assign a List of Features to a User for Mode Management

api.person_settings.mode_management.assigned_features

Retrieve the List of Features Assigned to a User for Mode Management

api.person_settings.mode_management.available_features

Retrieve the List of Available Features

api.person_settings.monitoring.configure

Modify an entity’s Monitoring Settings

api.person_settings.monitoring.read

Retrieve an entity’s Monitoring Settings

api.person_settings.ms_teams.configure

Configure a Person’s MS Teams Setting

api.person_settings.ms_teams.read

Retrieve a Person’s MS Teams Settings

api.person_settings.music_on_hold.configure

Configure Music On Hold Settings for a Personvirtual line, or workspace

api.person_settings.music_on_hold.read

Retrieve Music On Hold Settings for a Person, virtual line, or workspace

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 an entity

api.person_settings.permissions_out.transfer_numbers.read

Retrieve Transfer Numbers Settings

api.person_settings.personal_assistant.get

Get Personal Assistant

api.person_settings.personal_assistant.update

Update Personal Assistant

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 an entity’s Privacy Settings

api.person_settings.privacy.read

Get Privacy Settings for an entity

api.person_settings.push_to_talk.configure

Configure Push-to-Talk Settings for an entity

api.person_settings.push_to_talk.read

Read Push-to-Talk Settings for an entity

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.selective_accept.configure

Modify Selective Accept Settings for an entity

api.person_settings.selective_accept.configure_criteria

Modify Selective Accept Criteria for an entity

api.person_settings.selective_accept.create_criteria

Create Selective Accept Criteria for an entity

api.person_settings.selective_accept.delete_criteria

Delete Selective Accept Criteria for an entity

api.person_settings.selective_accept.read

Retrieve Selective Accept Settings for an entity

api.person_settings.selective_accept.read_criteria

Retrieve Selective Accept Criteria for an entity

api.person_settings.selective_forward.configure

Modify Selective Forward Settings for a Workspace

api.person_settings.selective_forward.configure_criteria

Modify Selective Forward Criteria for a Workspace

api.person_settings.selective_forward.create_criteria

Create Selective Forward Criteria for a Workspace

api.person_settings.selective_forward.delete_criteria

Delete Selective Forward Criteria for a Workspace

api.person_settings.selective_forward.read

Retrieve Selective Forward Settings for a Workspace

api.person_settings.selective_forward.read_criteria

Retrieve Selective Forward Criteria for a Workspace

api.person_settings.selective_reject.configure

Modify Selective Reject Settings for an entity

api.person_settings.selective_reject.configure_criteria

Modify Selective Reject Criteria for an entity

api.person_settings.selective_reject.create_criteria

Create Selective Reject Criteria for an entity

api.person_settings.selective_reject.delete_criteria

Delete Selective Reject Criteria for an entity

api.person_settings.selective_reject.read

Retrieve Selective Reject Settings for an entity

api.person_settings.selective_reject.read_criteria

Retrieve Selective Reject Criteria for an entity

api.person_settings.single_number_reach.available_phone_numbers

Get Single Number Reach Primary Available Phone Numbers

api.person_settings.single_number_reach.create_snr

Create Single Number Reach For a Person

api.person_settings.single_number_reach.delete_snr

Delete A Single Number Reach Number

api.person_settings.single_number_reach.read

Get Single Number Reach Settings For A Person

api.person_settings.single_number_reach.update

Update Single number reach settings for a person

api.person_settings.single_number_reach.update_snr

Update Single number reach settings for a number

api.person_settings.voicemail.configure

Configure Voicemail Settings for an entity

api.person_settings.voicemail.configure_busy_greeting

Configure Busy Voicemail Greeting for an entity

api.person_settings.voicemail.configure_no_answer_greeting

Configure No Answer Voicemail Greeting for an entity

api.person_settings.voicemail.modify_passcode

Modify an entity’s voicemail passcode

api.person_settings.voicemail.read

Read Voicemail Settings for an entity

api.person_settings.voicemail.reset_pin

Reset Voicemail PIN

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.roles.details

Get Role Details

api.roles.list

List Roles

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

The meetingInfo API is deprecated and will be EOL on Jan 31, 2025

api.rooms.update

Updates details for a room, by ID

api.scim.bulk.bulk_request

User bulk API

api.scim.groups.create

Create a group

api.scim.groups.delete

Delete a group

api.scim.groups.details

Get a group

api.scim.groups.members

Get Group Members

api.scim.groups.members_all

Same operation as members() but returns a generator of ScimGroupMembers instead of paginated resources

api.scim.groups.patch

Update a group with PATCH

api.scim.groups.search

Search groups

api.scim.groups.search_all

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

api.scim.groups.update

Update a group with PUT

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.create_a_call_token

Create a call token

api.telephony.device_settings

Get device override settings for an organization

api.telephony.get_call_captions_settings

Get the organization call captions settings

api.telephony.phone_number_details

get summary (counts) of phone numbers

api.telephony.phone_numbers

Get Phone Numbers for an Organization with Given Criterias

api.telephony.read_list_of_announcement_languages

Read the List of Announcement Languages

api.telephony.read_moh

Get the organization Music on Hold configuration

api.telephony.route_choices

Read the List of Routing Choices

api.telephony.supported_devices

Read the List of Supported Devices

api.telephony.test_call_routing

Test Call Routing

api.telephony.ucm_profiles

Read the List of UC Manager Profiles

api.telephony.update_call_captions_settings

Update the organization call captions settings

api.telephony.update_moh

Update the organization Music on Hold configuration

api.telephony.validate_extensions

Validate the List of Extensions

api.telephony.validate_phone_numbers

Validate phone numbers

api.telephony.access_codes.create

Create Outgoing Permission a new access code for a customer 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 Outgoing Permission Location Access Code

api.telephony.announcements_repo.delete

Delete an announcement greeting

api.telephony.announcements_repo.details

Fetch details of a binary announcement greeting at the organization or location level

api.telephony.announcements_repo.list

Fetch list of announcement greetings on location and organization level

api.telephony.announcements_repo.modify

Modify a binary announcement greeting at organization or location level

api.telephony.announcements_repo.upload_announcement

Upload a binary announcement greeting at organization or location level

api.telephony.announcements_repo.usage

Fetch repository usage for announcements for an organization or location

api.telephony.auto_attendant.alternate_available_phone_numbers

Get Auto Attendant Alternate Available Phone Numbers

api.telephony.auto_attendant.by_name

Get auto attendant info by name

api.telephony.auto_attendant.call_forward_available_phone_numbers

Get Auto Attendant Call Forward Available Phone Numbers

api.telephony.auto_attendant.create

Create an Auto Attendant

api.telephony.auto_attendant.delete_announcement_file

Delete an Auto Attendant Announcement File

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.list_announcement_files

Read the List of Auto Attendant Announcement Files

api.telephony.auto_attendant.primary_available_phone_numbers

Get Auto Attendant Primary Available Phone Numbers

api.telephony.auto_attendant.update

Update an Auto Attendant

api.telephony.auto_attendant.forwarding.call_forwarding_rule

Retrieve a Selective Call Forwarding Rule’s settings for the designated Call Queue

api.telephony.auto_attendant.forwarding.create_call_forwarding_rule

Create a Selective Call Forwarding Rule feature

api.telephony.auto_attendant.forwarding.delete_call_forwarding_rule

Delete a Selective Call Forwarding Rule for the designated feature

api.telephony.auto_attendant.forwarding.settings

Retrieve Call Forwarding settings for the designated feature including the list of call

api.telephony.auto_attendant.forwarding.switch_mode_for_call_forwarding

Switch Mode for Call Forwarding Settings for an entity

api.telephony.auto_attendant.forwarding.update

Update Call Forwarding Settings for a feature

api.telephony.auto_attendant.forwarding.update_call_forwarding_rule

Update a Selective Call Forwarding Rule’s settings for the designated feature

api.telephony.call_intercept.configure

Put Location Intercept

api.telephony.call_intercept.read

Get Location Intercept

api.telephony.call_recording.get_call_recording_regions

Get Call Recording Regions

api.telephony.call_recording.get_location_vendors

Get Location Call Recording Vendors

api.telephony.call_recording.get_org_vendors

Get Organization Call Recording Vendors

api.telephony.call_recording.list_location_users

Get Call Recording Vendor Users for a Location

api.telephony.call_recording.list_org_users

Get Call Recording Vendor Users

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.set_location_vendor

Set Call Recording Vendor for a Location

api.telephony.call_recording.set_org_vendor

Set Organization Call Recording Vendor

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.call_routing.tp.create

Create a Translation Pattern

api.telephony.call_routing.tp.delete

Delete a Translation Pattern

api.telephony.call_routing.tp.details

Retrieve the details of a Translation Pattern

api.telephony.call_routing.tp.list

Retrieve a list of Translation Patterns

api.telephony.call_routing.tp.update

Modify a Translation Pattern

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 Extension

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 a Call Park Extension

api.telephony.callpark_extension.delete

Delete a 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 a Call Park Extension

api.telephony.callqueue.alternate_available_phone_numbers

Get Call Queue Alternate Available Phone Numbers

api.telephony.callqueue.available_agents

Get Call Queue Available Agents

api.telephony.callqueue.by_name

Get queue info by name

api.telephony.callqueue.call_forward_available_phone_numbers

Get Call Queue Call Forward Available Phone Numbers

api.telephony.callqueue.create

Create a Call Queue

api.telephony.callqueue.delete_queue

Delete a Call Queue

api.telephony.callqueue.details

Get Details for a Call Queue

api.telephony.callqueue.get_call_queue_settings

Get Call Queue Settings

api.telephony.callqueue.list

Read the List of Call Queues

api.telephony.callqueue.primary_available_phone_numbers

Get Call Queue Primary Available Phone Numbers

api.telephony.callqueue.update

Update a Call Queue

api.telephony.callqueue.update_call_queue_settings

Update Call Queue Settings

api.telephony.callqueue.agents.details

Get Details for a Call Queue Agent

api.telephony.callqueue.agents.list

Read the List of Call Queue Agents

api.telephony.callqueue.agents.update_call_queue_settings

Update an Agent’s Settings of One or More Call Queues

api.telephony.callqueue.forwarding.call_forwarding_rule

Retrieve a Selective Call Forwarding Rule’s settings for the designated Call Queue

api.telephony.callqueue.forwarding.create_call_forwarding_rule

Create a Selective Call Forwarding Rule feature

api.telephony.callqueue.forwarding.delete_call_forwarding_rule

Delete a Selective Call Forwarding Rule for the designated feature

api.telephony.callqueue.forwarding.settings

Retrieve Call Forwarding settings for the designated feature including the list of call

api.telephony.callqueue.forwarding.switch_mode_for_call_forwarding

Switch Mode for Call Forwarding Settings for an entity

api.telephony.callqueue.forwarding.update

Update Call Forwarding Settings for a feature

api.telephony.callqueue.forwarding.update_call_forwarding_rule

Update a Selective Call Forwarding Rule’s settings for the designated feature

api.telephony.calls.answer

Answer

api.telephony.calls.barge_in

Barge In

api.telephony.calls.call_details

Get Call Details

api.telephony.calls.call_history

List Call History

api.telephony.calls.dial

Dial

api.telephony.calls.divert

Divert

api.telephony.calls.hangup

Hangup

api.telephony.calls.hold

Hold

api.telephony.calls.list_calls

List Calls

api.telephony.calls.mute

Mute

api.telephony.calls.park

Park

api.telephony.calls.pause_recording

Pause Recording

api.telephony.calls.pickup

Pickup

api.telephony.calls.pull

Pull

api.telephony.calls.push

Push

api.telephony.calls.reject

Reject

api.telephony.calls.resume

Resume

api.telephony.calls.resume_recording

Resume Recording

api.telephony.calls.retrieve

Retrieve

api.telephony.calls.start_recording

Start Recording

api.telephony.calls.stop_recording

Stop Recording

api.telephony.calls.transfer

Transfer

api.telephony.calls.transmit_dtmf

Transmit DTMF

api.telephony.calls.unmute

Unmute

api.telephony.calls.update_external_voicemail_mwi

Set or Clear Message Waiting Indicator (MWI) Status

api.telephony.conference.add_participant

Add Participant

api.telephony.conference.deafen_participant

Deafen Participant

api.telephony.conference.get_conference_details

Get Conference Details

api.telephony.conference.hold

Hold

api.telephony.conference.mute

Mute

api.telephony.conference.release_conference

Release Conference

api.telephony.conference.resume

Resume

api.telephony.conference.start_conference

Start Conference

api.telephony.conference.undeafen_participant

Undeafen Participant

api.telephony.conference.unmute

Unmute

api.telephony.cx_essentials.available_agents

Get List of available agents for Customer Experience Essentials

api.telephony.cx_essentials.get_screen_pop_configuration

Get Screen Pop configuration for a Call Queue in a Location

api.telephony.cx_essentials.modify_screen_pop_configuration

Modify Screen Pop configuration for a Call Queue in a Location

api.telephony.cx_essentials.callqueue_recording.configure

Configure Queue Call Recording Settings for a Queue

api.telephony.cx_essentials.callqueue_recording.read

Read Queue Call Recording Settings for a Queue

api.telephony.cx_essentials.wrapup_reasons.available_queues

Read Available Queues

api.telephony.cx_essentials.wrapup_reasons.create

Create Wrap Up Reason

api.telephony.cx_essentials.wrapup_reasons.delete

Delete Wrap Up Reason

api.telephony.cx_essentials.wrapup_reasons.details

Read Wrap Up Reason

api.telephony.cx_essentials.wrapup_reasons.list

List Wrap Up Reasons

api.telephony.cx_essentials.wrapup_reasons.read_queue_settings

Read Wrap Up Reason Settings

api.telephony.cx_essentials.wrapup_reasons.update

Update Wrap Up Reason

api.telephony.cx_essentials.wrapup_reasons.update_queue_settings

Update Wrap Up Reason Settings

api.telephony.cx_essentials.wrapup_reasons.validate

Validate Wrap Up Reason

api.telephony.dect_devices.add_a_handset

Add a Handset to a DECT Network

api.telephony.dect_devices.add_list_of_handsets

Add a List of Handsets 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.device_type_list

Read the DECT device type list

api.telephony.dect_devices.generate_and_enable_dect_serviceability_password

Generate and Enable DECT Serviceability Password

api.telephony.dect_devices.get_dect_serviceability_password_status

Get DECT Serviceability Password status

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_dect_serviceability_password_status

Update DECT Serviceability Password status

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.delete_background_images

Delete Device Background Images

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_background_images

Read the List of Background Images

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.supported_devices

Read the List of Supported Devices

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_third_party_device

Update Third Party Device

api.telephony.devices.update_workspace_device_settings

Update Device Settings for a Workspace

api.telephony.devices.upload_background_image

Upload a Device Background Image

api.telephony.devices.user_devices_count

Get User Devices Count

api.telephony.devices.validate_macs

Validate a list of MAC addresses

api.telephony.devices.dynamic_settings.get_customer_device_settings

Get Customer Device Dynamic Settings

api.telephony.devices.dynamic_settings.get_device_settings

Get Device Dynamic Settings

api.telephony.devices.dynamic_settings.get_location_device_settings

Get Location Device Dynamic Settings

api.telephony.devices.dynamic_settings.get_settings_groups

Get Settings Groups

api.telephony.devices.dynamic_settings.get_validation_schema

Get Validation Schema

api.telephony.devices.dynamic_settings.update_specified_settings_for_the_device

Update specified settings for the device

api.telephony.emergency_address.add_to_location

Add an Emergency Address to a Location

api.telephony.emergency_address.lookup_for_location

Emergency Address Lookup to Verify if Address is Valid

api.telephony.emergency_address.update_for_location

Update the Emergency Address of a Location

api.telephony.emergency_address.update_for_phone_number

Update the emergency address for a phone number

api.telephony.emergency_services.read_emergency_call_notification

Get an Organization Emergency Call Notification

api.telephony.emergency_services.update_emergency_call_notification

Update an organization emergency call notification

api.telephony.guest_calling.available_members

Read the Click-to-call Available Members

api.telephony.guest_calling.members

Read the Click-to-call Members

api.telephony.guest_calling.read

Read the Click-to-call Settings

api.telephony.guest_calling.update

Update the Click-to-call Settings

api.telephony.hotdesk.delete_session

Delete Session

api.telephony.hotdesk.list_sessions

List Sessions

api.telephony.hotdesking_voiceportal.location_get

Voice Portal Hot desking sign in details for a location

api.telephony.hotdesking_voiceportal.location_update

Update Voice Portal Hot desking sign in details for a location

api.telephony.hotdesking_voiceportal.user_get

Voice Portal Hot desking sign in details for a user

api.telephony.hotdesking_voiceportal.user_update

Update Voice Portal Hot desking sign in details for a user

api.telephony.huntgroup.alternate_available_phone_numbers

Get Hunt Group Alternate Available Phone Numbers

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.forward_available_phone_numbers

Get Hunt Group Call Forward Available Phone Numbers

api.telephony.huntgroup.list

Read the List of Hunt Groups

api.telephony.huntgroup.primary_available_phone_numbers

Get Hunt Group Primary Available Phone Numbers

api.telephony.huntgroup.update

Update a Hunt Group

api.telephony.huntgroup.forwarding.call_forwarding_rule

Retrieve a Selective Call Forwarding Rule’s settings for the designated Call Queue

api.telephony.huntgroup.forwarding.create_call_forwarding_rule

Create a Selective Call Forwarding Rule feature

api.telephony.huntgroup.forwarding.delete_call_forwarding_rule

Delete a Selective Call Forwarding Rule for the designated feature

api.telephony.huntgroup.forwarding.settings

Retrieve Call Forwarding settings for the designated feature including the list of call

api.telephony.huntgroup.forwarding.switch_mode_for_call_forwarding

Switch Mode for Call Forwarding Settings for an entity

api.telephony.huntgroup.forwarding.update

Update Call Forwarding Settings for a feature

api.telephony.huntgroup.forwarding.update_call_forwarding_rule

Update a Selective Call Forwarding Rule’s settings for the designated feature

api.telephony.jobs.activation_emails.errors

Get Bulk Activation Email Resend Job Errors

api.telephony.jobs.activation_emails.start

Initiate Bulk Activation Email Resend Job

api.telephony.jobs.activation_emails.status

Get Bulk Activation Email Resend Job Status

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.call_recording.errors

Get Job Errors for a Call Recording Job

api.telephony.jobs.call_recording.list

List Call Recording Jobs

api.telephony.jobs.call_recording.status

Get the Job Status of a Call Recording 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.disable_calling_location.errors

Retrieve Errors for a Disable Calling Location Job

api.telephony.jobs.disable_calling_location.initiate

Disable a Location for Webex Calling

api.telephony.jobs.disable_calling_location.list

Get a List of Disable Calling Location Jobs

api.telephony.jobs.disable_calling_location.pause

Pause a Disable Calling Location Job

api.telephony.jobs.disable_calling_location.resume

Resume a Paused Disable Calling Location Job

api.telephony.jobs.disable_calling_location.status

Get Disable Calling Location Job Status

api.telephony.jobs.dynamic_device_settings.errors

List Dynamic Device Settings Job Errors

api.telephony.jobs.dynamic_device_settings.list

List dynamic device settings jobs

api.telephony.jobs.dynamic_device_settings.status

Get Device Dynamic Settings Job Status

api.telephony.jobs.dynamic_device_settings.update_across_org_or_location

Updates dynamic Device Settings Across Organization Or Location

api.telephony.jobs.manage_numbers.abandon

Abandon the Manage Numbers Job

api.telephony.jobs.manage_numbers.errors

List Manage Numbers Job errors

api.telephony.jobs.manage_numbers.initiate_job

Initiate Number Jobs

api.telephony.jobs.manage_numbers.list

List Manage Numbers Jobs

api.telephony.jobs.manage_numbers.pause

Pause the Manage Numbers Job

api.telephony.jobs.manage_numbers.resume

Resume the Manage Numbers Job

api.telephony.jobs.manage_numbers.status

Get Manage Numbers Job Status

api.telephony.jobs.move_users.abandon

Abandon the Move Users Job

api.telephony.jobs.move_users.errors

List Move Users Job errors

api.telephony.jobs.move_users.list

List Move Users Jobs

api.telephony.jobs.move_users.pause

Pause the Move Users Job

api.telephony.jobs.move_users.resume

Resume the Move Users Job

api.telephony.jobs.move_users.status

Get Move Users Job Status

api.telephony.jobs.move_users.validate_or_initiate

Validate or Initiate Move Users 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.jobs.update_routing_prefix.errors

Get job errors for update routing prefix job

api.telephony.jobs.update_routing_prefix.list

Get a List of Update Routing Prefix jobs

api.telephony.jobs.update_routing_prefix.status

Get the job status of Update Routing Prefix job

api.telephony.location.call_intercept_available_phone_numbers

Get Location Call Intercept Available Phone Numbers

api.telephony.location.change_announcement_language

Change Announcement Language

api.telephony.location.charge_number_available_phone_numbers

Get Available Charge Numbers for a Location with Given Criteria

api.telephony.location.create_receptionist_contact_directory

Create a Receptionist Contact Directory

api.telephony.location.delete_receptionist_contact_directory

Delete a Receptionist Contact Directory

api.telephony.location.details

Get Location Webex Calling Details

api.telephony.location.device_settings

Get device override settings for a location

api.telephony.location.ecbn_available_phone_numbers

Get Location ECBN Available Phone Numbers

api.telephony.location.enable_for_calling

Enable a Location for Webex Calling

api.telephony.location.generate_password

Generate example password for Location

api.telephony.location.get_call_captions_settings

Get the location call captions settings

api.telephony.location.list

List Locations Webex Calling Details

api.telephony.location.list_receptionist_contact_directories

Read list of Receptionist Contact Directories

api.telephony.location.modify_receptionist_contact_directory

Modify a Receptionist Contact Directory

api.telephony.location.phone_numbers

Get Available Phone Numbers for a Location with Given Criteria

api.telephony.location.phone_numbers_available_for_external_caller_id

Get the List of Phone Numbers Available for External Caller ID

api.telephony.location.read_ecbn

Get a Location Emergency callback number

api.telephony.location.receptionist_contact_directory_details

Get details for a Receptionist Contact Directory

api.telephony.location.safe_delete_check_before_disabling_calling_location

Safe Delete Check Before Disabling a Location for Webex Calling

api.telephony.location.update

Update Location Webex Calling Details

api.telephony.location.update_call_captions_settings

Update the location call captions settings

api.telephony.location.update_ecbn

Update a Location Emergency callback number

api.telephony.location.validate_extensions

Validate Extensions

api.telephony.location.webex_go_available_phone_numbers

Get Webex Go Available Phone Numbers

api.telephony.location.emergency_services.read_emergency_call_notification

Get a Location Emergency Call Notification

api.telephony.location.emergency_services.update_emergency_call_notification

Update a location emergency call notification

api.telephony.location.intercept.configure

Put Location Intercept

api.telephony.location.intercept.read

Get Location Intercept

api.telephony.location.internal_dialing.read

Read the Internal Dialing configuration for a location

api.telephony.location.internal_dialing.update

Modify the Internal Dialing configuration for a location

api.telephony.location.internal_dialing.url

api.telephony.location.moh.read

Get Music On Hold

api.telephony.location.moh.update

Update Music On Hold

api.telephony.location.number.activate

Activate Phone Numbers in a location

api.telephony.location.number.add

Add Phone Numbers to a location

api.telephony.location.number.manage_number_state

Manage Number State in a location

api.telephony.location.number.remove

Remove phone numbers from a location

api.telephony.location.permissions_out.configure

Configure Outgoing Calling Permissions Settings

api.telephony.location.permissions_out.read

Retrieve Outgoing Calling Permissions Settings

api.telephony.location.permissions_out.digit_patterns.create

Create Digit Patterns

api.telephony.location.permissions_out.digit_patterns.delete

Delete a Digit Pattern

api.telephony.location.permissions_out.digit_patterns.delete_all

Delete all Digit Patterns

api.telephony.location.permissions_out.digit_patterns.details

Retrieve Digit Pattern Details

api.telephony.location.permissions_out.digit_patterns.get_digit_patterns

Retrieve Digit Patterns

api.telephony.location.permissions_out.digit_patterns.update

Modify Digit Patterns

api.telephony.location.permissions_out.digit_patterns.update_category_control_settings

Modify the Digit Pattern Category Control Settings for the entity

api.telephony.location.permissions_out.transfer_numbers.configure

Modify Transfer Numbers Settings for an entity

api.telephony.location.permissions_out.transfer_numbers.read

Retrieve Transfer Numbers Settings

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

Update Location Voicemail

api.telephony.locations.call_intercept_available_phone_numbers

Get Location Call Intercept Available Phone Numbers

api.telephony.locations.change_announcement_language

Change Announcement Language

api.telephony.locations.charge_number_available_phone_numbers

Get Available Charge Numbers for a Location with Given Criteria

api.telephony.locations.create_receptionist_contact_directory

Create a Receptionist Contact Directory

api.telephony.locations.delete_receptionist_contact_directory

Delete a Receptionist Contact Directory

api.telephony.locations.details

Get Location Webex Calling Details

api.telephony.locations.device_settings

Get device override settings for a location

api.telephony.locations.ecbn_available_phone_numbers

Get Location ECBN Available Phone Numbers

api.telephony.locations.enable_for_calling

Enable a Location for Webex Calling

api.telephony.locations.generate_password

Generate example password for Location

api.telephony.locations.get_call_captions_settings

Get the location call captions settings

api.telephony.locations.list

List Locations Webex Calling Details

api.telephony.locations.list_receptionist_contact_directories

Read list of Receptionist Contact Directories

api.telephony.locations.modify_receptionist_contact_directory

Modify a Receptionist Contact Directory

api.telephony.locations.phone_numbers

Get Available Phone Numbers for a Location with Given Criteria

api.telephony.locations.phone_numbers_available_for_external_caller_id

Get the List of Phone Numbers Available for External Caller ID

api.telephony.locations.read_ecbn

Get a Location Emergency callback number

api.telephony.locations.receptionist_contact_directory_details

Get details for a Receptionist Contact Directory

api.telephony.locations.safe_delete_check_before_disabling_calling_location

Safe Delete Check Before Disabling a Location for Webex Calling

api.telephony.locations.update

Update Location Webex Calling Details

api.telephony.locations.update_call_captions_settings

Update the location call captions settings

api.telephony.locations.update_ecbn

Update a Location Emergency callback number

api.telephony.locations.validate_extensions

Validate Extensions

api.telephony.locations.webex_go_available_phone_numbers

Get Webex Go Available Phone Numbers

api.telephony.locations.emergency_services.read_emergency_call_notification

Get a Location Emergency Call Notification

api.telephony.locations.emergency_services.update_emergency_call_notification

Update a location emergency call notification

api.telephony.locations.intercept.configure

Put Location Intercept

api.telephony.locations.intercept.read

Get Location Intercept

api.telephony.locations.internal_dialing.read

Read the Internal Dialing configuration for a location

api.telephony.locations.internal_dialing.update

Modify the Internal Dialing configuration for a location

api.telephony.locations.internal_dialing.url

api.telephony.locations.moh.read

Get Music On Hold

api.telephony.locations.moh.update

Update Music On Hold

api.telephony.locations.number.activate

Activate Phone Numbers in a location

api.telephony.locations.number.add

Add Phone Numbers to a location

api.telephony.locations.number.manage_number_state

Manage Number State in a location

api.telephony.locations.number.remove

Remove phone numbers from a location

api.telephony.locations.permissions_out.configure

Configure Outgoing Calling Permissions Settings

api.telephony.locations.permissions_out.read

Retrieve Outgoing Calling Permissions Settings

api.telephony.locations.permissions_out.digit_patterns.create

Create Digit Patterns

api.telephony.locations.permissions_out.digit_patterns.delete

Delete a Digit Pattern

api.telephony.locations.permissions_out.digit_patterns.delete_all

Delete all Digit Patterns

api.telephony.locations.permissions_out.digit_patterns.details

Retrieve Digit Pattern Details

api.telephony.locations.permissions_out.digit_patterns.get_digit_patterns

Retrieve Digit Patterns

api.telephony.locations.permissions_out.digit_patterns.update

Modify Digit Patterns

api.telephony.locations.permissions_out.digit_patterns.update_category_control_settings

Modify the Digit Pattern Category Control Settings for the entity

api.telephony.locations.permissions_out.transfer_numbers.configure

Modify Transfer Numbers Settings for an entity

api.telephony.locations.permissions_out.transfer_numbers.read

Retrieve Transfer Numbers Settings

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

Update Location Voicemail

api.telephony.ms_teams.configure

Update an Organization’s MS Teams Setting

api.telephony.ms_teams.read

Get an Organization’s MS Teams Settings

api.telephony.operating_modes.available_operating_modes

Retrieve the List of Available Operating Modes in a Location

api.telephony.operating_modes.call_forward_available_phone_numbers

Get Operating Mode Call Forward Available Phone Numbers

api.telephony.operating_modes.create

Create an Operating Mode

api.telephony.operating_modes.delete

Delete an Operating Mode

api.telephony.operating_modes.details

Get Details for an Operating Mode

api.telephony.operating_modes.holiday_create

Create an Operating Mode Holiday

api.telephony.operating_modes.holiday_delete

Delete an Operating Mode Holiday

api.telephony.operating_modes.holiday_details

Get details for an Operating Mode Holiday

api.telephony.operating_modes.holiday_update

Modify an Operating Mode Holiday

api.telephony.operating_modes.list

Read the List of Operating Modes

api.telephony.operating_modes.update

Modify an Operating Mode

api.telephony.organisation_access_codes.create

Create Access Codes for an Organisation

api.telephony.organisation_access_codes.delete

Delete Outgoing Permission Access Code for an Organisation

api.telephony.organisation_access_codes.list

Retrieve the organisation’s access codes

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.primary_available_phone_numbers

Get Paging Group Primary Available Phone Numbers

api.telephony.paging.update

Update a 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 an entity

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.playlist.assigned_locations

Fetch list of locations which are assigned to the announcement playlist

api.telephony.playlist.create

Create announcement Playlist at organization level

api.telephony.playlist.delete

Delete an announcement playlist for an organization

api.telephony.playlist.details

Fetch details of announcement playlist at the organization level

api.telephony.playlist.list

Fetch list of announcement playlist on organization level

api.telephony.playlist.modify

Modify announcement playlist at organization level

api.telephony.playlist.modify_assigned_locations

Modify list of assigned locations to the announcement playlist

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

Read the List of Dial Patterns

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

Read the Usage of a Routing Group

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

Read the Route Lists of a Routing 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 Route List

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.pstn.configure

Setup PSTN Connection for a Location

api.telephony.pstn.list

Retrieve PSTN Connection Options for a Location

api.telephony.pstn.read

Retrieve PSTN Connection for a Location

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.supervisors.assign_unassign_agents

Assign or Unassign Agents to Supervisor

api.telephony.supervisors.available_agents

List Available Agents

api.telephony.supervisors.available_supervisors

List Available Supervisors

api.telephony.supervisors.create

Create a Supervisor

api.telephony.supervisors.delete

Delete A Supervisor

api.telephony.supervisors.delete_bulk

Delete Bulk supervisors

api.telephony.supervisors.details

GET Supervisor Details

api.telephony.supervisors.list

Get List of Supervisors

api.telephony.virtual_extensions.create_extension

Create a Virtual Extension

api.telephony.virtual_extensions.create_range

Create a Virtual Extension Range

api.telephony.virtual_extensions.delete_extension

Delete a Virtual Extension

api.telephony.virtual_extensions.delete_range

Delete a Virtual Extension Range

api.telephony.virtual_extensions.details_extension

Get a Virtual Extension

api.telephony.virtual_extensions.details_range

Get details of a Virtual Extension Range

api.telephony.virtual_extensions.get_extension_settings

Get Virtual extension settings

api.telephony.virtual_extensions.list_extensions

Read the List of Virtual Extensions

api.telephony.virtual_extensions.list_range

Get a list of a Virtual Extension Range

api.telephony.virtual_extensions.modify_extension_settings

Modify Virtual Extension Settings

api.telephony.virtual_extensions.modify_range

Modify Virtual Extension Range

api.telephony.virtual_extensions.update_extension

Update a Virtual Extension

api.telephony.virtual_extensions.validate_external_phone_number

Validate an external phone number

api.telephony.virtual_extensions.validate_range

Validate the prefix and extension pattern for a Virtual Extension Range

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.agent_caller_id.available_caller_ids

Retrieve Agent’s List of Available Caller IDs

api.telephony.virtual_lines.agent_caller_id.configure

Modify Agent’s Caller ID Information

api.telephony.virtual_lines.agent_caller_id.read

Retrieve Agent’s Caller ID Information

api.telephony.virtual_lines.available_numbers.available

Get Available Phone Numbers

api.telephony.virtual_lines.available_numbers.call_forward

Get Call Forward Available Phone Numbers

api.telephony.virtual_lines.available_numbers.call_intercept

Get Call Intercept Available Phone Numbers

api.telephony.virtual_lines.available_numbers.ecbn

Get ECBN Available Phone Numbers

api.telephony.virtual_lines.available_numbers.fax_message

Get Fax Message Available Phone Numbers

api.telephony.virtual_lines.available_numbers.primary

Get Person Primary Available Phone Numbers

api.telephony.virtual_lines.available_numbers.secondary

Get Person Secondary Available Phone Numbers

api.telephony.virtual_lines.barge.configure

Configure Barge In Settings

api.telephony.virtual_lines.barge.read

Retrieve Barge In Settings

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.dnd.configure

Configure Do Not Disturb Settings for an entity

api.telephony.virtual_lines.dnd.read

Read Do Not Disturb Settings for an entity

api.telephony.virtual_lines.ecbn.configure

Update an entity’s Emergency Callback Number

api.telephony.virtual_lines.ecbn.dependencies

Retrieve an entity’s Emergency Callback Number Dependencies

api.telephony.virtual_lines.ecbn.read

Get an entity’s Emergency Callback Number

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.music_on_hold.configure

Configure Music On Hold Settings for a Personvirtual line, or workspace

api.telephony.virtual_lines.music_on_hold.read

Retrieve Music On Hold Settings for a Person, virtual line, or workspace

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 an entity

api.telephony.virtual_lines.permissions_out.transfer_numbers.read

Retrieve Transfer Numbers Settings

api.telephony.virtual_lines.privacy.configure

Configure an entity’s Privacy Settings

api.telephony.virtual_lines.privacy.read

Get Privacy Settings for an entity

api.telephony.virtual_lines.push_to_talk.configure

Configure Push-to-Talk Settings for an entity

api.telephony.virtual_lines.push_to_talk.read

Read Push-to-Talk Settings for an entity

api.telephony.virtual_lines.voicemail.configure

Configure Voicemail Settings for an entity

api.telephony.virtual_lines.voicemail.configure_busy_greeting

Configure Busy Voicemail Greeting for an entity

api.telephony.virtual_lines.voicemail.configure_no_answer_greeting

Configure No Answer Voicemail Greeting for an entity

api.telephony.virtual_lines.voicemail.modify_passcode

Modify an entity’s voicemail passcode

api.telephony.virtual_lines.voicemail.read

Read Voicemail Settings for an entity

api.telephony.virtual_lines.voicemail.reset_pin

Reset Voicemail PIN

api.telephony.voice_messaging.delete

Delete a specific 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.available_phone_numbers

Get Voicemail Group Available Phone Numbers

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.fax_message_available_phone_numbers

Get Voicemail Group Fax Message Available Phone Numbers

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.available_phone_numbers

Get VoicePortal Available Phone Numbers

api.telephony.voiceportal.passcode_rules

Get VoicePortal Passcode Rule

api.telephony.voiceportal.read

Get VoicePortal

api.telephony.voiceportal.update

Update VoicePortal

api.webhook.create

Creates a webhook

api.webhook.details

Get Webhook Details

api.webhook.list

List 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.anon_calls.configure

Modify Anonymous Call Settings for an entity

api.workspace_settings.anon_calls.read

Retrieve Anonymous Call Settings for an entity

api.workspace_settings.available_numbers.available

Get Available Phone Numbers

api.workspace_settings.available_numbers.call_forward

Get Call Forward Available Phone Numbers

api.workspace_settings.available_numbers.call_intercept

Get Call Intercept Available Phone Numbers

api.workspace_settings.available_numbers.ecbn

Get ECBN Available Phone Numbers

api.workspace_settings.available_numbers.fax_message

Get Fax Message Available Phone Numbers

api.workspace_settings.available_numbers.primary

Get Person Primary Available Phone Numbers

api.workspace_settings.available_numbers.secondary

Get Person Secondary Available Phone Numbers

api.workspace_settings.barge.configure

Configure Barge In Settings

api.workspace_settings.barge.read

Retrieve Barge In Settings

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_policy.configure

Configure Call Policy Settings for an entity

api.workspace_settings.call_policy.read

Read Call Policy Settings for an entity

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.list_and_counts

Get all devices for a workspace

api.workspace_settings.devices.modify_hoteling

Modify devices for a workspace

api.workspace_settings.dnd.configure

Configure Do Not Disturb Settings for an entity

api.workspace_settings.dnd.read

Read Do Not Disturb Settings for an entity

api.workspace_settings.ecbn.configure

Update an entity’s Emergency Callback Number

api.workspace_settings.ecbn.dependencies

Retrieve an entity’s Emergency Callback Number Dependencies

api.workspace_settings.ecbn.read

Get an entity’s Emergency Callback Number

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

Modify an entity’s Monitoring Settings

api.workspace_settings.monitoring.read

Retrieve an entity’s Monitoring Settings

api.workspace_settings.music_on_hold.configure

Configure Music On Hold Settings for a Personvirtual line, or workspace

api.workspace_settings.music_on_hold.read

Retrieve Music On Hold Settings for a Person, virtual line, or workspace

api.workspace_settings.numbers.read

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

api.workspace_settings.numbers.update

Assign or Unassign numbers associated with a specific workspace

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 an entity

api.workspace_settings.permissions_out.transfer_numbers.read

Retrieve Transfer Numbers Settings

api.workspace_settings.priority_alert.configure

Configure Priority Alert Settings for a Workspace

api.workspace_settings.priority_alert.configure_criteria

Modify Priority Alert Criteria for a Workspace

api.workspace_settings.priority_alert.create_criteria

Create Priority Alert Criteria for a Workspace

api.workspace_settings.priority_alert.delete_criteria

Delete Priority Alert Criteria for a Workspace

api.workspace_settings.priority_alert.read

Retrieve Priority Alert Settings for a Workspace

api.workspace_settings.priority_alert.read_criteria

Retrieve Priority Alert Criteria for a Workspace

api.workspace_settings.privacy.configure

Configure an entity’s Privacy Settings

api.workspace_settings.privacy.read

Get Privacy Settings for an entity

api.workspace_settings.push_to_talk.configure

Configure Push-to-Talk Settings for an entity

api.workspace_settings.push_to_talk.read

Read Push-to-Talk Settings for an entity

api.workspace_settings.selective_accept.configure

Modify Selective Accept Settings for an entity

api.workspace_settings.selective_accept.configure_criteria

Modify Selective Accept Criteria for an entity

api.workspace_settings.selective_accept.create_criteria

Create Selective Accept Criteria for an entity

api.workspace_settings.selective_accept.delete_criteria

Delete Selective Accept Criteria for an entity

api.workspace_settings.selective_accept.read

Retrieve Selective Accept Settings for an entity

api.workspace_settings.selective_accept.read_criteria

Retrieve Selective Accept Criteria for an entity

api.workspace_settings.selective_forward.configure

Modify Selective Forward Settings for a Workspace

api.workspace_settings.selective_forward.configure_criteria

Modify Selective Forward Criteria for a Workspace

api.workspace_settings.selective_forward.create_criteria

Create Selective Forward Criteria for a Workspace

api.workspace_settings.selective_forward.delete_criteria

Delete Selective Forward Criteria for a Workspace

api.workspace_settings.selective_forward.read

Retrieve Selective Forward Settings for a Workspace

api.workspace_settings.selective_forward.read_criteria

Retrieve Selective Forward Criteria for a Workspace

api.workspace_settings.selective_reject.configure

Modify Selective Reject Settings for an entity

api.workspace_settings.selective_reject.configure_criteria

Modify Selective Reject Criteria for an entity

api.workspace_settings.selective_reject.create_criteria

Create Selective Reject Criteria for an entity

api.workspace_settings.selective_reject.delete_criteria

Delete Selective Reject Criteria for an entity

api.workspace_settings.selective_reject.read

Retrieve Selective Reject Settings for an entity

api.workspace_settings.selective_reject.read_criteria

Retrieve Selective Reject Criteria for an entity

api.workspace_settings.sequential_ring.configure

Modify sequential ring settings for an entity

api.workspace_settings.sequential_ring.configure_criteria

Modify sequential ring criteria for an entity

api.workspace_settings.sequential_ring.create_criteria

Create sequential ring criteria for an entity

api.workspace_settings.sequential_ring.delete_criteria

Delete sequential ring criteria for an entity

api.workspace_settings.sequential_ring.read

Retrieve sequential ring settings for an entity

api.workspace_settings.sequential_ring.read_criteria

Retrieve sequential ring criteria for an entity

api.workspace_settings.sim_ring.configure

Modify Simultaneous Ring Settings for an entity

api.workspace_settings.sim_ring.configure_criteria

Modify Simultaneous Ring Criteria for an entity

api.workspace_settings.sim_ring.create_criteria

Create Simultaneous Ring Criteria for an entity

api.workspace_settings.sim_ring.delete_criteria

Delete Simultaneous Ring Criteria for an entity

api.workspace_settings.sim_ring.read

Retrieve Simultaneous Ring Settings for an entity

api.workspace_settings.sim_ring.read_criteria

Retrieve Simultaneous Ring Criteria for an entity

api.workspace_settings.voicemail.configure

Configure Voicemail Settings for an entity

api.workspace_settings.voicemail.configure_busy_greeting

Configure Busy Voicemail Greeting for an entity

api.workspace_settings.voicemail.configure_no_answer_greeting

Configure No Answer Voicemail Greeting for an entity

api.workspace_settings.voicemail.modify_passcode

Modify an entity’s voicemail passcode

api.workspace_settings.voicemail.read

Read Voicemail Settings for an entity

api.workspace_settings.voicemail.reset_pin

Reset Voicemail PIN

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

Update a Workspace

api.xapi.execute_command

Execute Command

api.xapi.query_status

Query Status

api.xapi.system_unit_boot

Reboot the device