Provide current extension status state with additional information as call channel, destination number, call time, call unique ID and call recording name (if recorded)
API URL:
https:// voiptech.pri /API/CHstatus.php
Example:
https:// voiptech.pri /API/ CHstatus.php?user=XXXX&pass=XXXX&org=XXXX&exten=XXXX
This API allows you to perform the following operations:
- Check extension current state before performing other operation.
Option to send request:
- GET
- POST
Response format (Response parameter must set to yes):
- Text/HTML (default)
- XML
- JSON
Optional parameters:
Demand | Description | Parameter |
Mandatory | User name in the system | user |
Mandatory | User password | pass |
Mandatory | Organization name | org |
Mandatory | Agent/Extension number | exten |
Optional | Request to get action response. Optional parameters: yes |
Response |
Optional | Response format Optional parameters: text,html,xml,json |
RFormat |
No request to specific parameters order
Optional extension state – Idle, InUse, Ringing, Disconnected
Additional information during call (when Response=yes)
Channel –Call channel name and number
BridgedUniqueid – Identifier of the other call bridged to this channel
Uniqueid – Call identifier
Using the call Uniqeid number allow to download the call recording and/or get call CDR report.