Make a Call

You can initiate multiple types of calls through the interface.

The API interface allows you to initiate calls in the following types:
  • Extension as caller:

    The callee can be: extension number, IVR number, Ring Group number, Queue number, external number, Paging group number, and Conference number.

  • IVR as caller: The callee should be an external number.
  • Ring Group as caller: The callee should be an external number.
  • Queue as caller: The callee should be an external number.
  • External number as caller: The callee should be an external number.

Request URL

{base_url}/{api_path}/call/dial?token={token}

Request parameters

Parameter Required Type Description
caller Yes Integer The caller number.
callee Yes Integer The callee number.
Note: If the callee is an external number, the number must match outbound route rules.
dialpermission No String Use which extension's call permission to dial out an external number.
Note:
  • If the caller is an extension number, dialpermission is not required. You can dial out the external number with extension permission directly.
  • If the caller is not an extension number (e.g. a Ring Group number or a Queue number), dialpermission must be the extension which is of outbound call permission.
autoanswer No String If caller is an extension number, you can decide whether to auto answer the call to callee.
Note: This feature requires the SIP phone to support.
Valid values:
  • yes
  • no

Default value: no

Response parameters

Parameter Type Description
status String Request result.
  • Success
  • Failed
callid String The unique ID of each call.

Examples

Request example

Extension 1023 calls extension 2000.

POST /api/v2.0.0/call/dial?token=55e169f41421df602d41a08c441bc948 HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
	"caller": "1023",
	"callee": "2000",
	"autoanswer": "no"
}

Response example 

HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
	"status": "Success",
	"callid": "1571620483.18"
}