Welcome to the documentation for Canopy, a Python SDK for Cisco Acano.¶
Welcome to Canopy: Your way to interface with Acano Virtual Machines through Python.
The API reference for Acano can be found at: https://www.acano.com/publications/2015/09/Solution-API-Reference-R1_8.pdf
-
class
Canopy.Acano(server_ip, username, password)[source]¶ The Acano Server class
Use this class to connect and make API calls to an Acano Virtual Machine.
param server_ip: The IP Address of the server param username: The username of an account with access to the API. param password: The password for your user account type server_ip: String type username: String type password: String returns: return an Acano object rtype: Acano Example: >>> import Canopy >>> a = Canopy.Acano("192.168.12.100", "admin", "guest")
-
add_member_to_coSpace(coSpace_id, payload={})[source]¶ Add a member to the coSpace, using the coSpace ID as the identifier.
Parameters: - coSpace_id (String) – The ID of the coSpace for which to add a member. This can be returned from the get_coSpaces()[“coSpaces”][“coSpace”][i][“@id”]
- payload (Dict) – Details the member to add. Must contain the User JID.
Example: >>> print(a.add_member_to_coSpace("3b8dfa05-f7b6-41f2-b14a-739a0d015b90", payload { >>> 'userJid' : a.get_coSpace_members()["coSpaceMembers] >>> }))
Note
v1.8 upward
-
cancel_ldap_sync(ldap_sync_id)[source]¶ Cancel a scheduled LDAP sync. Will fail if the sync has already started.
Parameters: ldap_sync_id (String) – The ID of the LDAP sync to cancel Note
v1.8 upward
-
create_access_query(payload={})[source]¶ - The accessQuery method finds details of how a given URI or call ID (for example, one that could
- be associated with a coSpace) might be reached. One use is an external system discovering that a coSpace with URI “sales.meeting” would be reached via the SIP URI “sales.meeting@example.com”.
Parameters: payload (Dict) – Details the query Note
v1.8 upward
-
create_call(payload={})[source]¶ Create a new call
Parameters: payload (Dict) – Details of the call Note
v1.8 upward
-
create_call_branding_profile(payload={})[source]¶ Create a call branding profile
Parameters: payload (Dict) – Details the initial state of the call branding profile. Note
v1.6 upward
-
create_call_bridge(payload={})[source]¶ Set up a Call Bridge
Parameters: payload (Dict) – Details the initial state of the call bridge Note
v1.8 upward
-
create_call_bridge_cluster(payload={})[source]¶ Set up the call bridge cluster
Parameters: payload (dict) – The initial state of the call bridge cluster Note
v1.8 upward
-
create_call_leg(call_id, payload={})[source]¶ Create a new call leg
Parameters: - call_id (String) – The ID of the call for which to create the call leg
- payload (Dict) – Details the initial state of the call leg
Note
v1.8 upward
-
create_call_leg_profile(payload={})[source]¶ Create a new call leg profile
Parameters: payload (Dict) – Details the initial state of the call leg profile Note
v1.8 upward
-
create_call_profile(payload={})[source]¶ Create a new call profile
Parameters: payload (Dict) – Details the initial state of the call profile Note
v1.8 upward
-
create_cdr_receiver(payload={})[source]¶ Create a new Call Detail Record receiver
Parameters: payload (Dict) – Details the initial state of the CDR receiver Note
v1.8 upward
-
create_coSpace(payload={})[source]¶ Create a new coSpace
Parameters: payload (Dict) – Details the initial state of the newly created coSpace
Example: >>> print(a.create_coSpace())
Example: >>> print(a.create_coSpace(payload = { >>> 'name' : 'Emergency meeting' >>> }))
Note
v1.8 upward
-
create_coSpace_access_method(coSpace_id, payload={})[source]¶ Create a new access method for a coSpace. Access methods define URI / passcode / callID combinations that can be used to access a coSpace
param coSpace_id: The ID of the coSpace for which to add an access method type coSpace_id: String param payload: Details the initial state of the access method type payload: Dict Note
v1.8 upward
-
create_dial_transform(payload={})[source]¶ Create a new dial transform for outbound calls
Parameters: payload (Dict) – Details the initial state of the dial transform Note
v1.6 upward
-
create_directory_search_location(payload={})[source]¶ Add an external directory search location
Parameters: payload (Dict) – Details the initial state of the directory search location Note
v1.8 upward
-
create_dtmf_profile(payload={})[source]¶ Create a DTMF profile
Parameters: payload (Dict) – Details the initial state of the DTMF profile Note
v1.6 upward
-
create_forwarding_dial_plan_rule(payload={})[source]¶ Create a new forwarding dial plan rule.
Parameters: payload (Dict) – Details the initial state of the rule Note
v1.8 upward
-
create_global_profile(payload={})[source]¶ Set up the global profile
Parameters: payload (Dict) – Details the inital state of the global profile Note
v1.8 upward
-
create_inbound_dial_plan_rule(payload={})[source]¶ Create a new inbound dial plan rule.
Parameters: payload (Dict) – Details the initial state of the dial plan rule. Note
v1.8 upward
-
create_ivr(payload={})[source]¶ Create a new IVR
Parameters: payload (Dict) – Details the initial state of the IVR
-
create_ivr_branding_profile(payload={})[source]¶ Create a new IVR branding profile
Parameters: payload (Dict) – Details the initial state of the profile
-
create_ldap_mapping(payload={})[source]¶ Create an LDAP mapping
Parameters: payload (dict) – Details the initial state of the LDAP mapping Note
v1.8 upward
-
create_ldap_server(payload={})[source]¶ Add an LDAP server
Parameters: payload (dict) – Details the initial state of the LDAP server Note
v1.8 upward
-
create_ldap_source(payload={})[source]¶ Create an LDAP source
Parameters: payload (Dict) – Details the initial state of the LDAP source Note
v1.8 upward
-
create_outbound_dial_plan_rule(payload={})[source]¶ Create a new outbound dial plan rule.
Parameters: payload (Dict) – Details the initial state of the dial plan rule. Note
v1.8 upward
-
create_recorder(payload={})[source]¶ Create a meeting recorder
Parameters: payload (Dict) – Details the initial state of the recorder Note
v1.9 upward
-
create_tenant(payload={})[source]¶ Create a new tenant
Parameters: payload (Dict) – Details the initial state of the tenant Note
v1.8 upward
-
create_tenant_group(payload={})[source]¶ Create a tenant group.
Parameters: payload (Dict) – Details the initial state of the tenant See also
https://www.acano.com/publications/2015/09/Acano-Solution-Multi-tenancy-Considerations1.pdf#page=6
Note
v1.8 upward
-
create_turn_server(payload={})[source]¶ Set up a new TURN server. TURN, in this context being Traversal Using Relay NAT
Parameters: payload (Dict) – Details the initial state of the TURN server
Example: >>> print(a.create_turn_server(payload = { >>> "ServerAddress" : "192.168.12.50" >>> }))
Note
v1.8 upward
-
create_user_profile(payload={})[source]¶ Create a new user profile
Parameters: payload (Dict) – Details the inital state of the new user profile.
Example: >>> print(a.create_user_profile(payload = { >>> "cancreateCoSpaces" : True >>> })
Note
v1.8 upward
-
create_web_bridge(payload={})[source]¶ Set up a new web bridge
Parameters: payload (Dict) – Details the initial state of the Web Bridge Note
v1.8 upward
-
create_xmpp_server(payload={})[source]¶ Set up the XMPP server
Parameters: payload (dict) – The initial state of the XMPP server Note
v1.8 upward
-
delete_call(call_id)[source]¶ Cancel an in-progress call
Parameters: call_id (String) – The ID of the call
-
delete_coSpace(coSpace_id)[source]¶ Delete a coSpace, using the coSpace ID as the identifier.
Parameters: coSpace_id (String) – The ID of the coSpace to delete. This can be returned from the get_coSpaces()[“coSpaces”][“coSpace”][i][“@id”]
Example: >>> print(a.delete_coSpace("3b8dfa05-f7b6-41f2-b14a-739a0d015b90"))
Note
This function is not explicitly described in the Acano API reference
Note
v1.8 upward
-
delete_message_from_coSpace(coSpace_id, payload={})[source]¶ Delete messages from the board of a coSpace
Parameters: - coSpace_id (String) – The ID of the coSpace for to get the user. This can be returned from the get_coSpaces()[“coSpaces”][“coSpace”][i][“@id”]
- payload (Dict) – Details the messages to remove.
Example: >>> print(a.delete_message_from_coSpace("3b8dfa05-f7b6-41f2-b14a-739a0d015b90", payload = { >>> 'maxAge' : 20 >>> })
Note
v1.8 upward
-
get_call(call_id)[source]¶ Retrieve information on a single active call
Parameters: call_id (String) – The ID of the call for which to retrieve information Note
v1.8 upward
-
get_call_branding_profile(call_branding_profile_id)[source]¶ Retrieve information on a single call branding profile
Parameters: call_branding_profile_id (String) – The ID of the call branding profile to get Note
v1.6 upward
-
get_call_branding_profiles(parameters={})[source]¶ Retrieve information on call branding profiles
Parameters: parameters (Dict) – Details filters for the query Note
v1.6 upward
-
get_call_bridge(call_bridge_id)[source]¶ Get information on a specific call bridge
Parameters: - call_bridge_id (String) – The ID of the call bridge to modify
- payload (Dict) – Details the initial state of the call bridge
Note
v1.8 upward
-
get_call_bridges(parameters={})[source]¶ Get information on Call Bridges
Parameters: parameters (Dict) – Details filters for the query Note
v1.8 upward
-
get_call_leg(call_leg_id)[source]¶ Retrieve information on a single call leg.
Parameters: call_leg_id (String) – The ID of the call leg to get Note
v1.8 upward
-
get_call_leg_profile(call_leg_profile_id)[source]¶ Retrieve information on a single call leg profile
Parameters: call_leg_profile_id (String) – The ID of the call leg profile to get Note
v1.8 upward
-
get_call_leg_profile_trace(call_leg_id, parameters={})[source]¶ Retrieve information on a call leg profile trace
Parameters: - call_leg_id (String) – The ID of the call leg to get
- parameters (Dict) – Details filters for the query
Note
v1.8 upward
-
get_call_leg_profiles(parameters={})[source]¶ Retrieve information on call leg profiles
Parameters: parameters (Dict) – Details filters for the query Note
v1.8 upward
-
get_call_legs(parameters={})[source]¶ Retrieve information on call legs
Parameters: parameters (Dict) – Details filter for the query Note
v1.8 upward
-
get_call_profile(call_profile_id)[source]¶ Retrieve information on a single call profile
Parameters: call_profile_id (String) – The ID of the call profile to modify Note
v1.8 upward
-
get_call_profiles(parameters={})[source]¶ Retrieve information on call profiles
Parameters: parameters (Dict) – Details filters for the query Note
v1.8 upward
-
get_calls(parameters={})[source]¶ Retrieve information on active calls
Parameters: parameters (Dict) – Details filters for the query Note
v1.8 upward
-
get_cdr_receiver(cdr_receiver_id)[source]¶ Get a specific Call Detail Record Receiver by ID
Parameters: cdr_receiver_id (String) – Identifies the CDR to return Note
v1.8 upward
-
get_cdr_receivers(parameters={})[source]¶ Get the Call Detail Record receivers
Parameters: parameters (Dict) – Details filters for the query Note
v1.8 upward
-
get_coSpace(coSpace_id)[source]¶ Get the details of a coSpace, using the coSpace ID as the identifier.
Parameters: - coSpace_id (String) – The ID of the coSpace to modify. This can be returned from the get_coSpaces()[“coSpaces”][“coSpace”][i][“@id”]
- parameters (Dict) – Filters for the query
Example: >>> print(a.get_coSpace("3b8dfa05-f7b6-41f2-b14a-739a0d015b90"))
Note
v1.8 upward
-
get_coSpace_access_method(coSpace_id, access_method_id)[source]¶ Retrieve a single access method for a coSpace. Access methods define URI / passcode / callID combinations that can be used to access a coSpace
param coSpace_id: The ID of the coSpace in which to get an access method type coSpace_id: String param access_method_id: The ID of the access method to get. type access_method_id: String Note
v1.8 upward
-
get_coSpace_access_methods(coSpace_id, parameters={})[source]¶ Retrieve the access methods for a coSpace. Access methods define URI / passcode / callID combinations that can be used to access a coSpace
param coSpace_id: The ID of the coSpace for which to retrieve access methods type coSpace_id: String param parameters: Details filters for the query type parameters: Dict Note
v1.8 upward
-
get_coSpace_member(coSpace_id, coSpace_user_id)[source]¶ Make changes to the permissions of a user in a coSpace, using the coSpace ID and user ID as the identifiers.
Parameters: - coSpace_id (String) – The ID of the coSpace for to get the user. This can be returned from the get_coSpaces()[“coSpaces”][“coSpace”][i][“@id”]
- coSpace_user_id (String) – The ID of the user.
Example: >>> print(a.get_coSpace_member("3b8dfa05-f7b6-41f2-b14a-739a0d015b90", user_id)
Note
v1.8 upward
-
get_coSpace_members(coSpace_id, parameters={})[source]¶ Get the members in a coSpace, using the coSpace ID as the identifier.
Parameters: - coSpace_id (String) – The ID of the coSpace for which to get members. This can be returned from the get_coSpaces()[“coSpaces”][“coSpace”][i][“@id”]
- parameters (Dict) – Details the parameters of the HTTP GET
Example: >>> print(a.get_coSpace_members("3b8dfa05-f7b6-41f2-b14a-739a0d015b90"))
Note
v1.8 upward
-
get_coSpaces(parameters={})[source]¶ Get the coSpaces within the Acano VM. These are returned in an arbitrary order.
Parameters: parameters (Dict) – A dictionary of parameters, per the Acano API.
Example: >>> print(a.get_coSpaces())
Example: >>> print(a.get_coSpaces(parameters = { >>> 'offset' : 5 >>> }))
Note
v1.8 upward
-
get_dial_transform(dial_transform_id)[source]¶ Retrieve information on a single dial transform
Parameters: dial_transform_id (String) – The ID of the dial transform to get Note
v1.6 upward
-
get_dial_transforms(parameters={})[source]¶ Retrieve information on transforms set up for outbound calls.
Parameters: - call_leg_id (String) – The ID of the call leg to get
- parameters (Dict) – Details filters for the query
Note
v1.6 upward
-
get_directory_search_location(directory_search_location_id)[source]¶ Get a single external directory search location
Parameters: directory_search_location_id (String) – The ID of the directory search location to get Note
v1.8 upward
-
get_directory_search_locations()[source]¶ Get information on external directory search locations: additional directory search locations to be consulted when users of Acano clients perform searches
Note
v1.8 upward
-
get_dtmf_profile(dtmf_profile_id)[source]¶ Retrieve information on a single DTMF profile
Parameters: dtmf_profile_id (String) – The ID of the DTMF profile to get Note
v1.6 upward
-
get_dtmf_profiles(parameters={})[source]¶ Create a new DTMF profile
Parameters: parameters (Dict) – Details filters for the query Note
v1.6 upward
-
get_forwarding_dial_plan_rule(forwarding_dial_plan_rule_id)[source]¶ Retrieve a single forwarding dial plan rule.
Parameters: forwarding_dial_plan_rule_id (Dict) – The ID of the rule to modify Note
v1.8 upward
-
get_forwarding_dial_plan_rules(parameters={})[source]¶ Retrieve the forwarding dial plan rules.
Parameters: parameters (Dict) – Details filters for the query Note
v1.8 upward
-
get_global_profile()[source]¶ Get the global profile
Example: >>> print(a.get_global_profile())
Note
v1.8 upward
-
get_inbound_dial_plan_rule(inbound_dial_plan_rule_id, parameters={})[source]¶ Retrieve a single inbound dial plan rule.
Parameters: inbound_dial_plan_rule_id (String) – The ID of the dial plan rule to retrieve Note
v1.8 upward
-
get_inbound_dial_plan_rules(parameters={})[source]¶ Retrieve inbound dial plan rules.
Parameters: parameters (Dict) – Details filters for the query Note
v1.8 upward
-
get_ivr(ivr_id)[source]¶ Retrieve information on a single IVR
Parameters: ivr_id (String) – The ID of the IVR to get
-
get_ivr_branding_profile(ivr_branding_profile_id)[source]¶ Retrieve information on a single IVR branding profile
Parameters: ivr_branding_profile_id (String) – The ID of the IVR branding profile to get
-
get_ivr_branding_profiles(parameters={})[source]¶ Retrieve information IVR branding profiles
Parameters: parameters (Dict) – Details filters for the query
-
get_ivrs(parameters={})[source]¶ Retrieve information on IVRs
Parameters: parameters (Dict) – Details filters for the query
-
get_ldap_mapping(ldap_mapping_id)[source]¶ Modify an existing LDAP mapping
Parameters: ldap_mapping_id (String) – Details the ID of the LDAP mapping to get Note
v1.8 upward
-
get_ldap_server(ldap_server_id)[source]¶ Get an LDAP server, by ID
Parameters: ldap_server_id (dict) – The ID of the LDAP server to get Note
v1.8 upward
-
get_ldap_servers(parameters={})[source]¶ Retrieve information on LDAP servers
Parameters: parameters (dict) – Details filters of the query Note
v1.8 upward
-
get_ldap_source(ldap_source_id)[source]¶ Get an LDAP source, by ID
Parameters: ldap_source_id (String) – The ID of the LDAP source to get Note
v1.8 upward
-
get_ldap_sync(ldap_sync_id, parameters={})[source]¶ Get information on a single LDAP sync
Parameters: ldap_sync_id (String) – The ID of the LDAP sync to cancel Note
v1.8 upward
-
get_ldap_syncs(parameters={})[source]¶ Monitor pending and in-progress LDAP syncs
Parameters: parameters (Dict) – Details filters for the query Note
v1.8 upward
-
get_outbound_dial_plan_rule(outbound_dial_plan_rule_id)[source]¶ Retrieve a single outbound dial plan rule
Parameters: outbound_dial_plan_rule_id (String) – The ID of the dial plan rule to retrieve Note
v1.8 upward
-
get_outbound_dial_plan_rules(parameters={})[source]¶ Retrieve outbound dial plan rules.
Parameters: parameters (Dict) – Details filters for the query Note
v1.8 upward
-
get_participant(participant_id)[source]¶ Get information on a participant
Parameters: participant_id (String) – The ID of the participant to get
-
get_participant_call_legs(participant_id)[source]¶ Get information on a participant’s call legs
Parameters: participant_id (String) – The ID of the participant for which to get call legs
-
get_participants(parameters={})[source]¶ Get information on participants
Parameters: parameters (Dict) – Details filters for the query
-
get_recorder(recorder_id)[source]¶ Get information on a single recorder
Parameters: recorder_id (String) – The ID of the recorder to get Note
v1.9 upward
-
get_recorders(parameters={})[source]¶ Get information on meeting recorders
Parameters: parameters (Dict) – Details filters for the query Note
v1.9 upward
-
get_system_alarms()[source]¶ Get information on the current system alarm status.
Example: >>> print(a.get_system_alarms())
Note
v1.8 upward
-
get_system_database()[source]¶ Get information on the system database status.
Example: >>> print(a.get_system_database())
Note
v1.8 upward
-
get_system_diagnostic(diagnostic_id)[source]¶ Retrieve an individual system diagnostic
Parameters: diagnostic_id (String) – The ID of the diagnostic to retrieve Note
v1.8 upward
-
get_system_diagnostic_contents(diagnostic_id)[source]¶ Retrieve the contents of an individual system diagnostic
Parameters: diagnostic_id (String) – The ID of the diagnostic to retrieve Note
v1.8 upward
-
get_system_status()[source]¶ Get information on the current system status, e.g. software version, uptime etc.
Example: >>> print(a.get_system_status())
Note
v1.8 upward
-
get_tenant(tenant_id)[source]¶ Get a single tenant
Parameters: tenant_id (String) – The ID of the tenant to get Note
v1.8 upward
-
get_tenant_group(tenant_group_id)[source]¶ Retrieve a single existing tenant group
Parameters: tenant_group_id (String) – The ID of the tenant group to get See also
https://www.acano.com/publications/2015/09/Acano-Solution-Multi-tenancy-Considerations1.pdf#page=6
Note
v1.8 upward
-
get_tenant_groups(parameters={})[source]¶ Retrieve tenant groups in the system.
Parameters: parameters (Dict) – Details filters for the query See also
https://www.acano.com/publications/2015/09/Acano-Solution-Multi-tenancy-Considerations1.pdf#page=6
Note
v1.8 upward
-
get_tenants(parameters={})[source]¶ Retrieve tenants in the system
Parameters: parameters (Dict) – Details filters for the query Note
v1.8 upward
-
get_turn_server(turn_server_id)[source]¶ Return a TURN server, referenced by the TURN server ID. TURN, in this context being Traversal Using Relay NAT
Note
v1.8 upward
-
get_turn_servers(parameters={})[source]¶ Get the TURN servers. TURN, in this context being Traversal Using Relay NAT
Parameters: parameters (Dict) – Details filters for the query
Example: >>> print(a.get_turn_servers())
Note
v1.8 upward
-
get_user(user_id)[source]¶ Get information on a single user
Parameters: user_id (String) – The ID of the user
-
get_user_coSpaces(user_id)[source]¶ Get information on the coSpaces with which a user is currently associated
Parameters: user_id (String) – The ID of the user
-
get_user_profile(user_profile_id)[source]¶ Get a specific existing user profile
Parameters: user_profile_id (String) – Identifies the user profile to return
Example: >>> print(a.get_user_profile())
Note
v1.8 upward
-
get_user_profiles(parameters={})[source]¶ Get the user profiles that exist within the VM.
Parameters: parameters (Dict) – Details filters for the query.
Example: >>> print(a.get_user_profiles()
Note
v1.8 upward
-
get_users(parameters={})[source]¶ Get information on users
Parameters: parameters (Dict) – Details filters for the query
-
get_web_bridge(web_bridge_id)[source]¶ Get information for a specific web bridge, by ID
Parameters: web_bridge_id (String) – The ID of the web bridge for which to get information. Note
v1.8 upward
-
get_web_bridges(parameters={})[source]¶ Get information on Web Bridges
Parameters: parameters (Dict) – Details filters for the query Note
v1.8 upward
-
initiate_ldap_sync(payload={})[source]¶ Trigger a new LDAP sync
Parameters: parameters (Dict) – Details parameters for the LDAP sync Note
v1.8 upward
-
modify_call_branding_profile(call_branding_profile_id, payload={})[source]¶ Modify an existing call branding profile
Parameters: - call_branding_profile_id (String) – The ID of the call branding profile to modify
- payload (Dict) – Details the new state of the call branding profile.
Note
v1.6 upward
-
modify_call_bridge(call_bridge_id, payload={})[source]¶ Modify an existing Call Bridge
Parameters: - call_bridge_id (String) – The ID of the call bridge to modify
- payload (Dict) – Details the initial state of the call bridge
Note
v1.8 upward
-
modify_call_bridge_cluster(payload={})[source]¶ Modify the existing call bridge cluster
Parameters: payload (dict) – The new state of the call bridge cluster Note
v1.8 upward
-
modify_call_leg(call_leg_id, payload={})[source]¶ Modify an existing call leg
Parameters: - call_leg_id (String) – The ID of the call leg to modify
- payload (Dict) – Details the new state of the call leg
Note
v1.8 upward
-
modify_call_leg_profile(call_leg_profile_id, payload={})[source]¶ Modify an existing call leg profile
Parameters: - call_leg_profile_id (String) – The ID of the call leg profile to modify
- payload (Dict) – Details the new state of the call leg profile
Note
v1.8 upward
-
modify_call_profile(call_profile_id, payload={})[source]¶ Modify an existing call profile
Parameters: - call_profile_id (String) – The ID of the call profile to modify
- payload (Dict) – Details the new state of the call profile
Note
v1.8 upward
-
modify_cdr_receiver(cdr_receiver_id, payload={})[source]¶ Modify a Call Detail Record Receiver by ID
Parameters: - cdr_receiver_id (String) – Identifies the CDR to return
- payload (Dict) – Details the new state of the CDR receiver.
Note
v1.8 upward
-
modify_coSpace(coSpace_id, payload)[source]¶ Make changes to an existing coSpace, using the coSpace ID as the identifier.
Parameters: - coSpace_id (String) – The ID of the coSpace to modify. This can be returned from the get_coSpaces()[“coSpaces”][“coSpace”][i][“@id”]
- payload (Dict) – Details the new state of the identified coSpace
Example: >>> print(a.modify_coSpace("3b8dfa05-f7b6-41f2-b14a-739a0d015b90", payload = { >>> "name" : "Modified coSpace" >>> }))
Note
v1.8 upward
-
modify_coSpace_access_method(coSpace_id, access_method_id, payload={})[source]¶ Modify an existing access method for a coSpace. Access methods define URI / passcode / callID combinations that can be used to access a coSpace
param coSpace_id: The ID of the coSpace in which to modify an access method type coSpace_id: String param access_method_id: The ID of the access method to modify. type access_method_id: String param payload: Details the new state of the access method type payload: Dict Note
v1.8 upward
-
modify_coSpace_member(coSpace_id, coSpace_user_id, payload={})[source]¶ Make changes to the permissions of a user in a coSpace, using the coSpace ID and user ID as the identifiers.
Parameters: - coSpace_id (String) – The ID of the coSpace for to get the user. This can be returned from the get_coSpaces()[“coSpaces”][“coSpace”][i][“@id”]
- coSpace_user_id (String) – The ID of the user.
- payload (Dict) – Details the state to which to update the user.
Example: >>> print(a.modify_coSpace_member("3b8dfa05-f7b6-41f2-b14a-739a0d015b90", user_id, payload { >>> 'canDestroy' : 'true' >>> }))
Note
v1.8 upward
-
modify_dial_transform(dial_transform_id, payload={})[source]¶ Modify an existing dial transform
Parameters: - dial_transform_id (String) – The ID of the dial transform to modify
- payload (Dict) – Details the initial state of the dial transform
Note
v1.6 upward
-
modify_directory_search_location(directory_search_location_id, payload={})[source]¶ Modify an existing external directory search location
Parameters: - directory_search_location_id (String) – The ID of the directory search location to modify
- payload (Dict) – Details the new state of the directory search location
Note
v1.8 upward
-
modify_dtmf_profile(dtmf_profile_id, payload={})[source]¶ Modify a DTMF profile
Parameters: - dtmf_profile_id (String) – The ID of the DTMF profile to modify
- payload (Dict) – Details the new state of the DTMF profile
Note
v1.6 upward
-
modify_forwarding_dial_plan_rule(forwarding_dial_plan_rule_id, payload={})[source]¶ Modify an existing forwarding dial plan rule.
Parameters: - forwarding_dial_plan_rule_id (Dict) – The ID of the rule to modify
- payload (Dict) – Details the new state of the rule
Note
v1.8 upward
-
modify_global_profile(payload={})[source]¶ Modify the global profile
Parameters: payload (Dict) – Details the modified state of the global profile Note
v1.8 upward
-
modify_inbound_dial_plan_rule(inbound_dial_plan_rule_id, payload={})[source]¶ Create a new inbound dial plan rule.
Parameters: - inbound_dial_plan_rule_id (String) – The ID of the dial plan rule to modify
- payload (Dict) – Details the new state of the dial plan rule.
Note
v1.8 upward
-
modify_ivr(ivr_id, payload={})[source]¶ Modify an existing IVR
Parameters: - ivr_id (String) – The ID of the IVR to modify
- payload (Dict) – Details the new state of the IVR
-
modify_ivr_branding_profile(ivr_branding_profile_id, payload={})[source]¶ Modify an existing IVR branding profile
Parameters: - ivr_branding_profile_id (String) – The ID of the IVR branding profile to modify
- payload (Dict) – Details the new state of the profile
-
modify_ldap_mapping(ldap_mapping_id, payload={})[source]¶ Modify an existing LDAP mapping
Parameters: - ldap_mapping_id (String) – Details the new state of the LDAP mapping
- payload (dict) – Details the new state of the LDAP mapping
Note
v1.8 upward
-
modify_ldap_server(ldap_server_id, payload={})[source]¶ Modify an existing LDAP server
Parameters: - ldap_server_id (dict) – The ID of the LDAP server to modify
- payload (dict) – Details the new state of the LDAP server
Note
v1.8 upward
-
modify_ldap_source(ldap_source_id, payload={})[source]¶ Modify an existing LDAP source
Parameters: - ldap_source_id (String) – The ID of the LDAP source to modify
- payload (Dict) – Details the initial state of the LDAP source
Note
v1.8 upward
-
modify_outbound_dial_plan_rule(outbound_dial_plan_rule_id, payload={})[source]¶ Create a new outbound dial plan rule.
Parameters: - outbound_dial_plan_rule_id (String) – The ID of the dial plan rule to modify
- payload (Dict) – Details the new state of the dial plan rule.
Note
v1.8 upward
-
modify_recorder(recorder_id, payload={})[source]¶ Modify an existing meeting recorder
Parameters: - recorder_id (String) – The ID of the recorder to modify
- payload (Dict) – Details the new state of the recorder
Note
v1.9 upward
-
modify_tenant(tenant_id, payload={})[source]¶ Modify an existing tenant
Parameters: - tenant_id (String) – The ID of the tenant to modify
- payload (Dict) – Details the new state of the tenant
Note
v1.8 upward
-
modify_tenant_group(tenant_group_id, payload={})[source]¶ Modify an existing tenant group
Parameters: - tenant_group_id (String) – The ID of the tenant group to modify
- payload (Dict) – Details the new state of the tenant group
See also
https://www.acano.com/publications/2015/09/Acano-Solution-Multi-tenancy-Considerations1.pdf#page=6
Note
v1.8 upward
-
modify_turn_server(turn_server_id, payload={})[source]¶ Modify an existing TURN server. TURN, in this context being Traversal Using Relay NAT
Parameters: payload (Dict) – Details the modified state of the TURN server
Example: >>> print(a.create_turn_server(payload = { >>> "ServerAddress" : "192.168.12.50" >>> }))
Note
v1.8 upward
-
modify_user_profile(user_profile_id, payload={})[source]¶ Modify an existing user profile
Parameters: - user_profile_id (String) – Identifies the user profile to modify
- payload (Dict) – Details the new state of the user profile.
Example: >>> print(a.modify_user_profile(payload = { >>> "cancreateCoSpaces" : False >>> })
Note
v1.8 upward
-
modify_web_bridge(web_bridge_id, payload={})[source]¶ Modify an existing web bridge
Parameters: - web_bridge_id (String) – The ID of the web bridge to modify.
- payload (Dict) – Details the new state of the Web Bridge
Note
v1.8 upward
-
modify_xmpp_server(payload={})[source]¶ Modify the XMPP server details
Parameters: payload (dict) – The new state of the XMPP server Note
v1.8 upward
-
post_message_to_coSpace(coSpace_id, payload={})[source]¶ Post a message to the board of a coSpace.
Parameters: - coSpace_id (String) – The ID of the coSpace. This can be returned from the get_coSpaces()[“coSpaces”][“coSpace”][i][“@id”]
- payload (Dict) – Details the message to send.
Example: >>> print(a.post_message_to_coSpace("3b8dfa05-f7b6-41f2-b14a-739a0d015b90", payload = { >>> 'message' : 'hello world', >>> 'from' : 'George' >>> })
Note
v1.8 upward
-