Skip to main content
POST
/
texml
/
Accounts
/
{account_sid}
/
Calls
/
{call_sid}
/
Siprec
/
{siprec_sid}
.json
JavaScript
import Telnyx from 'telnyx';

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

const response = await client.texml.accounts.calls.siprec.siprecSidJson('siprec_sid', {
  account_sid: 'account_sid',
  call_sid: 'call_sid',
});

console.log(response.account_sid);
{
  "account_sid": "61bf923e-5e4d-4595-a110-56190ea18a1b",
  "call_sid": "v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ",
  "sid": "61bf923e-5e4d-4595-a110-56190ea18123",
  "date_updated": "Fri, 11 Aug 2023 19:12:11 +0000",
  "status": "in-progress",
  "uri": "https://api.telnyx.com/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18123/Calls/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-ai/Siprec/61bf923e-5e4d-4595-a110-56190ea18123",
  "error_code": null
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
account_sid
string
required

The id of the account the resource belongs to.

​
call_sid
string
required

The CallSid that identifies the call to update.

​
siprec_sid
string
required

The SiprecSid that uniquely identifies the Sip Recording.

Body

application/x-www-form-urlencoded

Updates a SIPREC session.

​
Status
enum<string>

The new status of the resource. Specifying stopped will end the siprec session.

Available options:
stopped
Example:

"stopped"

Response

Successful SIPREC session update response

​
account_sid
string

The id of the account the resource belongs to.

Example:

"61bf923e-5e4d-4595-a110-56190ea18a1b"

​
call_sid
string

The id of the call the resource belongs to.

Example:

"v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-aiQ"

​
sid
string

The SID of the siprec session.

Example:

"61bf923e-5e4d-4595-a110-56190ea18123"

​
date_updated
string

The date and time the siprec session was last updated.

Example:

"Fri, 11 Aug 2023 19:12:11 +0000"

​
status
enum<string>

The status of the siprec session.

Available options:
in-progress,
stopped
Example:

"in-progress"

​
uri
string

The URI of the siprec session.

Example:

"https://api.telnyx.com/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18123/Calls/v3:9X2vxPDFY2RHSJ1EdMS0RHRksMTg7ldNxdjWbVr9zBjbGjGsSe-ai/Siprec/61bf923e-5e4d-4595-a110-56190ea18123"

​
error_code
string

The error code of the siprec session.

Example:

null