TwiML™️ Voice: <Siprec>

Connectors are configured in Marketplace to ensure that the credentials needed to send the stream to a partner are stored securely. You can install and manage connectors in the Stream Connectors Console page in Marketplace or via the Marketplace API using the InstalledAddOns Resource.

Configure your SIPREC Connector using the parameters below.

If you use Twilio's SIPREC Connector, the SIP URI within the Session Recording Server parameter supports the following optional parameters:

• secure: Enables Secure Real-time Transport Protocol (SRTP).
• edge: Specifies which Twilio edge your SIPREC connections will egress from.

For example, to enable SRTP and set the edge location to the ashburn edge, you can set Session Recording Server to sip:example.com;secure=true&edge=ashburn.

<Siprec> supports the following attributes:

Providing a name will allow you to reference the SIPREC stream directly. This name must be unique per Call SID.

For instance by naming the Stream my_first_siprec_stream:

1
<Start>
2
    <Siprec name="my_first_siprec_stream" connectorName="my_addon_connector" />
3
</Start>

You can later use the unique name of my_first_siprec_stream to stop the stream.

1
<Stop>
2
   <Siprec name="my_first_siprec_stream" />
3
</Stop>

The connectorName attribute must contain a unique name corresponding to the SIPREC Stream Connector installed in your Twilio Marketplace Account in the Twilio Console. Learn more in the Configuring a SIPREC Connector section.

For example, to use Gridspace Connector, use connectorName="Gridspace_1", where Gridspace_1 is the unique name specified when configuring Gridspace Connector in the Stream Connectors page. In order to start a SIPREC session, you must first configure a SIPREC Connector.

The track attribute allows you to optionally request to receive a specific track of a call. On any given active call within Twilio there are inbound and outbound tracks, the former represents the audio Twilio receives from the call, and the latter represents the audio generated by Twilio to the call. By default Twilio always streams the inbound track of a call. To request Twilio to stream audio it generates use outbound_track, or to receive both tracks of a call use both_tracks. If both_tracks is used, you will receive both the inbound and outbound media event.

SIPREC is a protocol that enables recording and sending streams to one of the available partners via the SIPREC connector configuration. With a status callback, you can monitor SIPREC session statuses to quickly detect and troubleshoot issues like failures or interruptions. You can subscribe to status callbacks by adding the statusCallback and statusCallbackMethod as attributes.

1
<Start>
2
<Siprec name="my-first-siprec" connectorName="Gridspace_1" statusCallback="https://87b252436d40.ngrok.app" statusCallbackMethod="GET"/>
3
</Start>

The request to the status callback contains the standard TwiML request parameters and the following parameters:

If an error occurs, additional parameters SiprecError and SiprecErrorCode will provide details about the issue with the SIPREC resource.

SIPREC partners often require additional metadata along with the audio stream. You can provide custom data by using <Parameter>

1
<Start>
2
    <Siprec name="my_stream_1" connectorName="Gridspace_1" track="outbound_track">
3
        <Parameter name="Custom1" value ="Bob" />
4
        <Parameter name="Custom2" value ="Blah" />
5
        <Parameter name="Custom3" value ="Alice" /> 
6
     </Siprec>
7
</Start>

The exact names of parameters vary from partner to partner. Refer to the appropriate partner tile in the Stream Connectors page to identify the custom parameters that need to be passed.

Start a new SIPREC stream with the name of My SIPREC Stream and a connector of Gridspace_1.

1
const VoiceResponse = require('twilio').twiml.VoiceResponse;
2

3
const response = new VoiceResponse();
4
const start = response.start();
5
start.siprec({
6
    name: 'My SIPREC Stream',
7
    connectorName: 'Gridspace_1'
8
});
9

10
console.log(response.toString());

1
<?xml version="1.0" encoding="UTF-8"?>
2
<Response>
3
    <Start>
4
        <Siprec name="My SIPREC Stream" connectorName="Gridspace_1" />
5
    </Start>
6
</Response>

Public Connections - Global Media IP Range

The Public Connections Destination IP Ranges and Port Ranges are now identical across all locations:

† The SDK will select any available port from the ephemeral range. On most machines, this means the port range 1,024 to 65,535.

To receive SIPREC streams from Twilio, you must allow ALL of Twilio's following IP address ranges and ports on your firewall for signaling traffic. Twilio doesn't guarantee which edge location the media will egress from, without using the edge parameter since it can depend on which PSTN-SIP Gateway delivers the call to which Twilio edge location.