Agent Login API

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

Base URL

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

https://piopiy.telecmi.com/v1/agentLogin

Required Parameters

These are the required POST method parameters with description

Parameter Name	Type	Description
*id	string	Your agent id
*password	string	Your agent password

Note

The * marked parameter is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

{
  "id": "103_1111113",
  "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": "Agent loged in successfully",
  "token": "xxxx-xxxx-xxxx-xxxx",
  "agent": {
    "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 agent id and password is authenticated and logged in sucessfully
token	string	Your agent unique token
agent	JSON array	Your agent information in detail
id	string	Your agent id
inet_no	number	Your app id
Name	string	Your agent 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 code	Description
200	OK	We received the request
404	Error	Invalid agent id or password, authentication failed