CreateCall.md

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:user@server.example`)).	[default to undefined]
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.	[default to undefined]
privacy	boolean	Hide the calling number. The `displayName` field can be used to customize the displayed name.	[optional] [default to undefined]
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] [default to undefined]
uui	string	A comma-separated list of &#39;User-To-User&#39; headers to be sent in the INVITE when calling a SIP URI. Each value must end with an &#39;encoding&#39; parameter as described in <a href=&#39;https://tools.ietf.org/html/rfc7433\&#39;&gt;RFC 7433</a>. Only &#39;jwt&#39;, &#39;base64&#39; and &#39;hex&#39; encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators.	[optional] [default to undefined]
applicationId	string	The id of the application associated with the `from` number.	[default to undefined]
answerUrl	string	The full URL to send the <a href=&#39;/docs/voice/webhooks/answer&#39;>Answer</a> event to when the called party answers. This endpoint should return the first <a href=&#39;/docs/voice/bxml&#39;>BXML document</a> to be executed in the call. Must use `https` if specifying `username` and `password`.	[default to undefined]
answerMethod	CallbackMethodEnum		[optional] [default to undefined]
username	string	Basic auth username.	[optional] [default to undefined]
password	string	Basic auth password.	[optional] [default to undefined]
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] [default to undefined]
answerFallbackMethod	CallbackMethodEnum		[optional] [default to undefined]
fallbackUsername	string	Basic auth username.	[optional] [default to undefined]
fallbackPassword	string	Basic auth password.	[optional] [default to undefined]
disconnectUrl	string	The URL to send the <a href=&#39;/docs/voice/webhooks/disconnect&#39;>Disconnect</a> event to when the call ends. This event does not expect a BXML response.	[optional] [default to undefined]
disconnectMethod	CallbackMethodEnum		[optional] [default to undefined]
callTimeout	number	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]
callbackTimeout	number	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]
machineDetection	MachineDetectionConfiguration		[optional] [default to undefined]
priority	number	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=&#39;/docs/voice/bxml/tag&#39;>`<Tag>`</a> verb or `tag` attribute on another verb, or cleared. May be cleared by setting `tag=&quot;&quot;` Max length 256 characters.	[optional] [default to undefined]

Example

import { CreateCall } from 'bandwidth-sdk';

const instance: CreateCall = {
    to,
    from,
    privacy,
    displayName,
    uui,
    applicationId,
    answerUrl,
    answerMethod,
    username,
    password,
    answerFallbackUrl,
    answerFallbackMethod,
    fallbackUsername,
    fallbackPassword,
    disconnectUrl,
    disconnectMethod,
    callTimeout,
    callbackTimeout,
    machineDetection,
    priority,
    tag,
};

[Back to Model list] [Back to API list] [Back to README]