Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

Call Session

Create call session

Create call session

post/sessions

Request body

callerstring required

The caller number of the call.

caller_display_namestring

The caller display name of the call.

calleestring required

The callee number of the call.

send_sdpboolean required

Whether to send sdp packets.

trunkstring

The name of the trunk.

rewrite_fromstring

When call through the trunk specified by trunk,
change the user part in the FROM header to specified value.

rewrite_paistring

When call through the trunk specified by trunk,
change the user part in the P-Asserted-Identity header to specified value.

rewrite_rpistring

When call through the trunk specified by trunk,
change the user part in the Remote-Party-ID header to specified value.

user_datastring

The user context of the call.

targetstring

The target address.

target_instance_idstring

The target instance ID.

target_extension_numberstring

The target extension number.

additional_header'ANSWER_MODE' | 'CALL_INFO' | 'ALERT_INFO_AUTO_ANSWER_DELAY0' | 'ALERT_INFO_AUTO_ANSWER' | 'ALERT_INFO_INTERCOM'

Specifies whether to add an additional SIP header (RFC 5373) to the INVITE SIP message. The possible values are:

  • ANSWER_MODE: Adds the Answer-Mode header to the INVITE SIP message.
  • CALL_INFO: Adds the Call-Info header with answer-after=0 to the INVITE SIP message.
  • ALERT_INFO_AUTO_ANSWER_DELAY0: Adds the Alert-Info header with info=alert-autoanswer;delay=0 to the INVITE SIP message.
  • ALERT_INFO_AUTO_ANSWER: Adds the Alert-Info header with info=Auto Answer to the INVITE SIP message.
  • ALERT_INFO_INTERCOM: Adds the Alert-Info header with info=intercom to the INVITE SIP message.
header_direction'CALLER' | 'CALLEE' | 'ALL'

Specifies which party of the call should receive the additional_header, if the additional_header is not specified, this parameter will be ignored. The possible values are:

  • CALLER: Adds the specified header in additional_header to the INVITE SIP message sent to the caller.
  • CALLEE: Adds the specified header in additional_header to the INVITE SIP message sent to the callee.
  • ALL: Adds the specified header in additional_header to the INVITE SIP messages sent to both the caller and callee.

Response

OK

idstring

The unique ID of the resource.

Example response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}