Class: ZoomUs::PhoneCallQueues

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PhoneCallQueues 



19
20
21
 
# File 'lib/zoom_us/phone_call_queues.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/phone_call_queues.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_members_to_call_queue(call_queue_id, opts = {}) ⇒ Object

Add Members to a Call Queue Add phone users and/or [common area phones](support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) as members to a specific Call Queue.
Prerequisites:
* Pro or higher account plan. * Zoom Phone license
Scopes: ‘phone:write:admin`

Options Hash (opts):

  • :body (Body69) 


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

def add_members_to_call_queue(call_queue_id, opts = {})
  data, _status_code, _headers = add_members_to_call_queue_with_http_info(call_queue_id, opts)
  data
end

#add_members_to_call_queue_with_http_info(call_queue_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Add Members to a Call Queue Add phone users and/or [common area phones](support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) as members to a specific Call Queue.&lt;br&gt;&lt;br&gt; Prerequisites:&lt;br&gt; * Pro or higher account plan. * Zoom Phone license&lt;br&gt; Scopes: &#x60;phone:write:admin&#x60;&lt;br&gt;

Options Hash (opts):

  • :body (Body69) 


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/phone_call_queues.rb', line 39

def add_members_to_call_queue_with_http_info(call_queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneCallQueuesApi.add_members_to_call_queue ...'
  end
  # verify the required parameter 'call_queue_id' is set
  if @api_client.config.client_side_validation && call_queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_queue_id' when calling PhoneCallQueuesApi.add_members_to_call_queue"
  end
  # resource path
  local_var_path = '/phone/call_queues/{callQueueId}/members'.sub('{' + 'callQueueId' + '}', call_queue_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: PhoneCallQueuesApi#add_members_to_call_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#assign_phone_to_call_queue(call_queue_id, opts = {}) ⇒ Object

Assign Numbers to a Call Queue After [buying phone number(s)](support.zoom.us/hc/en-us/articles/360020808292#h_007ec8c2-0914-4265-8351-96ab23efa3ad), you can assign it, allowing callers to directly dial a number to reach a [call queue](support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues).
Prerequisites:
* Pro or higher account plan. * Account owner or admin permissions * Zoom Phone license
Scopes: ‘phone:write:admin`

Options Hash (opts):

  • :body (Body68) 


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

def assign_phone_to_call_queue(call_queue_id, opts = {})
  data, _status_code, _headers = assign_phone_to_call_queue_with_http_info(call_queue_id, opts)
  data
end

#assign_phone_to_call_queue_with_http_info(call_queue_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Assign Numbers to a Call Queue After [buying phone number(s)](support.zoom.us/hc/en-us/articles/360020808292#h_007ec8c2-0914-4265-8351-96ab23efa3ad), you can assign it, allowing callers to directly dial a number to reach a [call queue](support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues).&lt;br&gt;&lt;br&gt; Prerequisites:&lt;br&gt; * Pro or higher account plan. * Account owner or admin permissions * Zoom Phone license&lt;br&gt; Scopes: &#x60;phone:write:admin&#x60;&lt;br&gt;

Options Hash (opts):

  • :body (Body68) 


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/phone_call_queues.rb', line 95

def assign_phone_to_call_queue_with_http_info(call_queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneCallQueuesApi.assign_phone_to_call_queue ...'
  end
  # verify the required parameter 'call_queue_id' is set
  if @api_client.config.client_side_validation && call_queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_queue_id' when calling PhoneCallQueuesApi.assign_phone_to_call_queue"
  end
  # resource path
  local_var_path = '/phone/call_queues/{callQueueId}/phone_numbers'.sub('{' + 'callQueueId' + '}', call_queue_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: PhoneCallQueuesApi#assign_phone_to_call_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#change_call_queue_manager(call_queue_id, opts = {}) ⇒ Object

Change Call Queue Manager A call queue manager has the privileges to maanage the call queue’s voicemail inbox and recordings, change all call queue settings and call queue policy settings.
Use this API to to set another phone user as the [call queue manager](support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues#h_db06854b-e6a3-4afe-ba15-baf58f31f90c). Prerequisites:
* Pro or higher account plan. * Account owner or admin permissions * Zoom Phone license
Scopes: ‘phone:write:admin`

Options Hash (opts):

  • :body (Body70) 


140
141
142
143
 
# File 'lib/zoom_us/phone_call_queues.rb', line 140

def change_call_queue_manager(call_queue_id, opts = {})
  data, _status_code, _headers = change_call_queue_manager_with_http_info(call_queue_id, opts)
  data
end

#change_call_queue_manager_with_http_info(call_queue_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Change Call Queue Manager A call queue manager has the privileges to maanage the call queue&#39;s voicemail inbox and recordings, change all call queue settings and call queue policy settings.&lt;br&gt;&lt;br&gt; Use this API to to set another phone user as the [call queue manager](support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues#h_db06854b-e6a3-4afe-ba15-baf58f31f90c). Prerequisites:&lt;br&gt; * Pro or higher account plan. * Account owner or admin permissions * Zoom Phone license&lt;br&gt; Scopes: &#x60;phone:write:admin&#x60;&lt;br&gt;

Options Hash (opts):

  • :body (Body70) 


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
188
189
 
# File 'lib/zoom_us/phone_call_queues.rb', line 151

def change_call_queue_manager_with_http_info(call_queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneCallQueuesApi.change_call_queue_manager ...'
  end
  # verify the required parameter 'call_queue_id' is set
  if @api_client.config.client_side_validation && call_queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_queue_id' when calling PhoneCallQueuesApi.change_call_queue_manager"
  end
  # resource path
  local_var_path = '/phone/call_queues/{callQueueId}/manager'.sub('{' + 'callQueueId' + '}', call_queue_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(:PUT, 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: PhoneCallQueuesApi#change_call_queue_manager\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_call_queue(opts = {}) ⇒ InlineResponse20123

Create a Call Queue Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.
Use this API to [create a call queue](support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues#h_e81faeeb-9184-429a-aaea-df49ff5ff413).
You can add phone users or common area phones to call queues. Prerequisites:
* Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license
Scopes: ‘phone:write:admin`

Options Hash (opts):

  • :body (Body66) 


195
196
197
198
 
# File 'lib/zoom_us/phone_call_queues.rb', line 195

def create_call_queue(opts = {})
  data, _status_code, _headers = create_call_queue_with_http_info(opts)
  data
end

#create_call_queue_with_http_info(opts = {}) ⇒ Array<(InlineResponse20123, Fixnum, Hash)>

Create a Call Queue Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.&lt;br&gt; Use this API to [create a call queue](support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues#h_e81faeeb-9184-429a-aaea-df49ff5ff413).&lt;br&gt; You can add phone users or common area phones to call queues. Prerequisites:&lt;br&gt; * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license&lt;br&gt; Scopes: &#x60;phone:write:admin&#x60;&lt;br&gt;

Options Hash (opts):

  • :body (Body66) 


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
236
237
238
239
 
# File 'lib/zoom_us/phone_call_queues.rb', line 205

def create_call_queue_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneCallQueuesApi.create_call_queue ...'
  end
  # resource path
  local_var_path = '/phone/call_queues'

  # 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 => 'InlineResponse20123')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PhoneCallQueuesApi#create_call_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_a_call_queue(call_queue_id, opts = {}) ⇒ Object

Delete a Call Queue Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.
Use this API to delete a Call Queue.
Prerequisites:
* Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license
Scopes: ‘phone:write:admin`



245
246
247
248
 
# File 'lib/zoom_us/phone_call_queues.rb', line 245

def delete_a_call_queue(call_queue_id, opts = {})
  data, _status_code, _headers = delete_a_call_queue_with_http_info(call_queue_id, opts)
  data
end

#delete_a_call_queue_with_http_info(call_queue_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Delete a Call Queue Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.&lt;br&gt; Use this API to delete a Call Queue.&lt;br&gt; Prerequisites:&lt;br&gt; * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license&lt;br&gt; Scopes: &#x60;phone:write:admin&#x60;&lt;br&gt;



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/zoom_us/phone_call_queues.rb', line 255

def delete_a_call_queue_with_http_info(call_queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneCallQueuesApi.delete_a_call_queue ...'
  end
  # verify the required parameter 'call_queue_id' is set
  if @api_client.config.client_side_validation && call_queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_queue_id' when calling PhoneCallQueuesApi.delete_a_call_queue"
  end
  # resource path
  local_var_path = '/phone/call_queues/{callQueueId}'.sub('{' + 'callQueueId' + '}', call_queue_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: PhoneCallQueuesApi#delete_a_call_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_a_call_queue(call_queue_id, opts = {}) ⇒ InlineResponse20091

Get Call Queue Details Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.
Use this API to get information on a specific Call Queue.
Prerequisites:
* Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license
Scopes: ‘phone:read:admin`



299
300
301
302
 
# File 'lib/zoom_us/phone_call_queues.rb', line 299

def get_a_call_queue(call_queue_id, opts = {})
  data, _status_code, _headers = get_a_call_queue_with_http_info(call_queue_id, opts)
  data
end

#get_a_call_queue_with_http_info(call_queue_id, opts = {}) ⇒ Array<(InlineResponse20091, Fixnum, Hash)>

Get Call Queue Details Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.&lt;br&gt; Use this API to get information on a specific Call Queue.&lt;br&gt;&lt;br&gt; Prerequisites:&lt;br&gt; * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license&lt;br&gt; Scopes: &#x60;phone:read:admin&#x60;&lt;br&gt;



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/zoom_us/phone_call_queues.rb', line 309

def get_a_call_queue_with_http_info(call_queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneCallQueuesApi.get_a_call_queue ...'
  end
  # verify the required parameter 'call_queue_id' is set
  if @api_client.config.client_side_validation && call_queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_queue_id' when calling PhoneCallQueuesApi.get_a_call_queue"
  end
  # resource path
  local_var_path = '/phone/call_queues/{callQueueId}'.sub('{' + 'callQueueId' + '}', call_queue_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(: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 => 'InlineResponse20091')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PhoneCallQueuesApi#get_a_call_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_call_queues(opts = {}) ⇒ InlineResponse20090

List Call Queues Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.
Use this API to list Call queues.
Prerequisites:
* Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license
Scopes: ‘phone:read:admin`

Options Hash (opts):

  • :next_page_token (String) —

    The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

  • :page_size (Integer) —

    The number of records returned from a single API call. (default to 30)



354
355
356
357
 
# File 'lib/zoom_us/phone_call_queues.rb', line 354

def list_call_queues(opts = {})
  data, _status_code, _headers = list_call_queues_with_http_info(opts)
  data
end

#list_call_queues_with_http_info(opts = {}) ⇒ Array<(InlineResponse20090, Fixnum, Hash)>

List Call Queues Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.&lt;br&gt; Use this API to list Call queues.&lt;br&gt;&lt;br&gt; Prerequisites:&lt;br&gt; * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license&lt;br&gt; Scopes: &#x60;phone:read:admin&#x60;&lt;br&gt;

Options Hash (opts):

  • :next_page_token (String) —

    The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

  • :page_size (Integer) —

    The number of records returned from a single API call.



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/zoom_us/phone_call_queues.rb', line 365

def list_call_queues_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneCallQueuesApi.list_call_queues ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PhoneCallQueuesApi.list_call_queues, must be smaller than or equal to 100.'
  end

  # resource path
  local_var_path = '/phone/call_queues'

  # query parameters
  query_params = {}
  query_params[:'next_page_token'] = opts[:'next_page_token'] if !opts[:'next_page_token'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # 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 => 'InlineResponse20090')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PhoneCallQueuesApi#list_call_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#un_assign_phone_num_call_queue(call_queue_id, phone_number_id, opts = {}) ⇒ Object

Unassign a Phone Number After assigning a phone number, you can unbind it if you don’t want it to be assigned to a [Call Queue](support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues). Use this API to unbind a phone number from a Call Queue. After successful unbinding, the number will appear in the [Unassigned tab](zoom.us/signin#/numbers/unassigned).
Prerequisites: * Pro or higher account palan * Account owner or admin permissions * Zoom Phone license
Scopes: ‘phone:write:admin`



412
413
414
415
 
# File 'lib/zoom_us/phone_call_queues.rb', line 412

def un_assign_phone_num_call_queue(call_queue_id, phone_number_id, opts = {})
  data, _status_code, _headers = un_assign_phone_num_call_queue_with_http_info(call_queue_id, phone_number_id, opts)
  data
end

#un_assign_phone_num_call_queue_with_http_info(call_queue_id, phone_number_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Unassign a Phone Number After assigning a phone number, you can unbind it if you don&#39;t want it to be assigned to a [Call Queue](support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues). Use this API to unbind a phone number from a Call Queue. After successful unbinding, the number will appear in the [Unassigned tab](zoom.us/signin#/numbers/unassigned).&lt;br&gt;&lt;br&gt; Prerequisites: * Pro or higher account palan * Account owner or admin permissions * Zoom Phone license &lt;br&gt; Scopes: &#x60;phone:write:admin&#x60;&lt;br&gt;



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/zoom_us/phone_call_queues.rb', line 423

def un_assign_phone_num_call_queue_with_http_info(call_queue_id, phone_number_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneCallQueuesApi.un_assign_phone_num_call_queue ...'
  end
  # verify the required parameter 'call_queue_id' is set
  if @api_client.config.client_side_validation && call_queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_queue_id' when calling PhoneCallQueuesApi.un_assign_phone_num_call_queue"
  end
  # verify the required parameter 'phone_number_id' is set
  if @api_client.config.client_side_validation && phone_number_id.nil?
    fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling PhoneCallQueuesApi.un_assign_phone_num_call_queue"
  end
  # resource path
  local_var_path = '/phone/call_queues/{callQueueId}/phone_numbers/{phoneNumberId}'.sub('{' + 'callQueueId' + '}', call_queue_id.to_s).sub('{' + 'phoneNumberId' + '}', phone_number_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: PhoneCallQueuesApi#un_assign_phone_num_call_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unassign_a_phone_num_call_queue(call_queue_id, opts = {}) ⇒ Object

Unassign all Phone Numbers Use this API to unbind all phone numbers that are assigned to a [Call Queue](support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues) After successful unbinding, the numbers will appear in the [Unassigned tab](zoom.us/signin#/numbers/unassigned).
If you only need to unassign a specific phone number, use the Unassign a Phone Number API instead.
Prerequisites: * Pro or higher account palan * Account owner or admin permissions * Zoom Phone license
Scopes: ‘phone:write:admin`



471
472
473
474
 
# File 'lib/zoom_us/phone_call_queues.rb', line 471

def unassign_a_phone_num_call_queue(call_queue_id, opts = {})
  data, _status_code, _headers = unassign_a_phone_num_call_queue_with_http_info(call_queue_id, opts)
  data
end

#unassign_a_phone_num_call_queue_with_http_info(call_queue_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Unassign all Phone Numbers Use this API to unbind all phone numbers that are assigned to a [Call Queue](support.zoom.us/hc/en-us/articles/360021524831-Managing-Call-Queues) After successful unbinding, the numbers will appear in the [Unassigned tab](zoom.us/signin#/numbers/unassigned).&lt;br&gt; If you only need to unassign a specific phone number, use the Unassign a Phone Number API instead. &lt;br&gt; Prerequisites: * Pro or higher account palan * Account owner or admin permissions * Zoom Phone license &lt;br&gt; Scopes: &#x60;phone:write:admin&#x60;&lt;br&gt;



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/zoom_us/phone_call_queues.rb', line 481

def unassign_a_phone_num_call_queue_with_http_info(call_queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneCallQueuesApi.unassign_a_phone_num_call_queue ...'
  end
  # verify the required parameter 'call_queue_id' is set
  if @api_client.config.client_side_validation && call_queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_queue_id' when calling PhoneCallQueuesApi.unassign_a_phone_num_call_queue"
  end
  # resource path
  local_var_path = '/phone/call_queues/{callQueueId}/phone_numbers'.sub('{' + 'callQueueId' + '}', call_queue_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: PhoneCallQueuesApi#unassign_a_phone_num_call_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unassign_all_members(call_queue_id, opts = {}) ⇒ Object

Unassign all Members Use this API to remove all members from a Call Queue who were previously assigned to that Call Queue. The members could be phone users or [common area phones](support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones). Prerequisites:
* Pro or higher account plan. * Zoom Phone license
Scopes: ‘phone:write:admin`



525
526
527
528
 
# File 'lib/zoom_us/phone_call_queues.rb', line 525

def unassign_all_members(call_queue_id, opts = {})
  data, _status_code, _headers = unassign_all_members_with_http_info(call_queue_id, opts)
  data
end

#unassign_all_members_with_http_info(call_queue_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Unassign all Members Use this API to remove all members from a Call Queue who were previously assigned to that Call Queue. The members could be phone users or [common area phones](support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones). Prerequisites:&lt;br&gt; * Pro or higher account plan. * Zoom Phone license&lt;br&gt; Scopes: &#x60;phone:write:admin&#x60;&lt;br&gt;



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
 
# File 'lib/zoom_us/phone_call_queues.rb', line 535

def unassign_all_members_with_http_info(call_queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneCallQueuesApi.unassign_all_members ...'
  end
  # verify the required parameter 'call_queue_id' is set
  if @api_client.config.client_side_validation && call_queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_queue_id' when calling PhoneCallQueuesApi.unassign_all_members"
  end
  # resource path
  local_var_path = '/phone/call_queues/{callQueueId}/members'.sub('{' + 'callQueueId' + '}', call_queue_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: PhoneCallQueuesApi#unassign_all_members\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unassign_member_from_call_queue(call_queue_id, member_id, opts = {}) ⇒ Object

Unassign a Member Use this API to remove a member from a Call Queue who was previously added to that Call Queue. The member could be a phone user or a [common area phone](support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones). A member who is a Call Queue Manager cannot be unassigned from the Call Queue using this API. Prerequisites:
* Pro or higher account plan. * Zoom Phone license
Scopes: ‘phone:write:admin`



580
581
582
583
 
# File 'lib/zoom_us/phone_call_queues.rb', line 580

def unassign_member_from_call_queue(call_queue_id, member_id, opts = {})
  data, _status_code, _headers = unassign_member_from_call_queue_with_http_info(call_queue_id, member_id, opts)
  data
end

#unassign_member_from_call_queue_with_http_info(call_queue_id, member_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Unassign a Member Use this API to remove a member from a Call Queue who was previously added to that Call Queue. The member could be a phone user or a [common area phone](support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones). A member who is a Call Queue Manager cannot be unassigned from the Call Queue using this API. Prerequisites:&lt;br&gt; * Pro or higher account plan. * Zoom Phone license&lt;br&gt; Scopes: &#x60;phone:write:admin&#x60;&lt;br&gt;



591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/zoom_us/phone_call_queues.rb', line 591

def unassign_member_from_call_queue_with_http_info(call_queue_id, member_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneCallQueuesApi.unassign_member_from_call_queue ...'
  end
  # verify the required parameter 'call_queue_id' is set
  if @api_client.config.client_side_validation && call_queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_queue_id' when calling PhoneCallQueuesApi.unassign_member_from_call_queue"
  end
  # verify the required parameter 'member_id' is set
  if @api_client.config.client_side_validation && member_id.nil?
    fail ArgumentError, "Missing the required parameter 'member_id' when calling PhoneCallQueuesApi.unassign_member_from_call_queue"
  end
  # resource path
  local_var_path = '/phone/call_queues/{callQueueId}/members/{memberId}'.sub('{' + 'callQueueId' + '}', call_queue_id.to_s).sub('{' + 'memberId' + '}', member_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: PhoneCallQueuesApi#unassign_member_from_call_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_call_queue(call_queue_id, opts = {}) ⇒ Object

Update Call Queue Details Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.
Use this API to update information of a specific Call Queue.
Prerequisites:
* Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license
Scopes: ‘phone:write:admin`

Options Hash (opts):

  • :body (Body67) 


640
641
642
643
 
# File 'lib/zoom_us/phone_call_queues.rb', line 640

def update_call_queue(call_queue_id, opts = {})
  data, _status_code, _headers = update_call_queue_with_http_info(call_queue_id, opts)
  data
end

#update_call_queue_with_http_info(call_queue_id, opts = {}) ⇒ Array<(Object, Fixnum, Hash)>

Update Call Queue Details Call queues allow you to route incoming calls to a group of users. For instance, you can use call queues to route calls to various departments in your organization such as sales, engineering, billing, customer service etc.&lt;br&gt; Use this API to update information of a specific Call Queue.&lt;br&gt; Prerequisites:&lt;br&gt; * Pro, Business, or Education account * Account owner or admin permissions * Zoom Phone license&lt;br&gt; Scopes: &#x60;phone:write:admin&#x60;&lt;br&gt;

Options Hash (opts):

  • :body (Body67) 


651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
 
# File 'lib/zoom_us/phone_call_queues.rb', line 651

def update_call_queue_with_http_info(call_queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PhoneCallQueuesApi.update_call_queue ...'
  end
  # verify the required parameter 'call_queue_id' is set
  if @api_client.config.client_side_validation && call_queue_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_queue_id' when calling PhoneCallQueuesApi.update_call_queue"
  end
  # resource path
  local_var_path = '/phone/call_queues/{callQueueId}'.sub('{' + 'callQueueId' + '}', call_queue_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: PhoneCallQueuesApi#update_call_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end