Call Commands

SIPREC start

Changed on

Start siprec session to configured in SIPREC connector SRS.

Expected Webhooks:

  • siprec.started
  • siprec.stopped
  • siprec.failed
post/calls/{call_control_id}/actions/siprec_start

Request

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

Path parameters

call_control_idstring required

Unique identifier and token for controlling the call

Request body

connector_namestring

Name of configured SIPREC connector to be used.

sip_transport'udp' | 'tcp' | 'tls'

Specifies SIP transport protocol.

siprec_track'inbound_track' | 'outbound_track' | 'both_tracks'

Specifies which track should be sent on siprec session.

include_metadata_custom_headerstrue | false

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

securetrue | false

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.

session_timeout_secsinteger

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.

client_statestring

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

Example request

{
  "connector_name": "my-siprec-connector",
  "siprec_track": "both_tracks",
  "client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d"
}

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