User CallerID Update

Each API request in TeleCMI platform includes App id and secret. Get your App id and secret in TeleCMI dashboard. After getting the app id and secret, make a POST request to the below base URL to update the callerID for user.

Base URL

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

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

Required Parameters

These are the required POST method parameters with description

Parameter Name	Type	Description
token	string	Your user token
callerid	string	The CallerID of the user

Note

All the above parameters are mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

{
  "token": "xxxx-xxxx-xxxx-xxxx",
  "callerid": 440000000000
}

Sample Response

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

{
    "code": 200,
    "msg": "caller ID updated successfully",
    "callerid": 440000000000
}

Properties

These are the list of properties and its description

Property	Type	Description
msg	string	Caller ID updated to the user
callerid	number	The updated caller ID number

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, caller ID updated successfully
404	Error	Invalid user token, Failed to authenticate token
400	Error	Parameter missing
501	Error	Not implemented