SparkTG

Agent Login Logout Documentation

Agent Login Logout

v1.0

Agent Login Logout

Manage agent status and availability

Agent Managementv1.01 Endpoint

Overview

PATCH /agents - Control agent login/logout status

Authentication

Basic Authentication

Methods

PATCH

Parameters

3 Parameters

Response

JSON Format

Available Endpoints

PATCH/agents

Key Parameters

status(Integer)

Status number resembles which type of status is desired. See table Status below

break(Integer)

Break id resembles that which type of break is taken against the status. See table Break below

agent-number(String)

Number of the agent of which status to be updated, useful in case of admin credentials, can change status of agent via agent's number

Quick Example

Try this API with a simple cURL command

Basic API Call
curl -X PATCH -u "username:password" https://telephonycloud.co.in/api/v1/agents?status=0
💡 Replace username:password with your actual credentials

Response Preview

Sample response from this API

Sample Response
{"break":-1,"status":0}
View complete response format in Response section