api.close |
close()
|
- api.groups.create
Create a new group using the provided settings
|
create()
|
- api.groups.delete_group
Delete a group
|
delete_group()
|
- api.groups.details
Get group details
|
details()
|
- api.groups.list
List groups
|
list()
|
- api.groups.members
Query members of a group
|
members()
|
- api.groups.update
update group information
|
update()
|
- api.licenses.details
Shows details for a license, by ID
|
details()
|
- api.licenses.list
List all licenses for a given organization
|
list()
|
- api.locations.by_name
Get a location by name
|
by_name()
|
- api.locations.details
Shows details for a location, by ID
|
details()
|
- api.locations.list
List locations for an organization
|
list()
|
- api.people.create
Create a Person
|
create()
|
- api.people.delete_person
Remove a person from the system
|
delete_person()
|
- api.people.details
Shows details for a person, by ID
|
details()
|
- api.people.list
List people in your organization
|
list()
|
- api.people.me
Show the profile for the authenticated user
|
me()
|
- api.people.update
Update details for a person, by ID
|
update()
|
- api.person_settings.reset_vm_pin
Reset Voicemail PIN
|
reset_vm_pin()
|
- api.person_settings.appservices.configure
Modify a Person’s Application Services Settings
|
configure()
|
- api.person_settings.appservices.read
Retrieve a Person’s Application Services Settings
|
read()
|
- api.person_settings.barge.configure
Configure a Person’s Barge In Settings
|
configure()
|
- api.person_settings.barge.read
Retrieve a Person’s Barge In Settings
|
read()
|
- api.person_settings.call_intercept.configure
Configure Call Intercept Settings for a Person
|
configure()
|
- api.person_settings.call_intercept.greeting
Configure Call Intercept Greeting for a Person
|
greeting()
|
- api.person_settings.call_intercept.read
Read Call Intercept Settings for a Person
|
read()
|
- api.person_settings.call_recording.configure
Configure Call Recording Settings for a Person
|
configure()
|
- api.person_settings.call_recording.read
Read Call Recording Settings for a Person
|
read()
|
- api.person_settings.call_waiting.configure
Configure Call Waiting Settings for a Person
|
configure()
|
- api.person_settings.call_waiting.read
Read Call Waiting Settings for a Person
|
read()
|
- api.person_settings.caller_id.configure
Configure a Person’s Caller ID Settings
|
configure()
|
- api.person_settings.caller_id.read
Retrieve a Person’s Caller ID Settings
|
read()
|
- api.person_settings.calling_behavior.configure
Configure a Person’s Calling Behavior
|
configure()
|
- api.person_settings.calling_behavior.read
Read Person’s Calling Behavior
|
read()
|
- api.person_settings.dnd.configure
Configure Do Not Disturb Settings for a Person
|
configure()
|
- api.person_settings.dnd.read
Read Do Not Disturb Settings for a Person
|
read()
|
- api.person_settings.exec_assistant.configure
Modify Executive Assistant Settings for a Person
|
configure()
|
- api.person_settings.exec_assistant.read
Retrieve Executive Assistant Settings for a Person
|
read()
|
- api.person_settings.forwarding.configure
Configure a Person’s Call Forwarding Settings
|
configure()
|
- api.person_settings.forwarding.read
Retrieve a Person’s Call Forwarding Settings
|
read()
|
- api.person_settings.hoteling.configure
Configure Hoteling Settings for a Person
|
configure()
|
- api.person_settings.hoteling.read
Read Hoteling Settings for a Person
|
read()
|
- api.person_settings.monitoring.configure
Configure Call Waiting Settings for a Person
|
configure()
|
- api.person_settings.monitoring.read
Retrieve a Person’s Monitoring Settings
|
read()
|
- api.person_settings.numbers.read
Read Do Not Disturb Settings for a Person
|
read()
|
- api.person_settings.numbers.update
Assign or unassign alternate phone numbers to a person
|
update()
|
- api.person_settings.permissions_in.configure
Configure a Person’s Barge In Settings
|
configure()
|
- api.person_settings.permissions_in.read
Read Incoming Permission Settings for a Person
|
read()
|
- api.person_settings.permissions_out.configure
Configure a Person’s Outgoing Calling Permissions Settings
|
configure()
|
- api.person_settings.permissions_out.read
Retrieve a Person’s Outgoing Calling Permissions Settings
|
read()
|
- api.person_settings.privacy.configure
Configure Call Waiting Settings for a Person
|
configure()
|
- api.person_settings.privacy.read
Get a person’s Privacy Settings
|
read()
|
- api.person_settings.push_to_talk.configure
Configure Push-to-Talk Settings for a Person
|
configure()
|
- api.person_settings.push_to_talk.read
Read Push-to-Talk Settings for a Person
|
read()
|
- api.person_settings.receptionist.configure
Modify Executive Assistant Settings for a Person
|
configure()
|
- api.person_settings.receptionist.read
Read Receptionist Client Settings for a Person
|
read()
|
- api.person_settings.schedules.create
Create a Schedule
|
create()
|
- api.person_settings.schedules.delete_schedule
Delete a Schedule
|
delete_schedule()
|
- api.person_settings.schedules.details
Get Details for a Schedule
|
details()
|
- api.person_settings.schedules.event_create
Create a Schedule Event
|
event_create()
|
- api.person_settings.schedules.event_delete
Delete a Schedule Event
|
event_delete()
|
- api.person_settings.schedules.event_details
Get Details for a Schedule Event
|
event_details()
|
- api.person_settings.schedules.event_update
Update a Schedule Event
|
event_update()
|
- api.person_settings.schedules.list
List of Schedules for a Person or location
|
list()
|
- api.person_settings.schedules.update
Update a Schedule
|
update()
|
- api.person_settings.voicemail.configure
Configure Voicemail Settings for a Person
|
configure()
|
- api.person_settings.voicemail.configure_busy_greeting
Configure Busy Voicemail Greeting for a Person
|
configure_busy_greeting()
|
- api.person_settings.voicemail.configure_no_answer_greeting
Configure No Answer Voicemail Greeting for a Person
|
configure_no_answer_greeting()
|
- api.person_settings.voicemail.read
Read Voicemail Settings for a Person
|
read()
|
- api.telephony.change_announcement_language
Change Announcement Language
|
change_announcement_language()
|
- api.telephony.phone_number_details
get summary (counts) of phone numbers
|
phone_number_details()
|
- api.telephony.phone_numbers
Get Phone Numbers for an Organization with given criteria
|
phone_numbers()
|
- api.telephony.route_choices
List all Routes for the organization
|
route_choices()
|
- api.telephony.test_call_routing
Validates that an incoming call can be routed
|
test_call_routing()
|
- api.telephony.ucm_profiles
Read the List of UC Manager Profiles
|
ucm_profiles()
|
- api.telephony.validate_extensions
Validate the List of Extensions
|
validate_extensions()
|
- api.telephony.validate_phone_numbers
Validate the list of phone numbers in an organization
|
validate_phone_numbers()
|
- api.telephony.access_codes.create
Create access code in location
|
create()
|
- api.telephony.access_codes.delete_codes
Delete Access Code Location
|
delete_codes()
|
- api.telephony.access_codes.read
Get Location Access Code
|
read()
|
- api.telephony.auto_attendant.by_name
Get auto attendant info by name
|
by_name()
|
- api.telephony.auto_attendant.create
Create an Auto Attendant
|
create()
|
- api.telephony.auto_attendant.delete_auto_attendant
elete the designated Auto Attendant
|
delete_auto_attendant()
|
- api.telephony.auto_attendant.details
Get Details for an Auto Attendant
|
details()
|
- api.telephony.auto_attendant.list
Read the List of Auto Attendants
|
list()
|
- api.telephony.auto_attendant.update
Update an Auto Attendant
|
update()
|
- api.telephony.callpark.available_agents
Get available agents from Call Parks
|
available_agents()
|
- api.telephony.callpark.available_recalls
Get available recall hunt groups from Call Parks
|
available_recalls()
|
- api.telephony.callpark.call_park_settings
Get Call Park Settings
|
call_park_settings()
|
- api.telephony.callpark.create
Create a Call Park
|
create()
|
- api.telephony.callpark.delete_callpark
Delete a Call Park
|
delete_callpark()
|
- api.telephony.callpark.details
Get Details for a Call Park
|
details()
|
- api.telephony.callpark.list
Read the List of Call Parks
|
list()
|
- api.telephony.callpark.update
Update a Call Park
|
update()
|
- api.telephony.callpark.update_call_park_settings
Update Call Park settings
|
update_call_park_settings()
|
- api.telephony.callpark_extension.details
Get Details for a Call Park Extension
|
details()
|
- api.telephony.callpark_extension.list
Read the List of Call Park Extensions
|
list()
|
- api.telephony.calls.answer
Answer an incoming call on the user’s primary device
|
answer()
|
- api.telephony.calls.barge_in
Barge-in on another user’s answered call
|
barge_in()
|
- api.telephony.calls.call_details
Get the details of the specified active call for the user
|
call_details()
|
- api.telephony.calls.call_history
List Call History
|
call_history()
|
- api.telephony.calls.dial
Initiate an outbound call to a specified destination
|
dial()
|
- api.telephony.calls.divert
Divert a call to a destination or a user’s voicemail
|
divert()
|
- api.telephony.calls.hangup
Hangup a call
|
hangup()
|
- api.telephony.calls.hold
Hold a connected call
|
hold()
|
- api.telephony.calls.list_calls
Get the list of details for all active calls associated with the user
|
list_calls()
|
- api.telephony.calls.park
Park a connected call
|
park()
|
- api.telephony.calls.pause_recording
Pause recording on a call
|
pause_recording()
|
- api.telephony.calls.pickup
Picks up an incoming call to another user
|
pickup()
|
- api.telephony.calls.push
Pushes a call from the assistant to the executive the call is associated with
|
push()
|
- api.telephony.calls.reject
Reject an unanswered incoming call
|
reject()
|
- api.telephony.calls.resume
Resume a held call
|
resume()
|
- api.telephony.calls.resume_recording
Resume recording a call
|
resume_recording()
|
- api.telephony.calls.retrieve
- param destination
Identifies where the call is parked
|
retrieve()
|
- api.telephony.calls.start_recording
Start recording a call
|
start_recording()
|
- api.telephony.calls.stop_recording
Stop recording a call
|
stop_recording()
|
- api.telephony.calls.transfer
Transfer two calls together
|
transfer()
|
- api.telephony.calls.transmit_dtmf
Transmit DTMF digits to a call
|
transmit_dtmf()
|
- api.telephony.huntgroup.by_name
Get hunt group info by name
|
by_name()
|
- api.telephony.huntgroup.create
Create a Hunt Group
|
create()
|
- api.telephony.huntgroup.delete_huntgroup
Delete a Hunt Group
|
delete_huntgroup()
|
- api.telephony.huntgroup.details
Get Details for a Hunt Group
|
details()
|
- api.telephony.huntgroup.list
Read the List of Hunt Groups
|
list()
|
- api.telephony.huntgroup.update
Update a Hunt Group
|
update()
|
- api.telephony.location.generate_password
Generates an example password using the effective password settings for the location
|
generate_password()
|
- api.telephony.location.validate_extensions
Validate extensions for a specific location
|
validate_extensions()
|
- api.telephony.location.intercept.configure
Put Location Intercept
|
configure()
|
- api.telephony.location.intercept.read
Get Location Intercept
|
read()
|
- api.telephony.location.internal_dialing.read
Get current configuration for routing unknown extensions to the Premises as internal calls
|
read()
|
- api.telephony.location.internal_dialing.update
Modify current configuration for routing unknown extensions to the Premises as internal calls
|
update()
|
api.telephony.location.internal_dialing.url |
url()
|
- api.telephony.location.moh.create
- param location_id
Add new access code for this location
|
create()
|
- api.telephony.location.moh.delete_codes
Delete Access Code Location
|
delete_codes()
|
- api.telephony.location.moh.read
Get Music On Hold
|
read()
|
- api.telephony.location.moh.update
Get Music On Hold
|
update()
|
- api.telephony.location.number.activate
Activate the specified set of phone numbers in a location for an organization
|
activate()
|
- api.telephony.location.number.add
Adds specified set of phone numbers to a location for an organization
|
add()
|
- api.telephony.location.number.remove
Remove the specified set of phone numbers from a location for an organization
|
remove()
|
- api.telephony.location.voicemail.read
Get Location Voicemail
|
read()
|
- api.telephony.location.voicemail.update
Get Location Voicemail
|
update()
|
- api.telephony.organisation_voicemail.read
Get Voicemail Settings
|
read()
|
- api.telephony.organisation_voicemail.update
Update the organization’s voicemail settings
|
update()
|
- api.telephony.paging.create
Create a new Paging Group
|
create()
|
- api.telephony.paging.delete_paging
Delete a Paging Group
|
delete_paging()
|
- api.telephony.paging.details
Get Details for a Paging Group
|
details()
|
- api.telephony.paging.list
Read the List of Paging Groups
|
list()
|
- api.telephony.paging.update
Update the designated Paging Group
|
update()
|
- api.telephony.permissions_out.configure
Configure a Person’s Outgoing Calling Permissions Settings
|
configure()
|
- api.telephony.permissions_out.read
Retrieve a Person’s Outgoing Calling Permissions Settings
|
read()
|
- api.telephony.permissions_out.transfer_numbers.configure
Modify Transfer Numbers Settings for a Place
|
configure()
|
- api.telephony.permissions_out.transfer_numbers.read
Retrieve Transfer Numbers Settings for a Workspace
|
read()
|
- api.telephony.pickup.available_agents
Get available agents from Call Pickups
|
available_agents()
|
- api.telephony.pickup.create
Create a Call Pickup
|
create()
|
- api.telephony.pickup.delete_pickup
Delete a Call Pickup
|
delete_pickup()
|
- api.telephony.pickup.details
Get Details for a Call Pickup
|
details()
|
- api.telephony.pickup.list
Read the List of Call Pickups
|
list()
|
- api.telephony.pickup.update
Update a Call Pickup
|
update()
|
- api.telephony.pnc.read
Get Private Network Connect
|
read()
|
- api.telephony.pnc.update
Get Private Network Connect
|
update()
|
- api.telephony.prem_pstn.validate_pattern
Validate a Dial Pattern
|
validate_pattern()
|
- api.telephony.prem_pstn.dial_plan.create
Create a Dial Plan for the organization
|
create()
|
- api.telephony.prem_pstn.dial_plan.delete_all_patterns
Delete all dial patterns from the Dial Plan
|
delete_all_patterns()
|
- api.telephony.prem_pstn.dial_plan.delete_dial_plan
Delete a Dial Plan for the organization
|
delete_dial_plan()
|
- api.telephony.prem_pstn.dial_plan.details
Get a Dial Plan for the organization
|
details()
|
- api.telephony.prem_pstn.dial_plan.list
List all Dial Plans for the organization
|
list()
|
- api.telephony.prem_pstn.dial_plan.modify_patterns
Modify dial patterns for the Dial Plan
|
modify_patterns()
|
- api.telephony.prem_pstn.dial_plan.patterns
List all Dial Patterns for the organization
|
patterns()
|
- api.telephony.prem_pstn.dial_plan.update
Modify a Dial Plan for the organization
|
update()
|
- api.telephony.prem_pstn.route_group.create
Creates a Route Group for the organization
|
create()
|
- api.telephony.prem_pstn.route_group.delete_route_group
Remove a Route Group from an Organization based on id
|
delete_route_group()
|
- api.telephony.prem_pstn.route_group.details
Reads a Route Group for the organization based on id
|
details()
|
- api.telephony.prem_pstn.route_group.list
List all Route Groups for an organization
|
list()
|
- api.telephony.prem_pstn.route_group.update
Modifies an existing Route Group for an organization based on id
|
update()
|
- api.telephony.prem_pstn.route_group.usage
List the number of “Call to” on-premises Extensions, Dial Plans, PSTN Connections, and Route Lists used by a
|
usage()
|
- api.telephony.prem_pstn.route_group.usage_call_to_extension
List “Call to” on-premises Extension Locations for a specific route group
|
usage_call_to_extension()
|
- api.telephony.prem_pstn.route_group.usage_dial_plan
List Dial Plan Locations for a specific route group
|
usage_dial_plan()
|
- api.telephony.prem_pstn.route_group.usage_location_pstn
List PSTN Connection Locations for a specific route group
|
usage_location_pstn()
|
- api.telephony.prem_pstn.route_group.usage_route_lists
List Route Lists for a specific route group
|
usage_route_lists()
|
api.telephony.prem_pstn.route_list.create |
create()
|
api.telephony.prem_pstn.route_list.delete_all_numbers |
delete_all_numbers()
|
api.telephony.prem_pstn.route_list.delete_route_list |
delete_route_list()
|
api.telephony.prem_pstn.route_list.details |
details()
|
api.telephony.prem_pstn.route_list.list |
list()
|
api.telephony.prem_pstn.route_list.numbers |
numbers()
|
api.telephony.prem_pstn.route_list.update |
update()
|
api.telephony.prem_pstn.route_list.update_numbers |
update_numbers()
|
- api.telephony.prem_pstn.trunk.create
Create a Trunk for the organization
|
create()
|
- api.telephony.prem_pstn.trunk.delete_trunk
Delete a Trunk for the organization
|
delete_trunk()
|
- api.telephony.prem_pstn.trunk.details
Get a Trunk for the organization
|
details()
|
- api.telephony.prem_pstn.trunk.list
List all Trunks for the organization
|
list()
|
- api.telephony.prem_pstn.trunk.trunk_types
List all TrunkTypes with DeviceTypes for the organization
|
trunk_types()
|
- api.telephony.prem_pstn.trunk.update
Modify a Trunk for the organization
|
update()
|
- api.telephony.prem_pstn.trunk.usage
Get Local Gateway Usage Count
|
usage()
|
- api.telephony.prem_pstn.trunk.usage_dial_plan
Get Local Gateway Dial Plan Usage for a Trunk
|
usage_dial_plan()
|
- api.telephony.prem_pstn.trunk.usage_location_pstn
Get Local Gateway Dial Plan Usage for a Trunk
|
usage_location_pstn()
|
- api.telephony.prem_pstn.trunk.usage_route_group
Get Local Gateway Dial Plan Usage for a Trunk
|
usage_route_group()
|
api.telephony.prem_pstn.trunk.validate_fqdn_and_domain |
validate_fqdn_and_domain()
|
- api.telephony.schedules.create
Create a Schedule
|
create()
|
- api.telephony.schedules.delete_schedule
Delete a Schedule
|
delete_schedule()
|
- api.telephony.schedules.details
Get Details for a Schedule
|
details()
|
- api.telephony.schedules.event_create
Create a Schedule Event
|
event_create()
|
- api.telephony.schedules.event_delete
Delete a Schedule Event
|
event_delete()
|
- api.telephony.schedules.event_details
Get Details for a Schedule Event
|
event_details()
|
- api.telephony.schedules.event_update
Update a Schedule Event
|
event_update()
|
- api.telephony.schedules.list
List of Schedules for a Person or location
|
list()
|
- api.telephony.schedules.update
Update a Schedule
|
update()
|
api.telephony.voicemail_groups.list |
list()
|
- api.telephony.voicemail_rules.read
Get Voicemail Rules
|
read()
|
- api.telephony.voicemail_rules.update
Update Voicemail Rules
|
update()
|
- api.telephony.voiceportal.passcode_rules
Get VoicePortal Passcode Rule
|
passcode_rules()
|
- api.telephony.voiceportal.read
- param location_id
Location to which the voice portal belongs
|
read()
|
- api.telephony.voiceportal.update
Update VoicePortal
|
update()
|
- api.webhook.create
Creates a webhook
|
create()
|
- api.webhook.details
Get Webhook Details
|
details()
|
- api.webhook.list
List all of your webhooks
|
list()
|
- api.webhook.update
Updates a webhook, by ID
|
update()
|
- api.webhook.webhook_delete
Deletes a webhook, by ID
|
webhook_delete()
|
- api.workspace_settings.call_intercept.configure
Configure Call Intercept Settings for a Person
|
configure()
|
- api.workspace_settings.call_intercept.greeting
Configure Call Intercept Greeting for a Person
|
greeting()
|
- api.workspace_settings.call_intercept.read
Read Call Intercept Settings for a Person
|
read()
|
- api.workspace_settings.call_waiting.configure
Configure Call Waiting Settings for a Person
|
configure()
|
- api.workspace_settings.call_waiting.read
Read Call Waiting Settings for a Person
|
read()
|
- api.workspace_settings.caller_id.configure
Configure a Person’s Caller ID Settings
|
configure()
|
- api.workspace_settings.caller_id.read
Retrieve a Person’s Caller ID Settings
|
read()
|
- api.workspace_settings.forwarding.configure
Configure a Person’s Call Forwarding Settings
|
configure()
|
- api.workspace_settings.forwarding.read
Retrieve a Person’s Call Forwarding Settings
|
read()
|
- api.workspace_settings.monitoring.configure
Configure Call Waiting Settings for a Person
|
configure()
|
- api.workspace_settings.monitoring.read
Retrieve a Person’s Monitoring Settings
|
read()
|
- api.workspace_settings.numbers.read
Read Do Not Disturb Settings for a Person
|
read()
|
- api.workspace_settings.numbers.update
Assign or unassign alternate phone numbers to a person
|
update()
|
- api.workspace_settings.permissions_in.configure
Configure a Person’s Barge In Settings
|
configure()
|
- api.workspace_settings.permissions_in.read
Read Incoming Permission Settings for a Person
|
read()
|
- api.workspace_settings.permissions_out.configure
Configure a Person’s Outgoing Calling Permissions Settings
|
configure()
|
- api.workspace_settings.permissions_out.read
Retrieve a Person’s Outgoing Calling Permissions Settings
|
read()
|
- api.workspace_settings.permissions_out.auth_codes.create
Modify Authorization codes for a workspace
|
create()
|
- api.workspace_settings.permissions_out.auth_codes.delete_codes
Modify Authorization codes for a workspace
|
delete_codes()
|
- api.workspace_settings.permissions_out.auth_codes.read
Retrieve Authorization codes for a Workspace
|
read()
|
- api.workspace_settings.permissions_out.transfer_numbers.configure
Modify Transfer Numbers Settings for a Place
|
configure()
|
- api.workspace_settings.permissions_out.transfer_numbers.read
Retrieve Transfer Numbers Settings for a Workspace
|
read()
|
- api.workspaces.create
Create a Workspace
|
create()
|
- api.workspaces.delete_workspace
Delete a Workspace
|
delete_workspace()
|
- api.workspaces.details
Get Workspace Details
|
details()
|
- api.workspaces.list
List Workspaces
|
list()
|
- api.workspaces.update
Update a Workspace
|
update()
|