users
- 16 Oct 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
users
- Updated on 16 Oct 2024
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v3/cdr/users
Returns a list of all agent names and IDs based on your API key and user API key.
Header parameters
Content-Type
Required
Valid values[ "application/json" ]
Query parameters
Exampleuser_api_key
id
integer
Example28982
name
string
ExampleAG D
email
string
Exampleag@g.com
sip_account
string
Exampleag@cc1.email.net
sag
string
ExampleAgent
extension
string
Example2594
caller_id
string
Example378
timezone
string
ExampleIstanbul
Responses
200
Success
example1
Agents parameters
All of the user data
{
"id": 28982,
"name": "AG D",
"email": "ag@g.com",
"sip_account": "ag@cc1.email.net",
"sag": "Agent",
"extension": "2594",
"caller_id": "378",
"timezone": "Istanbul",
"webrtc_ringtone": "null,",
"agent_in_teams": "3623",
"supervisor_in_teams": "Support",
"assigned_skills": null,
"assigned_queues": "AG Queue",
"employee_id\"": 123
}Example{ "id": 28982, "name": "AG D", "email": "ag@g.com", "sip_account": "ag@cc1.email.net", "sag": "Agent", "extension": "2594", "caller_id": "378", "timezone": "Istanbul", "webrtc_ringtone": "null,", "agent_in_teams": "3623", "supervisor_in_teams": "Support", "assigned_skills": null, "assigned_queues": "AG Queue", "employee_id\"": 123 }
400
Invalid query parameters
Invalid or nonexistent User API Key
{
"error": "Invalid User API Key"
}Example{ "error": "Invalid User API Key" }
Was this article helpful?
