Skip to content

Latest commit

 

History

History
133 lines (89 loc) · 9.18 KB

CallRequest.md

File metadata and controls

133 lines (89 loc) · 9.18 KB
Raw

CallRequest

Properties

Name Type Description Notes
to CallRequestTo
from String The `from` number to be used as the caller id presented to the destination (`to` number). The number should be in +E164 format.
fromDisplayName String The `from_display_name` string to be used as the caller id name (SIP From Display Name) presented to the destination (`to` number). The string should have a maximum of 128 characters, containing only letters, numbers, spaces, and -_~!.+ special characters. If ommited, the display name will be the same as the number in the `from` field. [optional]
connectionId String The ID of the Call Control App (formerly ID of the connection) to be used when dialing the destination.
audioUrl String The URL of a file to be played back to the callee when the call is answered. The URL can point to either a WAV or MP3 file. media_name and audio_url cannot be used together in one request. [optional]
mediaName String The media_name of a file to be played back to the callee when the call is answered. The media_name must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. The file must either be a WAV or MP3 file. [optional]
preferredCodecs String The list of comma-separated codecs in a preferred order for the forked media to be received. [optional]
timeoutSecs Integer The number of seconds that Telnyx will wait for the call to be answered by the destination to which it is being called. If the timeout is reached before an answer is received, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `timeout` will be sent. Minimum value is 5 seconds. Maximum value is 120 seconds. [optional]
timeLimitSecs Integer Sets the maximum duration of a Call Control Leg in seconds. If the time limit is reached, the call will hangup and a `call.hangup` webhook with a `hangup_cause` of `time_limit` will be sent. For example, by setting a time limit of 120 seconds, a Call Leg will be automatically terminated two minutes after being answered. The default time limit is 14400 seconds or 4 hours and this is also the maximum allowed call length. [optional]
answeringMachineDetection AnsweringMachineDetectionEnum Enables Answering Machine Detection. Telnyx offers Premium and Standard detections. With Premium detection, when a call is answered, Telnyx runs real-time detection and sends a `call.machine.premium.detection.ended` webhook with one of the following results: `human_residence`, `human_business`, `machine`, `silence` or `fax_detected`. If we detect a beep, we also send a `call.machine.premium.greeting.ended` webhook with the result of `beep_detected`. If we detect a beep before `call.machine.premium.detection.ended` we only send `call.machine.premium.greeting.ended`, and if we detect a beep after `call.machine.premium.detection.ended`, we send both webhooks. With Standard detection, when a call is answered, Telnyx runs real-time detection to determine if it was picked up by a human or a machine and sends an `call.machine.detection.ended` webhook with the analysis result. If `greeting_end` or `detect_words` is used and a `machine` is detected, you will receive another `call.machine.greeting.ended` webhook when the answering machine greeting ends with a beep or silence. If `detect_beep` is used, you will only receive `call.machine.greeting.ended` if a beep is detected. [optional]
answeringMachineDetectionConfig CallRequestAnsweringMachineDetectionConfig [optional]
customHeaders List<CustomSipHeader> Custom headers to be added to the SIP INVITE. [optional]
billingGroupId UUID Use this field to set the Billing Group ID for the call. Must be a valid and existing Billing Group ID. [optional]
clientState String Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. [optional]
commandId String Use this field to avoid duplicate commands. Telnyx will ignore others Dial commands with the same `command_id`. [optional]
linkTo String Use another call's control id for sharing the same call session id [optional]
mediaEncryption MediaEncryptionEnum Defines whether media should be encrypted on the call. [optional]
sipAuthUsername String SIP Authentication username used for SIP challenges. [optional]
sipAuthPassword String SIP Authentication password used for SIP challenges. [optional]
sipHeaders List<SipHeader> SIP headers to be added to the SIP INVITE request. Currently only User-to-User header is supported. [optional]
sipTransportProtocol SipTransportProtocolEnum Defines SIP transport protocol to be used on the call. [optional]
soundModifications SoundModifications [optional]
streamUrl String The destination WebSocket address where the stream is going to be delivered. [optional]
streamTrack StreamTrackEnum Specifies which track should be streamed. [optional]
sendSilenceWhenIdle Boolean Generate silence RTP packets when no transmission available. [optional]
webhookUrl String Use this field to override the URL for which Telnyx will send subsequent webhooks to for this call. [optional]
webhookUrlMethod WebhookUrlMethodEnum HTTP request type used for `webhook_url`. [optional]
record RecordEnum Start recording automatically after an event. Disabled by default. [optional]
recordChannels RecordChannelsEnum Defines which channel should be recorded ('single' or 'dual') when `record` is specified. [optional]
recordFormat RecordFormatEnum Defines the format of the recording ('wav' or 'mp3') when `record` is specified. [optional]
recordMaxLength Integer Defines the maximum length for the recording in seconds when `record` is specified. The minimum value is 0. The maximum value is 43200. The default value is 0 (infinite). [optional]
recordTimeoutSecs Integer The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected when `record` is specified. The timer only starts when the speech is detected. Please note that call 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]
recordTrim RecordTrimEnum When set to `trim-silence`, silence will be removed from the beginning and end of the recording. [optional]
recordCustomFileName String The custom recording file name to be used instead of the default `call_leg_id`. Telnyx will still add a Unix timestamp suffix. [optional]
enableDialogflow Boolean Enables Dialogflow for the current call. The default value is false. [optional]
dialogflowConfig DialogflowConfig [optional]

Enum: AnsweringMachineDetectionEnum

Name Value
PREMIUM "premium"
DETECT "detect"
DETECT_BEEP "detect_beep"
DETECT_WORDS "detect_words"
GREETING_END "greeting_end"
DISABLED "disabled"

Enum: MediaEncryptionEnum

Name Value
DISABLED "disabled"
SRTP "SRTP"

Enum: SipTransportProtocolEnum

Name Value
UDP "UDP"
TCP "TCP"
TLS "TLS"

Enum: StreamTrackEnum

Name Value
INBOUND_TRACK "inbound_track"
OUTBOUND_TRACK "outbound_track"
BOTH_TRACKS "both_tracks"

Enum: WebhookUrlMethodEnum

Name Value
POST "POST"
GET "GET"

Enum: RecordEnum

Name Value
RECORD_FROM_ANSWER "record-from-answer"

Enum: RecordChannelsEnum

Name Value
SINGLE "single"
DUAL "dual"

Enum: RecordFormatEnum

Name Value
WAV "wav"
MP3 "mp3"

Enum: RecordTrimEnum

Name Value
TRIM_SILENCE "trim-silence"