Sessions

List current active call sessions.

get

Get a collection of current active call sessions.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

201

OK

application/json

4XX

Error

get

/sessions

HTTPcURLJavaScriptPython

GET /api/sessions HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

Create call session

post

Create call session

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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.

Possible values:

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.

Possible values:

Responses

201

OK

application/json

4XX

Error

post

/sessions

HTTPcURLJavaScriptPython

POST /api/sessions HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 315

{
  "caller": "text",
  "caller_display_name": "text",
  "callee": "text",
  "send_sdp": true,
  "trunk": "text",
  "rewrite_from": "text",
  "rewrite_pai": "text",
  "rewrite_rpi": "text",
  "user_data": "text",
  "target": "text",
  "target_instance_id": "text",
  "target_extension_number": "text",
  "additional_header": "ANSWER_MODE",
  "header_direction": "CALLER"
}

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}

Retrieve call session by ID.

get

Retrieve details of call sessions by it's ID.

Authorizations

bearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idall ofRequired

The unique ID of session.

stringOptional

The unique ID of the resource.

Example: NzAwNTUxOTA5NzczMTQ4MTYw

Responses

200

OK

application/json

4XX

Error

get

/sessions/{id}

HTTPcURLJavaScriptPython

GET /api/sessions/{id} HTTP/1.1
Host: HOSTNAME:8887
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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