Skip to main content

User CallerID List

Each user API request in TeleCMI platform includes user login token. After getting the user login token, make a POST request to the below base URL to get the list of available callerID's.

Base URL

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

https://rest.telecmi.com/v2/get_callerid

Required Parameters

These are the required POST method parameters with description

Parameter NameTypeDescription
tokenstringYour user token
Note
All the above parameters are mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

{
"token": "xxxx-xxxx-xxxx-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,
"callerid": [
{
"pstn": 19170000000,
"price": 0,
"capacity": 6,
"profile": "1003"
},
{
"pstn": 550000000000,
"price": 0.01,
"capacity": 6,
"profile": "0"
},
{
"pstn": 61000000000,
"price": 0.01,
"capacity": 6,
"profile": "0"
},
{
"pstn": 6500000000,
"price": 0.01,
"capacity": 6,
"profile": "0"
},
{
"pstn": 440000000000,
"price": 0.01,
"capacity": 6,
"profile": "0"
}
]
}

Properties

These are the list of properties and its description

PropertyTypeDescription
calleridJSON arrayThe list of available CallerID
pstnnumberThe Caller ID
pricenumberThe incoming call rate for Caller ID
capacitynumberThe capacity for incoming and outgoing call
profilestringThe profile code for unlimited plan

HTTP status codes

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

Status codeStatus TypeDescription
200SuccessWe received the request
404ErrorInvalid user token, Failed to authenticate token
400ErrorParameter missing