Menu

Expand
Rate this page:

SIPREC

Start/Stop SIPREC

The SIPREC API allows you to start a stream on a phone call and send that stream to one of the available partners via the SIPREC connector configuration. You can also stop streams started via the <Siprec> TwiML instruction.

Conceptually, Twilio operates as a Session Recording Client (SRC) for SIPREC. Twilio's partners, e.g. Gridspace operate as Session Recording Server (SRS). Alternately, a customer may provision their 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.

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

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

There are a maximum of 4 forked streams allowed per call. <Siprec> by default uses 2 forked streams for both the inbound and outbound tracks.

Resource Properties in REST API format
sid
sid<SR> Not PII

The SID of the Siprec resource.

account_sid
sid<AC> Not PII

The SID of the Account that created this Siprec resource.

call_sid
sid<CA> Not PII

The SID of the Call the Siprec resource is associated with.

name
string Not PII

The user-specified name of this Siprec, if one was given when the Siprec was created. This may be used to stop the Siprec.

status
enum:status Not PII

The status - one of stopped, in-progress

date_updated
date_time<rfc2822> Not PII

The date and time in GMT that this resource was last updated, specified in RFC 2822 format.

Start SIPREC stream

POST

https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Siprec.json

Parameters
Parameters in REST API format
AccountSid

Path

POST

SID<AC> NOT PII

The SID of the Account that created this Siprec resource.

CallSid

Path

POST SID<CA> NOT PII

The SID of the Call the Siprec resource is associated with.

Name

Optional

POST STRING NOT PII

The user-specified name of this Siprec, if one was given when the Siprec was created. This may be used to stop the Siprec.

ConnectorName

Optional

POST STRING NOT PII

Unique name used when configuring the connector via Marketplace Add-on.

Track

Optional

POST IENUM:TRACK NOT PII

One of inbound_track, outbound_track, both_tracks.

StatusCallback

Optional

POST URL NOT PII

Absolute URL of the status callback.

StatusCallbackMethod

Optional

POST HTTP_METHOD NOT PII

The http method for the status_callback (one of GET, POST).

Parameter1.Name

Optional

POST STRING NOT PII

Parameter name. Up to 99 parameters may be provided in name:value pairs; e.g. Parameter99.Name

Parameter1.Value

Optional

POST STRING NOT PII

Parameter value. Up to 99 parameters may be provided in name:value pairs; e.g. Parameter99.Value

Update a Siprec resource

post
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Siprec/{Sid}.json
Parameters
Parameters in REST API format
account_sid
Path
post sid<AC> Not PII

The SID of the Account that created this Siprec resource.

call_sid
Path
post sid<CA> Not PII

The SID of the Call the Siprec resource is associated with.

sid
Path
post sid_like<SR> Not PII

The SID of the Siprec resource, or the name used when creating the resource

status
Required
post ienum:update_status Not PII

The status. Must have the value stopped

Example 1
        
        
        
        Rate this page:

        Need some help?

        We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Community Forums or browsing the Twilio tag on Stack Overflow.

              
              
              

              Thank you for your feedback!

              We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              Refer us and get $10 in 3 simple steps!

              Step 1

              Get link

              Get a free personal referral link here

              Step 2

              Give $10

              Your user signs up and upgrade using link

              Step 3

              Get $10

              1,250 free SMSes
              OR 1,000 free voice mins
              OR 12,000 chats
              OR more