Sessions

PreviousCall queue blacklist prompts NextDirectly

Was this helpful?

List current active call sessions.

Get a collection of current active call sessions.

get

/sessions

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/sessions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

201

4XX

{
  "count": 100,
  "items": [
    {
      "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
      "calls": [
        {
          "caller": "text",
          "caller_display_name": "text",
          "callee": "text",
          "trunk": "text",
          "talking_time": 1,
          "started_at": "2017-07-21T17:32:28Z"
        }
      ]
    }
  ]
}

Create call session

post

/sessions

Authorizations

Body

callerstring · max: 256required

The caller number of the call.

caller_display_namestring · max: 1024

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: 64

The name of the trunk.

rewrite_fromstring · min: 1 · max: 16

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

rewrite_paistring · min: 1 · max: 16

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: 16

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

user_datastring · max: 128

The user context of the call.

targetstring · max: 128

The target address.

target_instance_idstring · max: 128

The target instance ID.

target_extension_numberstring · max: 128

The target extension number.

additional_headerstring · enum

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 · enum

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

curl -L \
  --request POST \
  --url 'https://HOSTNAME:8887/api/sessions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"caller":"text","callee":"text","send_sdp":true,"additional_header":"ANSWER_MODE","header_direction":"CALLER"}'

201

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve call session by ID.

Retrieve details of call sessions by it's ID.

get

/sessions/{id}

Authorizations

Path parameters

idall ofrequired

The unique ID of session.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://HOSTNAME:8887/api/sessions/{id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw",
  "calls": [
    {
      "caller": "text",
      "caller_display_name": "text",
      "callee": "text",
      "trunk": "text",
      "talking_time": 1,
      "started_at": "2017-07-21T17:32:28Z"
    }
  ]
}