5.7.2 api call dial

The /api/call/dial function helps you initiate a new outgoing call to a selected phone number or sip uri using the number parameter or one or more users using the users parameter. The command may include just one of the mentioned parameters, otherwise it will be returned with an error reponse.

The function is part of the Phone/Call service and the user must be assigned the Phone/Call Control privilege for authentication if required.

The /api/call/dial function allows you to initiate a new outgoing call to a selected phone number or sip uri using the number parameter, or to one or more users using the users parameter. The command may contain just one of the listed parameters, otherwise an error message is returned.

The GET or POST method can be used for this function.

Request parameters:

Parameter

Description

number

Mandatory parameter specifying the destination phone number or sip uri

users

List of comma-separated user uuids (unique IDs).

The reply is in the application/json format and includes information on the outgoing call created.

Parameter

Description

session

Call identifier, used, for example, for call monitoring with /api/call/status or call termination with /api/call/hangup

Example:

GET /api/call/dial?number=sip:1234@10.0.23.194
{
  "success" : true,
  "result" : {
    "session" : 2
  }
}