class ZoomUs::SIPConnectedAudio
Attributes
Public Class Methods
# File lib/zoom_us/sip_connected_audio.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Assign SIP Trunk Configuration
With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN.
Using this API, a Master Account owner can copy the SIP Connected Audio configurations applied on the Master Account and enable those configurations on a Sub Account. The owner can also disable the configuration in the Sub Account where it was previously enabled. Prerequisites:
* Pro or a higher account with SIP Connected Audio plan enabled. * Master Account Owner
Scopes: `sip_trunk:master`
@param account_id @param [Hash] opts the optional parameters @option opts [Body60] :body @return [Object]
# File lib/zoom_us/sip_connected_audio.rb, line 28 def assign_sip_config(account_id, opts = {}) data, _status_code, _headers = assign_sip_config_with_http_info(account_id, opts) data end
Assign SIP Trunk Configuration
With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN. <br><br> Using this API, a Master Account owner can copy the SIP Connected Audio configurations applied on the Master Account and enable those configurations on a Sub Account. The owner can also disable the configuration in the Sub Account where it was previously enabled. Prerequisites:<br> * Pro or a higher account with SIP Connected Audio plan enabled. * Master Account Owner<br> Scopes: `sip_trunk:master`<br> @param account_id @param [Hash] opts the optional parameters @option opts [Body60] :body @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
# File lib/zoom_us/sip_connected_audio.rb, line 39 def assign_sip_config_with_http_info(account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SIPConnectedAudioApi.assign_sip_config ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling SIPConnectedAudioApi.assign_sip_config" end # resource path local_var_path = '/accounts/{accountId}/sip_trunk/settings'.sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Object') if @api_client.config.debugging @api_client.config.logger.debug "API called: SIPConnectedAudioApi#assign_sip_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Assign Numbers With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN.
Use this API to assign internal numbers to a Sub Account. Prerequisites:
* Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a Master Account
Scopes: `sip_trunk:master`
@param account_id Unique Identifier of the Sub Account. @param [Hash] opts the optional parameters @option opts [Body61] :body @return [Object]
# File lib/zoom_us/sip_connected_audio.rb, line 84 def assign_sip_trunk_numbers(account_id, opts = {}) data, _status_code, _headers = assign_sip_trunk_numbers_with_http_info(account_id, opts) data end
Assign Numbers With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN. <br><br>Use this API to assign internal numbers to a Sub Account. Prerequisites:<br> * Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a Master Account<br> Scopes: `sip_trunk:master`<br> @param account_id Unique Identifier of the Sub Account. @param [Hash] opts the optional parameters @option opts [Body61] :body @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
# File lib/zoom_us/sip_connected_audio.rb, line 95 def assign_sip_trunk_numbers_with_http_info(account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SIPConnectedAudioApi.assign_sip_trunk_numbers ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling SIPConnectedAudioApi.assign_sip_trunk_numbers" end # resource path local_var_path = '/accounts/{accountId}/sip_trunk/numbers'.sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(opts[:'body']) auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Object') if @api_client.config.debugging @api_client.config.logger.debug "API called: SIPConnectedAudioApi#assign_sip_trunk_numbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete All Numbers With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN.
Use this API to delete all internal numbers assigned to a Sub Account. Prerequisites:
* Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a Master Account
Scopes: `sip_trunk:master`
@param account_id Account ID of the Sub Account from which the numbers are to be deleted. This can be retrieved from [List Sub Accounts](marketplace.zoom.us/docs/api-reference/zoom-api/accounts/account) API. @param [Hash] opts the optional parameters @return [Object]
# File lib/zoom_us/sip_connected_audio.rb, line 139 def delete_all_sip_numbers(account_id, opts = {}) data, _status_code, _headers = delete_all_sip_numbers_with_http_info(account_id, opts) data end
Delete All Numbers With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN. <br><br>Use this API to delete all internal numbers assigned to a Sub Account. Prerequisites:<br> * Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a Master Account<br> Scopes: `sip_trunk:master`<br> @param account_id Account ID of the Sub Account from which the numbers are to be deleted. This can be retrieved from [List Sub Accounts](marketplace.zoom.us/docs/api-reference/zoom-api/accounts/account) API. @param [Hash] opts the optional parameters @return [Array<(Object, Fixnum, Hash)>] Object data, response status code and response headers
# File lib/zoom_us/sip_connected_audio.rb, line 149 def delete_all_sip_numbers_with_http_info(account_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SIPConnectedAudioApi.delete_all_sip_numbers ...' end # verify the required parameter 'account_id' is set if @api_client.config.client_side_validation && account_id.nil? fail ArgumentError, "Missing the required parameter 'account_id' when calling SIPConnectedAudioApi.delete_all_sip_numbers" end # resource path local_var_path = '/accounts/{accountId}/sip_trunk/numbers'.sub('{' + 'accountId' + '}', account_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Object') if @api_client.config.debugging @api_client.config.logger.debug "API called: SIPConnectedAudioApi#delete_all_sip_numbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List SIP Trunk Numbers With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN.
Use this API to list all the internal numbers that are configured for SIP Connected Audio in a Zoom Account. Prerequisites:
* Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a Master Account
Scopes: `sip_trunk:master` @param [Hash] opts the optional parameters @return [InlineResponse20082]
# File lib/zoom_us/sip_connected_audio.rb, line 192 def list_sip_trunk_numbers(opts = {}) data, _status_code, _headers = list_sip_trunk_numbers_with_http_info(opts) data end
List SIP Trunk Numbers With SIP-connected audio, Zoom establishes a SIP trunk (a network connection specifically designed to make and deliver phone calls) over a direct and private connection between the customer’s network and the Zoom cloud. Meeting participants that dial into a meeting or have the meeting call them, and are On-Net from the perspective of the customers' IP telephony network, will be connected over this trunk rather than over the PSTN. <br><br>Use this API to list all the internal numbers that are configured for SIP Connected Audio in a Zoom Account. Prerequisites:<br> * Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a Master Account<br> Scopes: `sip_trunk:master` @param [Hash] opts the optional parameters @return [Array<(InlineResponse20082, Fixnum, Hash)>] InlineResponse20082 data, response status code and response headers
# File lib/zoom_us/sip_connected_audio.rb, line 201 def list_sip_trunk_numbers_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SIPConnectedAudioApi.list_sip_trunk_numbers ...' end # resource path local_var_path = '/sip_trunk/numbers' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/xml']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['OAuth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InlineResponse20082') if @api_client.config.debugging @api_client.config.logger.debug "API called: SIPConnectedAudioApi#list_sip_trunk_numbers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end