Skip to main content
POST
/
calls
/
{call_control_id}
/
actions
/
siprec_start
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const response = await client.calls.actions.startSiprec('call_control_id');

console.log(response.data);
{
  "data": {
    "result": "ok"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
call_control_id
string
required

Unique identifier and token for controlling the call

Body

application/json

Start siprec session to configured in SIPREC connector SRS.

​
connector_name
string

Name of configured SIPREC connector to be used.

Example:

"my-siprec-connector"

​
sip_transport
enum<string>
default:udp

Specifies SIP transport protocol.

Available options:
udp,
tcp,
tls
Example:

"tcp"

​
siprec_track
enum<string>
default:both_tracks

Specifies which track should be sent on siprec session.

Available options:
inbound_track,
outbound_track,
both_tracks
Example:

"outbound_track"

​
include_metadata_custom_headers
enum<boolean>

When set, custom parameters will be added as metadata (recording.session.ExtensionParameters). Otherwise, they’ll be added to sip headers.

Available options:
true,
false
Example:

true

​
secure
enum<boolean>

Controls whether to encrypt media sent to your SRS using SRTP and TLS. When set you need to configure SRS port in your connector to 5061.

Available options:
true,
false
Example:

true

​
session_timeout_secs
integer
default:1800

Sets Session-Expires header to the INVITE. A reinvite is sent every half the value set. Usefull for session keep alive. Minimum value is 90, set to 0 to disable.

Example:

900

​
client_state
string

Use this field to add state to every subsequent webhook. It must be a valid Base-64 encoded string.

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

Response

Successful response upon making a call control command.

​
data
Call Control Command Result · object
Example:
{ "result": "ok" }