| 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 |
bool? |
Hide the calling number. The `displayName` field can be used to customize the displayed name. |
[optional] |
| DisplayName |
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'>RFC 7433</a>. Only 'jwt' and 'base64' encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators. |
[optional] |
| ApplicationId |
string |
The id of the application associated with the `from` number. |
|
| AnswerUrl |
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`. |
|
| AnswerMethod |
CallbackMethodEnum |
|
[optional] |
| Username |
string |
Basic auth username. |
[optional] |
| Password |
string |
Basic auth password. |
[optional] |
| AnswerFallbackUrl |
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] |
| AnswerFallbackMethod |
CallbackMethodEnum |
|
[optional] |
| FallbackUsername |
string |
Basic auth username. |
[optional] |
| FallbackPassword |
string |
Basic auth password. |
[optional] |
| DisconnectUrl |
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] |
| DisconnectMethod |
CallbackMethodEnum |
|
[optional] |
| CallTimeout |
double? |
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 30D] |
| CallbackTimeout |
double? |
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 15D] |
| MachineDetection |
MachineDetectionConfiguration |
|
[optional] |
| Priority |
int? |
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=""` Max length 256 characters. |
[optional] |