Class: Bandwidth::CallsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bandwidth-sdk/api/calls_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CallsApi

Returns a new instance of CallsApi.



19
20
21
 
# File 'lib/bandwidth-sdk/api/calls_api.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/bandwidth-sdk/api/calls_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_call(account_id, create_call, opts = {}) ⇒ CreateCallResponse

Create Call Creates an outbound phone call. All calls are initially queued. Your outbound calls will initiated at a specific dequeueing rate, enabling your application to "fire and forget" when creating calls. Queued calls may not be modified until they are dequeued and placed, but may be removed from your queue on demand. Please note: Calls submitted to your queue will be placed approximately in order, but exact ordering is not guaranteed.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • create_call (CreateCall) —

    JSON object containing information to create an outbound call

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/bandwidth-sdk/api/calls_api.rb', line 28

def create_call(, create_call, opts = {})
  data, _status_code, _headers = create_call_with_http_info(, create_call, opts)
  data
end

#create_call_with_http_info(account_id, create_call, opts = {}) ⇒ Array<(CreateCallResponse, Integer, Hash)>

Create Call Creates an outbound phone call. All calls are initially queued. Your outbound calls will initiated at a specific dequeueing rate, enabling your application to &quot;fire and forget&quot; when creating calls. Queued calls may not be modified until they are dequeued and placed, but may be removed from your queue on demand. &lt;b&gt;Please note:&lt;/b&gt; Calls submitted to your queue will be placed approximately in order, but exact ordering is not guaranteed.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • create_call (CreateCall) —

    JSON object containing information to create an outbound call

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

    the optional parameters

Returns:

  • (Array<(CreateCallResponse, Integer, Hash)>) —

    CreateCallResponse 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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/bandwidth-sdk/api/calls_api.rb', line 39

def create_call_with_http_info(, create_call, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CallsApi.create_call ...'
  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 CallsApi.create_call"
  end
  # verify the required parameter 'create_call' is set
  if @api_client.config.client_side_validation && create_call.nil?
    fail ArgumentError, "Missing the required parameter 'create_call' when calling CallsApi.create_call"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/calls'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_call)

  # return_type
  return_type = opts[:debug_return_type] || 'CreateCallResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"CallsApi.create_call",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CallsApi#create_call\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_call_state(account_id, call_id, opts = {}) ⇒ CallState

Get Call State Information Retrieve the current state of a specific call. This information is near-realtime, so it may take a few minutes for your call to be accessible using this endpoint. Note: Call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an HTTP 404 response.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • call_id (String) —

    Programmable Voice API Call ID.

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

    the optional parameters

Returns:



102
103
104
105
 
# File 'lib/bandwidth-sdk/api/calls_api.rb', line 102

def get_call_state(, call_id, opts = {})
  data, _status_code, _headers = get_call_state_with_http_info(, call_id, opts)
  data
end

#get_call_state_with_http_info(account_id, call_id, opts = {}) ⇒ Array<(CallState, Integer, Hash)>

Get Call State Information Retrieve the current state of a specific call. This information is near-realtime, so it may take a few minutes for your call to be accessible using this endpoint. Note: Call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an HTTP 404 response.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • call_id (String) —

    Programmable Voice API Call ID.

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

    the optional parameters

Returns:

  • (Array<(CallState, Integer, Hash)>) —

    CallState data, response status code and response headers



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/bandwidth-sdk/api/calls_api.rb', line 113

def get_call_state_with_http_info(, call_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CallsApi.get_call_state ...'
  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 CallsApi.get_call_state"
  end
  # verify the required parameter 'call_id' is set
  if @api_client.config.client_side_validation && call_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_id' when calling CallsApi.get_call_state"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/calls/{callId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'callId' + '}', CGI.escape(call_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CallState'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"CallsApi.get_call_state",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CallsApi#get_call_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_calls(account_id, opts = {}) ⇒ Array<CallState>

Get Calls Returns a max of 10000 calls, sorted by ‘createdTime` from oldest to newest. NOTE: If the number of calls in the account is bigger than `pageSize`, a `Link` header (with format `<url>; rel="next"`) will be returned in the response. The url can be used to retrieve the next page of call records. Also, call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an empty array [] in response.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

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

    the optional parameters

Options Hash (opts):

  • :to (String) —

    Filter results by the &#x60;to&#x60; field.

  • :from (String) —

    Filter results by the &#x60;from&#x60; field.

  • :min_start_time (String) —

    Filter results to calls which have a &#x60;startTime&#x60; after or including &#x60;minStartTime&#x60; (in ISO8601 format).

  • :max_start_time (String) —

    Filter results to calls which have a &#x60;startTime&#x60; before or including &#x60;maxStartTime&#x60; (in ISO8601 format).

  • :disconnect_cause (String) —

    Filter results to calls with specified call Disconnect Cause.

  • :page_size (Integer) —

    Specifies the max number of calls that will be returned. (default to 1000)

  • :page_token (String) —

    Not intended for explicit use. To use pagination, follow the links in the &#x60;Link&#x60; header of the response, as indicated in the endpoint description.

Returns:



177
178
179
180
 
# File 'lib/bandwidth-sdk/api/calls_api.rb', line 177

def list_calls(, opts = {})
  data, _status_code, _headers = list_calls_with_http_info(, opts)
  data
end

#list_calls_with_http_info(account_id, opts = {}) ⇒ Array<(Array<CallState>, Integer, Hash)>

Get Calls Returns a max of 10000 calls, sorted by &#x60;createdTime&#x60; from oldest to newest. NOTE: If the number of calls in the account is bigger than &#x60;pageSize&#x60;, a &#x60;Link&#x60; header (with format &#x60;&lt;url&gt;; rel&#x3D;&quot;next&quot;&#x60;) will be returned in the response. The url can be used to retrieve the next page of call records. Also, call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an empty array [] in response.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

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

    the optional parameters

Options Hash (opts):

  • :to (String) —

    Filter results by the &#x60;to&#x60; field.

  • :from (String) —

    Filter results by the &#x60;from&#x60; field.

  • :min_start_time (String) —

    Filter results to calls which have a &#x60;startTime&#x60; after or including &#x60;minStartTime&#x60; (in ISO8601 format).

  • :max_start_time (String) —

    Filter results to calls which have a &#x60;startTime&#x60; before or including &#x60;maxStartTime&#x60; (in ISO8601 format).

  • :disconnect_cause (String) —

    Filter results to calls with specified call Disconnect Cause.

  • :page_size (Integer) —

    Specifies the max number of calls that will be returned. (default to 1000)

  • :page_token (String) —

    Not intended for explicit use. To use pagination, follow the links in the &#x60;Link&#x60; header of the response, as indicated in the endpoint description.

Returns:

  • (Array<(Array<CallState>, Integer, Hash)>) —

    Array<CallState> data, response status code and response headers



194
195
196
197
198
199
200
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
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/bandwidth-sdk/api/calls_api.rb', line 194

def list_calls_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CallsApi.list_calls ...'
  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 CallsApi.list_calls"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CallsApi.list_calls, must be smaller than or equal to 10000.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CallsApi.list_calls, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/accounts/{accountId}/calls'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'minStartTime'] = opts[:'min_start_time'] if !opts[:'min_start_time'].nil?
  query_params[:'maxStartTime'] = opts[:'max_start_time'] if !opts[:'max_start_time'].nil?
  query_params[:'disconnectCause'] = opts[:'disconnect_cause'] if !opts[:'disconnect_cause'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'pageToken'] = opts[:'page_token'] if !opts[:'page_token'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<CallState>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"CallsApi.list_calls",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CallsApi#list_calls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_call(account_id, call_id, update_call, opts = {}) ⇒ nil

Update Call Interrupts and redirects a call to a different URL that should return a BXML document.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • call_id (String) —

    Programmable Voice API Call ID.

  • update_call (UpdateCall) —

    JSON object containing information to redirect an existing call to a new BXML document

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

    the optional parameters

Returns:

  • (nil) 


264
265
266
267
 
# File 'lib/bandwidth-sdk/api/calls_api.rb', line 264

def update_call(, call_id, update_call, opts = {})
  update_call_with_http_info(, call_id, update_call, opts)
  nil
end

#update_call_bxml(account_id, call_id, body, opts = {}) ⇒ nil

Update Call BXML Interrupts and replaces an active call’s BXML document.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • call_id (String) —

    Programmable Voice API Call ID.

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

    the optional parameters

Returns:

  • (nil) 


344
345
346
347
 
# File 'lib/bandwidth-sdk/api/calls_api.rb', line 344

def update_call_bxml(, call_id, body, opts = {})
  update_call_bxml_with_http_info(, call_id, body, opts)
  nil
end

#update_call_bxml_with_http_info(account_id, call_id, body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update Call BXML Interrupts and replaces an active call&#39;s BXML document.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • call_id (String) —

    Programmable Voice API Call ID.

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



356
357
358
359
360
361
362
363
364
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
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/bandwidth-sdk/api/calls_api.rb', line 356

def update_call_bxml_with_http_info(, call_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CallsApi.update_call_bxml ...'
  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 CallsApi.update_call_bxml"
  end
  # verify the required parameter 'call_id' is set
  if @api_client.config.client_side_validation && call_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_id' when calling CallsApi.update_call_bxml"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CallsApi.update_call_bxml"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/calls/{callId}/bxml'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'callId' + '}', CGI.escape(call_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/xml'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"CallsApi.update_call_bxml",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CallsApi#update_call_bxml\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_call_with_http_info(account_id, call_id, update_call, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update Call Interrupts and redirects a call to a different URL that should return a BXML document.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • call_id (String) —

    Programmable Voice API Call ID.

  • update_call (UpdateCall) —

    JSON object containing information to redirect an existing call to a new BXML document

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
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
 
# File 'lib/bandwidth-sdk/api/calls_api.rb', line 276

def update_call_with_http_info(, call_id, update_call, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CallsApi.update_call ...'
  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 CallsApi.update_call"
  end
  # verify the required parameter 'call_id' is set
  if @api_client.config.client_side_validation && call_id.nil?
    fail ArgumentError, "Missing the required parameter 'call_id' when calling CallsApi.update_call"
  end
  # verify the required parameter 'update_call' is set
  if @api_client.config.client_side_validation && update_call.nil?
    fail ArgumentError, "Missing the required parameter 'update_call' when calling CallsApi.update_call"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/calls/{callId}'.sub('{' + 'accountId' + '}', CGI.escape(.to_s)).sub('{' + 'callId' + '}', CGI.escape(call_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_call)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"CallsApi.update_call",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CallsApi#update_call\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end