Get Concurrent Call Usage
Each API request in PIOPIY platform includes app id and app secret. Get your App id and secret in PIOPIY dashboard.After getting the app id and secret, make a POST request to the below base URL to retrieve the concurrent channel usage.
Base URL
Send your POST method request with valid parameters, to the following base URL.
https://rest.telecmi.com/v2/piopiy/get_channels
Required Parameters
These are the required POST method parameters with description
Parameter Name | Type | Description |
---|---|---|
*appid | number | Your app ID |
*secret | string | Your app secret |
Note
The * marked parameter is mandatory.
Sample JSON Request
Below is the following sample JSON POST method request
{
"appid": 2222222,
"secret": "xxxx-xxxx-xxx-xxx-xxxx"
}
Sample Response
If the provided information is valid, your web server will get a sample response from TeleCMI Platform as given below
{
"code": 200,
"channel": "2"
}
Properties
These are the list of properties and its description
Property | Type | Description |
---|---|---|
channel | string | Indicates the number of active concurrent calls. |
HTTP status codes
TeleCMI API platform represents the following status code to identity the errors.
Status code | Status Type | Description |
---|---|---|
200 | Success | We received the request |
407 | Error | Authentication failed |