<Sip>

The <Sip> element is nested within the <Dial> element, and is used to call to Sip addresses. The desired Sip address to call is nested within the opening and closing <Sip> elements, just as with a number when using the <Number> element. The opening and closing Sip tags is mandatory prefixing the desired Sip address with "sip:" when using it within the <Sip> element like so:

<Dial>
  <Sip>sip:[email protected]</Sip>
</Dial>

📘
Note
A <Sip> element must be placed inside of a <Dial> element.

Element Attributes

Attribute	Description
`action`optional	URL where some parameters specific to `<Dial>` will be sent for further processing. The calling party can be redirected here upon the hangup of the B leg caller.
`method`optional	Method used to request the action URL. Valid values: POST, GET Default value: POST
`timeout`optional	Number of seconds call stays on the line while waiting for an answer. Default value: 60
`timeLimit`optional	Duration in seconds a call made through `<Sip>` should last before ending. Valid values: integer greater than or equal to 1. Default value: 14400
`callerId`optional	Number to display as calling. Defaults to the ID of the phone being used.
`dialMusic`optional	Audio URL to be executed in place of the call ring-tone. Valid value: .mp3, .wav
`callbackUrl`optional	URL requested once the dialed call connects. Note that this URL only receives parameters containing information about the call. The call does not execute XML given as a callbackURL.
`callbackMethod`optional	Method used to request the callback URL. Valid value: POST, GET Default value: POST
`heartbeatUrl`optional	The URL that Ytel API requests every 60 seconds during the call to notify of elapsed time as well as to pass other general information.
`heartbeatMethod`optional	Method used to request the heartbeatUrl. Valid value: POST, GET Default value: POST

Nesting

In addition to the default <Response> element, the <Sip> element must also be nested within the <Dial> verb.

📘
Note
The <Sip> element cannot nest any other elements within itself. It must only nest the sip address which is to be called.

number          : mandatory
@               : mandatory
domain_name     : mandatory
port            : optional

<Response>
  <Dial action="https://customapps.ytel.com/m360/examples/welcome/index.php" method="post" callerid="+1949XXXXXXX" dialmusic="https://xyz.com/ring.mp3" callbackmethod="post" heartbeatUrl="https://customapps.message360.com/m360/examples/welcome/index.php" heartbeatMethod="POST" callbackurl="https://customapps.message360.com/m360/examples/welcome/index.php">
    <Sip>sip:[email protected]</Sip>
  </Dial>
</Response>