Skip to main content

Get All Users

API: goGetAllUsers


Description

This API endpoint fetches a complete list of all user accounts in the system along with their associated details such as name, extension, campaigns, profile level, allowed companies, and specific permissions like inbound, dialer, and manual dial capabilities. It also returns the list of all available campaigns, preview campaigns and the total of users.

🔗 URL

https://DOMAIN.croco-dial.net/goAPIv2/goUsers/goAPI.php

Note: Replace domain with the specific domain you want to query.


📝 Required Parameters

ParameterValueDescription
goActiongoGetAllUsersAction to retrieve all users in the system (Active and inactive ones).
goUserMyUserAPI authorized user.
goPassMyPassPassword for the API authorized user.
only_inactives00 to show Active Users, or 1 to show Inactive Users.
responsetypejson/xmlFormat of the response (json recommended).

📝 Optional Parameters

ParameterValueDescription
only_inactives0 or 1Use the value 0 to show Active Users, or 1 to show Inactive Users.

Note: This endpoint uses body parameters for authentication instead of tokens or headers.

Request Examples:

GET:

curl -X GET "https://domain.croco-dial.net/goAPIv2/goUsers/goAPI.php?goAction=goGetAllUsers&goUser=MyUser&goPass=MyPass&responsetype=json"

POST (Form Data):

If you prefer to send the data as form parameters:

curl -X POST "https://DOMAIN.croco-dial.net/goAPIv2/goUsers/goAPI.php" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "goAction=goGetAllUsers" \
  --data-urlencode "goUser=MyUser" \
  --data-urlencode "goPass=MyPass" \
  --data-urlencode "responsetype=json"

  Example Response

{
  "result": "success",
  "data": {
    "user_list": [
      {
        "user_id": 2222,
        "user": "Jhon.Exp",
        "name": "Jhon Example",
        "exten": 2222,
        "level": 1,
        "active": "Y",
        "campaign_id": "4460708090",
        "campaign_name": "...",
        "rank": 0,
        "profile_id": 22,
        "allowed_companys": ["AMI", "IST", "PTR"],
        "inbound": 1,
        "dialer": 1,
        "xfer": 1,
        "manual_dial_only": 0,
        "closer_campaigns": " AGENTDIRECT ",
        "agentcall_manual": "1"
      },
      ...
    ],
    "all_campaigns": [
      "SERVERS", "CUSTSERVICE", "COLLECTIONS", "NEWLOANS",
      ...
    ],
    "all_preview_campaigns": [
      {
        "campaign_id": "12345678",
        "campaign_name": "PAYMENTS"
      },
      {
        "campaign_id": "234567891",
        "campaign_name": "GENERAL"
      }
     ],
        "total_users": 165,
        "total_active_users": 165,
        "total_inactive_users": 0
    }
}

 

📌 Response Fields

FieldDescription
user_idUnique identifier for the user.
userUsername.
nameFull name of the user.
extenUser extension number.
levelAccess level of the user.
activeWhether the user is active ("Y" or "N").
campaign_idID of the primary campaign assigned.
campaign_nameName of the primary campaign.
rankUser rank (for prioritization).
profile_idID of the assigned user profile.
allowed_companysList of companies the user has access to.
inboundInbound call permission (1 = Yes, 0 = No).
dialerDialer permission (1 = Yes, 0 = No).
xferTransfer permission (1 = Yes, 0 = No).
manual_dial_onlyWhether the user is restricted to manual dialing only.
closer_campaignsString of campaigns available for call transfers.
agentcall_manualIndicates if manual agent calling is enabled (usually "1").