SIP Refer a call

Initiate a SIP Refer on a Call Control call. You can initiate a SIP Refer at any point in the duration of a call.

Expected Webhooks:

• call.refer.started
• call.refer.completed
• call.refer.failed

POST /calls/{call_control_id}/actions/refer

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.calls.actions.refer('call_control_id', {
  sip_address: 'sip:[e-mail]',
});

console.log(response.data);

200

Example

{
  "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

Refer request

sip_address · string · required

The SIP URI to which the call will be referred to.

Example:

"sip:[e-mail]"

client_state · string

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

Example:

"aGF2ZSBhIG5pY2UgZGF5ID1d"

command_id · string

Use this field to avoid execution of duplicate commands. Telnyx will ignore subsequent commands with the same command_id as one that has already been executed.

Example:

"891510ac-f3e4-11e8-af5b-de00688a4901"

custom_headers · Custom SIP Header · object[]

Custom headers to be added to the SIP INVITE.

Show child attributes

Example:

[
  { "name": "head_1", "value": "val_1" },
  { "name": "head_2", "value": "val_2" }
]

sip_auth_username · string

SIP Authentication username used for SIP challenges.

sip_auth_password · string

SIP Authentication password used for SIP challenges.

sip_headers · SIP Header · object[]

SIP headers to be added to the request. Currently only User-to-User header is supported.

Show child attributes

Example:

[
  { "name": "User-to-User", "value": "value" }
]

Response

200

application/json

Successful response upon making a call control command.

data · Call Control Command Result · object

Show child attributes

Example:

{ "result": "ok" }