Skip to content

Latest commit

 

History

History
137 lines (89 loc) · 6.66 KB

InitiateCallRequest.md

File metadata and controls

137 lines (89 loc) · 6.66 KB
Raw

InitiateCallRequest

Properties

Name Type Description Notes
applicationSid String The ID of the TeXML Application.
to String The phone number of the called party. Phone numbers are formatted with a `+` and country code.
from String The phone number of the party that initiated the call. Phone numbers are formatted with a `+` and country code.
url String The URL from which Telnyx will retrieve the TeXML call instructions. [optional]
urlMethod UrlMethodEnum HTTP request type used for `Url`. The default value is inherited from TeXML Application setting. [optional]
fallbackUrl String A failover URL for which Telnyx will retrieve the TeXML call instructions if the `Url` is not responding. [optional]
statusCallback String URL destination for Telnyx to send status callback events to for the call. [optional]
statusCallbackMethod StatusCallbackMethodEnum HTTP request type used for `StatusCallback`. [optional]
statusCallbackEvent StatusCallbackEventEnum The call events for which Telnyx should send a webhook. Multiple events can be defined when separated by a space. [optional]
machineDetection MachineDetectionEnum Enables Answering Machine Detection. [optional]
detectionMode DetectionModeEnum Allows you to chose between Premium and Standard detections. [optional]
asyncAmd Boolean Select whether to perform answering machine detection in the background. By default execution is blocked until Answering Machine Detection is completed. [optional]
asyncAmdStatusCallback String URL destination for Telnyx to send AMD callback events to for the call. [optional]
asyncAmdStatusCallbackMethod AsyncAmdStatusCallbackMethodEnum HTTP request type used for `AsyncAmdStatusCallback`. The default value is inherited from TeXML Application setting. [optional]
machineDetectionTimeout Integer Maximum timeout threshold in milliseconds for overall detection. [optional]
machineDetectionSpeechThreshold Integer Maximum threshold of a human greeting. If greeting longer than this value, considered machine. Ignored when `premium` detection is used. [optional]
machineDetectionSpeechEndThreshold Integer Silence duration threshold after a greeting message or voice for it be considered human. Ignored when `premium` detection is used. [optional]
machineDetectionSilenceTimeout Integer If initial silence duration is greater than this value, consider it a machine. Ignored when `premium` detection is used. [optional]
cancelPlaybackOnMachineDetection Boolean Whether to cancel ongoing playback on `machine` detection. Defaults to `true`. [optional]
cancelPlaybackOnDetectMessageEnd Boolean Whether to cancel ongoing playback on `greeting ended` detection. Defaults to `true`. [optional]
preferredCodecs String The list of comma-separated codecs to be offered on a call. [optional]
record Boolean Whether to record the entire participant's call leg. Defaults to `false`. [optional]
recordingChannels RecordingChannelsEnum The number of channels in the final recording. Defaults to `mono`. [optional]
recordingStatusCallback String The URL the recording callbacks will be sent to. [optional]
recordingStatusCallbackMethod RecordingStatusCallbackMethodEnum HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`. [optional]
recordingStatusCallbackEvent String The changes to the recording's state that should generate a call to `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`. Separate multiple values with a space. Defaults to `completed`. [optional]
recordingTimeout Integer The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that the transcription is used to detect silence and the related charge will be applied. The minimum value is 0. The default value is 0 (infinite) [optional]
recordingTrack RecordingTrackEnum The audio track to record for the call. The default is `both`. [optional]
sipAuthPassword String The password to use for SIP authentication. [optional]
sipAuthUsername String The username to use for SIP authentication. [optional]
trim TrimEnum Whether to trim any leading and trailing silence from the recording. Defaults to `trim-silence`. [optional]

Enum: UrlMethodEnum

Name Value
GET "GET"
POST "POST"

Enum: StatusCallbackMethodEnum

Name Value
GET "GET"
POST "POST"

Enum: StatusCallbackEventEnum

Name Value
INITIATED "initiated"
RINGING "ringing"
ANSWERED "answered"
COMPLETED "completed"

Enum: MachineDetectionEnum

Name Value
ENABLE "Enable"
DISABLE "Disable"
DETECTMESSAGEEND "DetectMessageEnd"

Enum: DetectionModeEnum

Name Value
PREMIUM "Premium"
REGULAR "Regular"

Enum: AsyncAmdStatusCallbackMethodEnum

Name Value
GET "GET"
POST "POST"

Enum: RecordingChannelsEnum

Name Value
MONO "mono"
DUAL "dual"

Enum: RecordingStatusCallbackMethodEnum

Name Value
GET "GET"
POST "POST"

Enum: RecordingTrackEnum

Name Value
INBOUND "inbound"
OUTBOUND "outbound"
BOTH "both"

Enum: TrimEnum

Name Value
TRIM_SILENCE "trim-silence"
DO_NOT_TRIM "do-not-trim"