Allow remote dialing by sending request via URL get/post. This service Allow 3rd party applications to manage the telephony services as part of their services.
There are some parameters that are mandatory and some are optional.
The system will first dial to destination #1, internal extension or external number (dial1 parameter) and after Answer the system will dial to destination #2, internal extension to external number (dial2 parameter)
API URL:
https://voiptech.pri/API/dialup.php
Example:
https:// voiptech /API/dialup.php?user=XXXX&pass=XXXX&org=XXXX&dial1=XXXX&
dial2=XXXX
This API allows you to perform the following operations:
- Simple dial to specific destination as the first dial configured in dial1 parameter will start ringing and upon answer a new call will start to the destination configured in dial2 parameter.
- Dialing to number/destination allowed for:
- Internal extension
- Ring group/Queue/IVR/Message/shortcut Apps/Other destination
- External number (E164 format)
- Dialing to one or multiple phone numbers destination and connect them to a specific message to play to all or announcement with an option to press a key or to Queue that manage free agents.
- Configuring the CID (caller ID) number that will be displayed to the internal agent and the external phone.
- Getting immediate pass/fail response to the first operation stage.
If set dial1 to local extension and dial2 to external number then the response status will be ok when the extension will answer the call or Fail when no answer (No answer/Busy/Not connected/Unreachable)
Option to send request:
- GET
- POST
Response format (Response parameter must set to yes):
- Text/HTML
- XML
- JSON
Optional Parameters
| Demand | Description | Parameter |
| Mandatory | User name in the system | user |
| Mandatory | User password | pass |
| Mandatory
(mandatory also for future call) |
Organization name | org |
| Mandatory
(mandatory also for future call) |
First dialing order | dial1 |
| Mandatory
(mandatory also for future call) |
Second dialing (only after 1st answer) | dial2 |
| Optional | Request to get action response. Optional parameters: yes |
Response |
| Optional (If set to yes, Response also must be set to yes) |
Request to get both legs Call UniqueID (dial1 & dial2) Optional parameter: yes |
showUID |
| Optional | Response format Optional parameters: text,html,xml,json |
RFormat |
| Optional | Set the CID number Optional parameters: any E164 format (national/international) |
SetCID |
| Optional | 1st dial timeout Optional parameters: 1-300 Seconds If not set the default is 20 seconds. |
Timeout |
| Mandatory for future call | Set time for future call in a format of YYYYMMDDhhmm | Date |
| Mandatory for future call | Define numbers of retries till answer | Maxretry |
| Mandatory for future call |
Set time between retries |
Retrytime |
| Mandatory for future call | Unique organization identification | ident |
No request for specific parameters order
Dialing options and results:
| Call Recording | Description | Param – dial2 / number | Param – dial1 / ext |
| Don't set "setCID" parameter. Any number that is not the agent number will not be recorded | Call local agent and after answer dial to external number | External number | Internal number |
| Call external number and after answer dial to local agent | Internal number | External number | |
| Call local agent and after answer dial to other local agent | Internal number | Internal number | |
| setCID must be defined as the local agent extension. The first number will get a call with a CID set to his extension and the 2nd number will get a call with a CID defined for the agent number. |
Call external number and after answer dial to next external number | External number | External number |
