Class: ZoomUs::SIPConnectedAudio

Inherits:
Object
  • Object
show all
Defined in:
lib/zoom_us/sip_connected_audio.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SIPConnectedAudio

Returns a new instance of SIPConnectedAudio.



19
20
21
 
# File 'lib/zoom_us/sip_connected_audio.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/zoom_us/sip_connected_audio.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#assign_sip_config(account_id, opts = {}) ⇒ Object

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`

Parameters:

  • account_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Body60)

Returns:

  • (Object) 


28
29
30
31
 
# File 'lib/zoom_us/sip_connected_audio.rb', line 28

def assign_sip_config(, opts = {})
  data, _status_code, _headers = assign_sip_config_with_http_info(, opts)
  data
end

#assign_sip_config_with_http_info(account_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

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&#39; IP telephony network, will be connected over this trunk rather than over the PSTN. &lt;br&gt;&lt;br&gt; 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:&lt;br&gt; * Pro or a higher account with SIP Connected Audio plan enabled. * Master Account Owner&lt;br&gt; Scopes: &#x60;sip_trunk:master&#x60;&lt;br&gt;

Parameters:

  • account_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Body60)

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/zoom_us/sip_connected_audio.rb', line 39

def assign_sip_config_with_http_info(, 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 && .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' + '}', .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_sip_trunk_numbers(account_id, opts = {}) ⇒ Object

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`

Parameters:

  • account_id —

    Unique Identifier of the Sub Account.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Body61)

Returns:

  • (Object) 


84
85
86
87
 
# File 'lib/zoom_us/sip_connected_audio.rb', line 84

def assign_sip_trunk_numbers(, opts = {})
  data, _status_code, _headers = assign_sip_trunk_numbers_with_http_info(, opts)
  data
end

#assign_sip_trunk_numbers_with_http_info(account_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

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&#39; IP telephony network, will be connected over this trunk rather than over the PSTN. &lt;br&gt;&lt;br&gt;Use this API to assign internal numbers to a Sub Account. Prerequisites:&lt;br&gt; * Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a Master Account&lt;br&gt; Scopes: &#x60;sip_trunk:master&#x60;&lt;br&gt;

Parameters:

  • account_id —

    Unique Identifier of the Sub Account.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :body (Body61)

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/zoom_us/sip_connected_audio.rb', line 95

def assign_sip_trunk_numbers_with_http_info(, 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 && .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' + '}', .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_sip_numbers(account_id, opts = {}) ⇒ Object

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`

Parameters:

Returns:

  • (Object) 


139
140
141
142
 
# File 'lib/zoom_us/sip_connected_audio.rb', line 139

def delete_all_sip_numbers(, opts = {})
  data, _status_code, _headers = delete_all_sip_numbers_with_http_info(, opts)
  data
end

#delete_all_sip_numbers_with_http_info(account_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

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&#39; IP telephony network, will be connected over this trunk rather than over the PSTN. &lt;br&gt;&lt;br&gt;Use this API to delete all internal numbers assigned to a Sub Account. Prerequisites:&lt;br&gt; * Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a Master Account&lt;br&gt; Scopes: &#x60;sip_trunk:master&#x60;&lt;br&gt;

Parameters:

Returns:

  • (Array<(Object, Fixnum, Hash)>) —

    Object data, response status code and response headers



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/zoom_us/sip_connected_audio.rb', line 149

def delete_all_sip_numbers_with_http_info(, 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 && .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' + '}', .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(opts = {}) ⇒ InlineResponse20082

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`

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (InlineResponse20082) 


192
193
194
195
 
# 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_http_info(opts = {}) ⇒ Array<(InlineResponse20082, Fixnum, Hash)>

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&#39; IP telephony network, will be connected over this trunk rather than over the PSTN. &lt;br&gt;&lt;br&gt;Use this API to list all the internal numbers that are configured for SIP Connected Audio in a Zoom Account. Prerequisites:&lt;br&gt; * Pro or a higher account with SIP Connected Audio plan enabled. * The account must be a Master Account&lt;br&gt; Scopes: &#x60;sip_trunk:master&#x60;

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(InlineResponse20082, Fixnum, Hash)>) —

    InlineResponse20082 data, response status code and response headers



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# 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