Call Commands

SIP Refer a call

Changed on

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

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/calls/{call_control_id}/actions/refer
  • Auth: HTTP bearer

Path parameters

call_control_idstring required

Unique identifier and token for controlling the call

Request body

sip_addressstring required

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

client_statestring

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

command_idstring

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.

sip_auth_usernamestring

SIP Authentication username used for SIP challenges.

sip_auth_passwordstring

SIP Authentication password used for SIP challenges.

Example request

{
  "sip_address": "sip:username@sip.non-telnyx-address.com"
}

Response

Successful response upon making a call control command.

Example response

{
  "data": {
    "result": "ok"
  }
}

Changes

  • 1571b0380bd7Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to integer for status

  • 8f5f4e537994Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the / response's property type changed from no type to object for status

    • breaking

      the // response's property type changed from string to integer, and format from integer to int32 for status

    • breaking

      the /// response's property format changed from json-pointer to no format for status