Get Break

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 remaining break hours for the user.

Base URL

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

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

Required Parameters

These are the required POST method parameters with description

Parameter Name	Type	Description
*token	string	Your user token
from_date	number	The timestamp of start date and time in UTC timezone. By default the timestamp will be last 24 hours from current time.
end_date	number	The timestamp of end date and time in UTC timezone. By default the timestamp will be current time.

Note

The * marked parameter is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

{
    "token": "xxxx-xxxx-xxxx-xxxx",
    "from_date" : 1654079796000,
    "end_date" : 1655980596000
}

Sample Response

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

{
    "code": 200,
    "break_sec": "00:35:00"
}

Properties

These are the list of properties and its description

Property	Type	Description
break_sec	string	The available break time in HH:MM:SS

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