Get Request ID

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 get the request ID details.

Base URL

Send your POST method request with valid parameters, to the following base URL.

Required Parameters

These are the required POST method parameters with description

Parameter NameTypeDescription
*appidnumberYour app ID
*secretstringYour app secret
*request_idstringThe Unique ID for this call
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",
"request_id": "8DI2mXpy2K7qPI2Wi919AKS5LlzNEJKy7kb2Vg3IN9h"

Sample Response

If the provided information is valid, your web server will get a sample response from TeleCMI Platform as given below

"count": 2,
"cdr": [
"duration": 4,
"balance": 1135.14,
"rate": 0.39,
"from": 4471000000,
"to": 9100000000,
"time": 1637069609000,
"leg": "b",
"direction": "outbound",
"status": "answered"
"duration": 10,
"balance": 1134.75,
"rate": 0.39,
"from": 4471000000,
"to": 9200000000,
"time": 1637069609000,
"leg": "a",
"direction": "outbound",
"status": "answered"
"code": 200


These are the list of properties and its description

durationnumberThe total duration of this call in seconds
balancenumberThe total available account balance after this call
ratenumberThe billed call rate for this call
fromnumberYour default DID Number
tonumberThe number the call was made to
timenumberTimestamp of this call
legstringDefine the leg of the call either a or b
directionstringDirection of this call
statusstringStatus of this call

HTTP status codes

TeleCMI API platform represents the following status code to identity the errors.

Status codeStatus TypeDescription
200SuccessWe received the request
404ErrorInvalid app id or secret, authentication failed, Missing parameter