User Login API

To make a user API request you need to generate the user token. The user token can generated using user id and password, get the user id and password in the TeleCMI dashboard. After getting the user id and password, make a POST request to the below base URL to generate the unique user token.

Base URL

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

https://rest.telecmi.com/v2/user/login

Required Parameters

These are the required POST method parameters with description

Parameter Name	Type	Description
id	string	Your user id
password	string	Your user password

Note

All the above parameters are mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

{
  "id": "103_1111112",
  "password": "abc123"
}

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": "User loged in successfully",
  "token": "xxxx-xxxx-xxxx-xxxx",
  "agent": {
    "category": "inr",
    "id": "103_1111113",
    "inet_no": 1111113,
    "name": "Prasath Sekar"
  }
}

Properties

These are the list of properties and its description

Property	Type	Description
msg	string	Your user id and password is authenticated and logged in sucessfully
token	string	Your user unique token
agent	JSON array	Your user information in detail
category	string	The app type. It can be inr or usd
id	string	Your user id
inet_no	number	Your app id
Name	string	Your user name

Note

Token will automatically expire after 30 days.

HTTP status codes

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

Status code	Status Type	Description
200	OK	We received the request
404	Error	Invalid user id or password, authentication failed