Skip to content

Latest commit

 

History

History
58 lines (52 loc) · 5.42 KB

CreateCall.md

File metadata and controls

58 lines (52 loc) · 5.42 KB
Raw

Bandwidth::CreateCall

Properties

Name Type Description Notes
to String The destination to call (must be an E.164 formatted number (e.g. `+15555551212`) or a SIP URI (e.g. `sip:[email protected]`)).
from String A Bandwidth phone number on your account the call should come from (must be in E.164 format, like `+15555551212`) even if `privacy` is set to true.
privacy Boolean Hide the calling number. The `displayName` field can be used to customize the displayed name. [optional]
display_name String The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If `privacy` is true, only the following values are valid: `Restricted`, `Anonymous`, `Private`, or `Unavailable`. [optional]
uui String A comma-separated list of 'User-To-User' headers to be sent in the INVITE when calling a SIP URI. Each value must end with an 'encoding' parameter as described in <a href='https://tools.ietf.org/html/rfc7433&#39;&gt;RFC 7433</a>. Only 'jwt', 'base64' and 'hex' encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators. [optional]
application_id String The id of the application associated with the `from` number.
answer_url String The full URL to send the <a href='/docs/voice/webhooks/answer'>Answer</a> event to when the called party answers. This endpoint should return the first <a href='/docs/voice/bxml'>BXML document</a> to be executed in the call. Must use `https` if specifying `username` and `password`.
answer_method CallbackMethodEnum [optional][default to 'POST']
username String Basic auth username. [optional]
password String Basic auth password. [optional]
answer_fallback_url String A fallback url which, if provided, will be used to retry the `answer` webhook delivery in case `answerUrl` fails to respond Must use `https` if specifying `fallbackUsername` and `fallbackPassword`. [optional]
answer_fallback_method CallbackMethodEnum [optional][default to 'POST']
fallback_username String Basic auth username. [optional]
fallback_password String Basic auth password. [optional]
disconnect_url String The URL to send the <a href='/docs/voice/webhooks/disconnect'>Disconnect</a> event to when the call ends. This event does not expect a BXML response. [optional]
disconnect_method CallbackMethodEnum [optional][default to 'POST']
call_timeout Float The timeout (in seconds) for the callee to answer the call after it starts ringing. If the call does not start ringing within 30s, the call will be cancelled regardless of this value. Can be any numeric value (including decimals) between 1 and 300. [optional][default to 30]
callback_timeout Float This is the timeout (in seconds) to use when delivering webhooks for the call. Can be any numeric value (including decimals) between 1 and 25. [optional][default to 15]
machine_detection MachineDetectionConfiguration [optional]
priority Integer The priority of this call over other calls from your account. For example, if during a call your application needs to place a new call and bridge it with the current call, you might want to create the call with priority 1 so that it will be the next call picked off your queue, ahead of other less time sensitive calls. A lower value means higher priority, so a priority 1 call takes precedence over a priority 2 call. [optional][default to 5]
tag String A custom string that will be sent with all webhooks for this call unless overwritten by a future <a href='/docs/voice/bxml/tag'>`<Tag>`</a> verb or `tag` attribute on another verb, or cleared. May be cleared by setting `tag=&quot;&quot;` Max length 256 characters. [optional]

Example

require 'bandwidth-sdk'

instance = Bandwidth::CreateCall.new(
  to: +19195551234,
  from: +15555551212,
  privacy: false,
  display_name: John Doe,
  uui: eyJhbGciOiJIUzI1NiJ9.WyJoaSJd.-znkjYyCkgz4djmHUPSXl9YrJ6Nix_XvmlwKGFh5ERM;encoding&#x3D;jwt,aGVsbG8gd29ybGQ;encoding&#x3D;base64,
  application_id: 1234-qwer-5679-tyui,
  answer_url: https://www.myCallbackServer.example/webhooks/answer,
  answer_method: null,
  username: mySecretUsername,
  password: mySecretPassword1!,
  answer_fallback_url: https://www.myFallbackServer.example/webhooks/answer,
  answer_fallback_method: null,
  fallback_username: mySecretUsername,
  fallback_password: mySecretPassword1!,
  disconnect_url: https://www.myCallbackServer.example/webhooks/disconnect,
  disconnect_method: null,
  call_timeout: 30,
  callback_timeout: 15,
  machine_detection: null,
  priority: 5,
  tag: arbitrary text here
)