Nouns

<Sip>

Dial a SIP URI directly, or name the transfer target of a <Refer>.

Used inside<Dial>, <Refer>.

Element body

The SIP URI, e.g. sip:agent@pbx.example.com.

Example

<Response>
  <Dial>
    <Sip username="agent1" password="s3cret">sip:agent@pbx.example.com?X-Tenant=acme</Sip>
  </Dial>
</Response>

Attributes

Attribute Default Behaviour
username unset SIP digest-auth username for the far end.
password unset SIP digest-auth password for the far end.
sendDigits unset Touch-tone digits sent after answer (same as <Number>).
url unset VoiceML screening prompt run on the dialled leg before the bridge (same as <Number>).
method POST HTTP method for the screening-URL fetch.
statusCallback unset Per-leg lifecycle webhook URL: the dialled leg's own lifecycle events are posted here as it progresses, carrying the leg's CallSid, its ParentCallSid, and Direction outbound-dial.
statusCallbackMethod POST HTTP method for the per-leg webhook.
statusCallbackEvent completed Space-separated list of leg lifecycle events to deliver: initiated, ringing, answered, completed. Omit to receive completed only.
machineDetection unset Answering-machine detection on the dialled leg (same as <Number>).
machineDetectionTimeout 30 Seconds the detector listens before giving up.
machineDetectionSpeechThreshold 2400 Milliseconds of continuous speech that tip the classification toward machine.
machineDetectionSpeechEndThreshold 1200 Milliseconds of silence after speech that mark the end of the greeting.
machineDetectionSilenceTimeout 5000 Milliseconds of initial silence before the detector times out.
amdStatusCallback unset URL that receives the detection result: AccountSid, CallSid, AnsweredBy, and MachineDetectionDuration.
amdStatusCallbackMethod POST HTTP method for the detection-result callback.

Nesting

<Sip> accepts these nested elements:

Notes

  • The SIP leg is dialled directly — no carrier hop.
  • Custom SIP headers can be added two ways: ?Name=value query parameters on the URI (percent-decoded) and nested <Header name value/> children. Header names must be RFC 7230 tokens; values must not contain CR/LF, ], }, |, or ^^.
  • On multi-target dials, per-target credentials, headers, and screening URLs are rejected — put them on single-target dials.