Directly

Create call session directly

get

Create call session directly.

Query parameters

extension_numberstring · min: 3 · max: 64required

The extension number.

Pattern: [0-9]{3,64}

passwordstringrequired

The extension password.

domainstring · min: 1 · max: 280required

The SIP domain of tenant.
It is usually a fully qualified domain name (FQDN). If there is no FQDN, you can also use the IP address of the PBX server as the SIP domain. The SIP domain name is only used for SIP message authentication and does not require analysis.

callerstring · max: 256required

The caller number of the call.

caller_display_namestring · max: 1024optional

The caller display name of the call.

calleestring · max: 256required

The callee number of the call.

send_sdpbooleanrequired

Whether to send sdp packets.

trunkstring · min: 1 · max: 64optional

The name of the trunk.

rewrite_fromstring · min: 1 · max: 16optional

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

rewrite_paistring · min: 1 · max: 16optional

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

rewrite_rpistring · min: 1 · max: 16optional

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

user_datastring · max: 128optional

The user context of the call.

targetstring · max: 128optional

The target address.

target_instance_idstring · max: 128optional

The target instance ID.

target_extension_numberstring · max: 128optional

The target extension number.

additional_headerstring · enumoptional

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.

Options: ANSWER_MODE, CALL_INFO, ALERT_INFO_AUTO_ANSWER_DELAY0, ALERT_INFO_AUTO_ANSWER, ALERT_INFO_INTERCOM

header_directionstring · enumoptional

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.

Options: CALLER, CALLEE, ALL

Responses

application/json

cURL

JavaScript

Python

HTTP

201

4XX

PreviousSessions NextHold

Was this helpful?