On this page

TwiML™️ Voice: <Siprec>

The <Siprec> TwiML instruction allows you to start a stream on a phone call and send that stream to one of the available partners via the configured SIPREC Connector.

Twilio operates as a Session Recording Client (SRC) for SIPREC and Twilio's partners, e.g. Gridspace, operate as Session Recording Server (SRS)

Alternately, you may provision your own SRS via configuration in the Twilio/Generic SIPREC Connector.

The SRC sends the SIPREC media to be recorded to the SRS. The SRS is responsible for storing/processing the media.

The most basic use of <Siprec>:

1<?xml version="1.0" encoding="UTF-8"?>
2<Response>
3   <Start>
4       <Siprec connectorName="my_addon_connector" />
5   </Start>
6</Response>

This TwiML will instruct Twilio to fork the audio stream of the current call and send it in real-time to the configured connector. DTMF will not be sent to the connector.

<Siprec> starts the audio stream asynchronously and immediately continues with the next TwiML instruction. If there is no instruction, the call will be disconnected. In order to avoid this, provide a TwiML instruction to continue the call.

(information)

Info

Connectors are configured via the Marketplace Add-on in the Twilio Stream Connectors Console page. Connectors cannot be configured outside of Console. This requirement is in place to ensure that the credentials needed to send the stream to a partner are stored securely.

(warning)

Warning

You can control which Twilio edge your SIPREC connections egress by appending an edge parameter to the Session Recording Server address in the SIPREC Connector Configuration.
For example, sip:srs@foo.com:5060;edge=dublin would egress from the Dublin edge, and sip:srs@foo.com:5060;edge=umatilla would egress from Oregon.

(information)

Info

Any communication issues encountered while streaming media to the partner will be reported in the Twilio Debugger with additional information about the failure.

(warning)

Warning

There are a maximum of four forked streams allowed per call. <Siprec> by default uses two forked streams; one each for the inbound and outbound tracks.

Attributes

<Siprec> supports the following attributes:

Attribute Name	Allowed Values	Default Value
name	Optional. Unique name for the Stream	none
connectorName	Unique name used when configuring the connector via Marketplace Add-on.	Default
track	Optional. `inbound_track`, `outbound_track`, `both_tracks`	`both_tracks`

name

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>

connectorName

The connectorName attribute must contain a unique name corresponding to the SIPREC Stream Connector installed via Twilio Stream Connectors console page.

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 the appropriate SIPREC connector via Console.

(information)

Info

The Twilio SIPREC Connector provides some additional SIP features.

You can configure these in your Connector instance. The SIP URI supports additional parameters, secure which enables Secure Real-time Transport Protocol (SRTP), as well as, edge which allows you to specify a specific edge location.

For instance, to enable SRTP and set the edge location to the ashburn edge, you would provide a similar SIP URI:

sip:your-domain.com;secure=true&edge=ashburn

(information)

Info

If you'd like to use a specific partner and do not find them in the available Stream Connectors list, please contact Twilio Support directly with details about your desired partner through the Console or Help Center to submit a ticket.

track

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 later 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.

Passing Custom Parameters

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, so please refer to the appropriate partner tile in the Stream Connectors page to identify the custom parameters that need to be passed.

Examples

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

Start a new SIPREC Stream

1const VoiceResponse = require('twilio').twiml.VoiceResponse;
2
3const response = new VoiceResponse();
4const start = response.start();
5start.siprec({
6    name: 'My SIPREC Stream',
7    connectorName: 'Gridspace_1'
8});
9
10console.log(response.toString());

Output

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>

IP Ranges to Allow

To receive SIPREC streams from Twilio, please ensure to include the following regions in your allow list (IP address whitelist).

North America Virginia Gateways

Signaling IPs:

1    54.172.60.0/30 which translates to:
2    54.172.60.0
3    54.172.60.1
4    54.172.60.2
5    54.172.60.3
6    Ports: 5060 (UDP/TCP), 5061 (TLS)
7

Media IPs:

1    54.172.60.0/23
2    34.203.250.0/23 
3    Port Range: 10,000 to 20,000 (UDP)
4

North America Oregon Gateways

Signaling IPs:

1    54.244.51.0/30 which translates to:
2    54.244.51.0
3    54.244.51.1
4    54.244.51.2
5    54.244.51.3
6    Ports: 5060 (UDP/TCP), 5061 (TLS)
7

Media IPs:

1    54.244.51.0/24
2    Port Range: 10,000 to 20,000 (UDP)
3

Europe Ireland Gateways

Signaling IPs:

1    54.171.127.192/30 which translates to:
2    54.171.127.192
3    54.171.127.193
4    54.171.127.194
5    54.171.127.195
6    Ports: 5060 (UDP/TCP), 5061 (TLS)
7

Media IPs:

1    54.171.127.192/26
2    52.215.127.0/24
3    Port Range: 10,000 to 20,000 (UDP) 
4

Europe Frankfurt Gateways

Signaling IPs:

1    35.156.191.128/30 which translates to:
2    35.156.191.128
3    35.156.191.129
4    35.156.191.130
5    35.156.191.131
6    Ports: 5060 (UDP/TCP), 5061 (TLS)
7

Media IPs:

1    35.156.191.128/25 
2    3.122.181.0/24
3    Port Range: 10,000 to 20,000 (UDP) 
4

Asia-Pacific Tokyo Gateways

Signaling IPs:

1    54.65.63.192/30 which translates to:
2    54.65.63.192
3    54.65.63.193
4    54.65.63.194
5    54.65.63.195
6    Ports: 5060 (UDP/TCP), 5061 (TLS)
7

Media IPs:

1    54.65.63.192/26
2    3.112.80.0/24
3    Port Range: 10,000 to 20,000 (UDP)
4

Asia-Pacific Singapore Gateways

Signaling IPs:

1    54.169.127.128/30 which translates to:
2    54.169.127.128
3    54.169.127.129
4    54.169.127.130
5    54.169.127.131
6    Ports: 5060 (UDP/TCP), 5061 (TLS)
7

Media IPs:

1    54.169.127.128/26
2    3.1.77.0/24
3    Port Range: 10,000 to 20,000 (UDP)
4

Asia-Pacific Sydney Gateways

Signaling IPs:

1    54.252.254.64/30 which translates to:
2    54.252.254.64
3    54.252.254.65
4    54.252.254.66
5    54.252.254.67
6    Ports: 5060 (UDP/TCP), 5061 (TLS)
7

Media IPs:

1    54.252.254.64/26
2    3.104.90.0/24
3    Port Range: 10,000 to 20,000 (UDP)
4

South America São Paulo Gateways

Signaling IPs:

1    177.71.206.192/30 which translates to: 
2    177.71.206.192
3    177.71.206.193
4    177.71.206.194
5    177.71.206.195
6    Ports: 5060 (UDP/TCP), 5061 (TLS)
7

Media IPs:

1    177.71.206.192/26
2    18.228.249.0/24
3    Port Range: 10,000 to 20,000 (UDP)
4