Bandwidth::CallsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
create_call	POST /accounts/{accountId}/calls	Create Call
get_call_state	GET /accounts/{accountId}/calls/{callId}	Get Call State Information
list_calls	GET /accounts/{accountId}/calls	Get Calls
update_call	POST /accounts/{accountId}/calls/{callId}	Update Call
update_call_bxml	PUT /accounts/{accountId}/calls/{callId}/bxml	Update Call BXML

create_call

create_call(account_id, create_call)

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.

Examples

require 'time'
require 'bandwidth-sdk'
# setup authorization
Bandwidth.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Bandwidth::CallsApi.new
account_id = '9900000' # String | Your Bandwidth Account ID.
create_call = Bandwidth::CreateCall.new({to: '+19195551234', from: '+15555551212', application_id: '1234-qwer-5679-tyui', answer_url: 'https://www.myCallbackServer.example/webhooks/answer'}) # CreateCall | JSON object containing information to create an outbound call

begin
  # Create Call
  result = api_instance.create_call(account_id, create_call)
  p result
rescue Bandwidth::ApiError => e
  puts "Error when calling CallsApi->create_call: #{e}"
end

Using the create_call_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_call_with_http_info(account_id, create_call)

begin
  # Create Call
  data, status_code, headers = api_instance.create_call_with_http_info(account_id, create_call)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CreateCallResponse>
rescue Bandwidth::ApiError => e
  puts "Error when calling CallsApi->create_call_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
account_id	String	Your Bandwidth Account ID.
create_call	CreateCall	JSON object containing information to create an outbound call

Return type

CreateCallResponse

Authorization

Basic

HTTP request headers

Content-Type: application/json
Accept: application/json

get_call_state

get_call_state(account_id, call_id)

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.

Examples

require 'time'
require 'bandwidth-sdk'
# setup authorization
Bandwidth.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Bandwidth::CallsApi.new
account_id = '9900000' # String | Your Bandwidth Account ID.
call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID.

begin
  # Get Call State Information
  result = api_instance.get_call_state(account_id, call_id)
  p result
rescue Bandwidth::ApiError => e
  puts "Error when calling CallsApi->get_call_state: #{e}"
end

Using the get_call_state_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_call_state_with_http_info(account_id, call_id)

begin
  # Get Call State Information
  data, status_code, headers = api_instance.get_call_state_with_http_info(account_id, call_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CallState>
rescue Bandwidth::ApiError => e
  puts "Error when calling CallsApi->get_call_state_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
account_id	String	Your Bandwidth Account ID.
call_id	String	Programmable Voice API Call ID.

Return type

CallState

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

list_calls

<Array> list_calls(account_id, opts)

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.

Examples

require 'time'
require 'bandwidth-sdk'
# setup authorization
Bandwidth.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Bandwidth::CallsApi.new
account_id = '9900000' # String | Your Bandwidth Account ID.
opts = {
  to: '%2b19195551234', # String | Filter results by the `to` field.
  from: '%2b19195554321', # String | Filter results by the `from` field.
  min_start_time: '2022-06-21T19:13:21Z', # String | Filter results to calls which have a `startTime` after or including `minStartTime` (in ISO8601 format).
  max_start_time: '2022-06-21T19:13:21Z', # String | Filter results to calls which have a `startTime` before or including `maxStartTime` (in ISO8601 format).
  disconnect_cause: 'hangup', # String | Filter results to calls with specified call Disconnect Cause.
  page_size: 500, # Integer | Specifies the max number of calls that will be returned.
  page_token: 'page_token_example' # String | Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description.
}

begin
  # Get Calls
  result = api_instance.list_calls(account_id, opts)
  p result
rescue Bandwidth::ApiError => e
  puts "Error when calling CallsApi->list_calls: #{e}"
end

Using the list_calls_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> list_calls_with_http_info(account_id, opts)

begin
  # Get Calls
  data, status_code, headers = api_instance.list_calls_with_http_info(account_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<CallState>>
rescue Bandwidth::ApiError => e
  puts "Error when calling CallsApi->list_calls_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
account_id	String	Your Bandwidth Account ID.
to	String	Filter results by the `to` field.	[optional]
from	String	Filter results by the `from` field.	[optional]
min_start_time	String	Filter results to calls which have a `startTime` after or including `minStartTime` (in ISO8601 format).	[optional]
max_start_time	String	Filter results to calls which have a `startTime` before or including `maxStartTime` (in ISO8601 format).	[optional]
disconnect_cause	String	Filter results to calls with specified call Disconnect Cause.	[optional]
page_size	Integer	Specifies the max number of calls that will be returned.	[optional][default to 1000]
page_token	String	Not intended for explicit use. To use pagination, follow the links in the `Link` header of the response, as indicated in the endpoint description.	[optional]

Return type

Array<CallState>

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

update_call

update_call(account_id, call_id, update_call)

Update Call

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

Examples

require 'time'
require 'bandwidth-sdk'
# setup authorization
Bandwidth.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Bandwidth::CallsApi.new
account_id = '9900000' # String | Your Bandwidth Account ID.
call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID.
update_call = Bandwidth::UpdateCall.new # UpdateCall | JSON object containing information to redirect an existing call to a new BXML document

begin
  # Update Call
  api_instance.update_call(account_id, call_id, update_call)
rescue Bandwidth::ApiError => e
  puts "Error when calling CallsApi->update_call: #{e}"
end

Using the update_call_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> update_call_with_http_info(account_id, call_id, update_call)

begin
  # Update Call
  data, status_code, headers = api_instance.update_call_with_http_info(account_id, call_id, update_call)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Bandwidth::ApiError => e
  puts "Error when calling CallsApi->update_call_with_http_info: #{e}"
end

Parameters

Name	Type	Description
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

Return type

nil (empty response body)

Authorization

Basic

HTTP request headers

Content-Type: application/json
Accept: application/json

update_call_bxml

update_call_bxml(account_id, call_id, body)

Update Call BXML

Interrupts and replaces an active call's BXML document.

Examples

require 'time'
require 'bandwidth-sdk'
# setup authorization
Bandwidth.configure do |config|
  # Configure HTTP basic authorization: Basic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = Bandwidth::CallsApi.new
account_id = '9900000' # String | Your Bandwidth Account ID.
call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID.
body = '<?xml version=\"1.0\" encoding=\"UTF-8\"?>
<Bxml>
  <SpeakSentence>This is a test sentence.</SpeakSentence>
</Bxml>' # String | 

begin
  # Update Call BXML
  api_instance.update_call_bxml(account_id, call_id, body)
rescue Bandwidth::ApiError => e
  puts "Error when calling CallsApi->update_call_bxml: #{e}"
end

Using the update_call_bxml_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> update_call_bxml_with_http_info(account_id, call_id, body)

begin
  # Update Call BXML
  data, status_code, headers = api_instance.update_call_bxml_with_http_info(account_id, call_id, body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Bandwidth::ApiError => e
  puts "Error when calling CallsApi->update_call_bxml_with_http_info: #{e}"
end

Parameters

Name	Type	Description
account_id	String	Your Bandwidth Account ID.
call_id	String	Programmable Voice API Call ID.
body	String

Return type

nil (empty response body)

Authorization

Basic

HTTP request headers

Content-Type: application/xml
Accept: application/json

Files

CallsApi.md

Latest commit

History

CallsApi.md

File metadata and controls

Bandwidth::CallsApi

create_call

Examples

Using the create_call_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_call_state

Examples

Using the get_call_state_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

list_calls

Examples

Using the list_calls_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

update_call

Examples

Using the update_call_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

update_call_bxml

Examples

Using the update_call_bxml_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers