SparkTG

User Details Documentation

User Details

v1.0Moving to v2

This API is moving to v2

All SparkTG APIs are moving to API v2, with signed API tokens instead of a username and password. This one will follow soon; until then, use it on v1 as documented here.

Moving to API v2

User Details

Get User Profile & Account Information

Userv1.01 Endpoint

Overview

The /user API retrieves details of the authenticated user, including profile info, account status, and login credentials (hashed)

Available Endpoints

POST/user

Key Parameters

id(Integer)

Unique identifier of the user

name(String)

Display name of the user (e.g., Agent name)

password(String)

User’s password in hashed format (not plain text)

email(String)

Registered email of the user (may be empty)

number(String)

Registered phone number of the user (may be empty)

active(Boolean)

Indicates if the user account is active

Quick Example

Try this API with a simple cURL command

Basic API Call
curl -i -u "username:password" "https://telephonycloud.co.in/api/v1/user"
💡 Replace username:password with your actual credentials

Response Preview

Sample response from this API

Sample Response
{
  "id": 1,
  "name": "AgentN",
  "password": "21232f297a57a5a743894a0e4a801fc3",
  "email": "",
  "number": "",
  "active": true,
  "username": "1",
  "verified": true,
  "login_id": "test"
}...
View complete response format in Response section