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 Name	Type	Description
token	string	Your 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

Property	Type	Description
callerid	JSON array	The list of available CallerID
pstn	number	The Caller ID
price	number	The incoming call rate for Caller ID
capacity	number	The capacity for incoming and outgoing call
profile	string	The profile code for unlimited plan

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
404	Error	Invalid user token, Failed to authenticate token
400	Error	Parameter missing