Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 5.56 KB

TransferCallRequest.md

File metadata and controls

74 lines (50 loc) · 5.56 KB

TransferCallRequest

Properties

Name Type Description Notes
to String The DID or SIP URI to dial out to.
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. This attribute will default to the `to` number of the original call if omitted. [optional]
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]
audioUrl String The URL of a file to be played back when the transfer destination answers before bridging the call. 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 when the transfer destination answers before bridging the call. 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]
timeoutSecs Integer The number of seconds that Telnyx will wait for the call to be answered by the destination to which it is being transferred. 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. 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]
clientState String Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string. [optional]
targetLegClientState String Use this field to add state to every subsequent webhook for the new leg. It must be a valid Base-64 encoded string. [optional]
commandId String Use this field to avoid duplicate commands. Telnyx will ignore any command with the same `command_id` for the same `call_control_id`. [optional]
mediaEncryption MediaEncryptionEnum Defines whether media should be encrypted on the new call leg. [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. 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]
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]

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: WebhookUrlMethodEnum

Name Value
POST "POST"
GET "GET"