Users

API Docs by APIMATIC
API OverviewUser Management

Users
#

Users
#

The users API is part of Voiso's User Management APIs. Use it to obtain a list of all agent names and IDs. Please refer to the detailed API endpoint specification here.

Making requests
#

Authentication
#

The users API requires the base URL and the user API key.

Request parameters
#

The users API uses the key parameter: the user API key representing the user making the request. Based on the user's permissions configured, Voiso provides the data allowed for that particular user.

Simple HTTP request example:

https://cluster1.voiso.com/api/v3/cdr/users
    ?key=cc7c76b8987a27ab57af0add8...d6bb89b00ab6c3

The users API also enables you to apply filters to the GET request. The following filters are supported:

ParameterDescriptionTypeRequiredNotes
nameThe name of the user.stringOptionalGet only information for the specified user.
emailThe email address of the user.stringOptionalGet only information for the user based on the specified sign-in email address.
sip_accountThe SIP server address for the user's WebRTC Softphone.stringOptionalGet only information for the user based on the specified SIP server address.
sagThe user's role.stringOptionalGet only information for the users who are assigned to the specified security access group.
extensionThe WebRTC extension of the user.stringOptionalGet only information for the user based on the specified contact center extension.
caller_idThe Caller ID group of the user.stringOptionalGet only information for the users who are assigned to the specified caller ID group.
timezoneThe time zone of the user.stringOptionalGet only information for the users who are assigned to the specified time zone.

Full HTTP request example:

https://cluster1.voiso.com/api/v3/cdr/users
    ?key=cc7c76b8987a27ab57af0add8...d6bb89b00ab6c3&name=<string>&email=<string>&sip_account=<string>&sag=<string>&extension=<string>&caller_id=<string>&timezone=<string>

JSON request example:

{
  "method": "GET",
  "url": "https://cluster1.voiso.com/api/v3/cdr/users",
  "params": {
    "key": "cc7c76b8987a27ab57af0add8...d6bb89b00ab6c3",
    "name": "<string>",
    "email": "<string>",
    "sip_account": "<string>",
    "sag": "<string>",
    "extension": "<string>",
    "caller_id": "<string>",
    "timezone": "<string>"
  }
}

Response
#

The following table describes the elements of the response.

ElementDescriptionTypeNotes
idThe ID assigned by the system when the user is created.number
nameThe name of the user, corresponding to the Name field in the User profile.string
emailThe email address the agent uses to sign in to Voiso.string
sip_accountThe SIP address of the user's softphone.string
sagThe name of the Security Access Group to which the user is assigned.string
extensionThe contact center extension used to route calls to the user.string
caller_idThe name of the caller ID group to which the user is assigned.string
timezoneThe name of the time zone selected for the user.string
webrtc_ringtoneThe name of the ringtone assigned to the user.string
agent_in_teamsA comma-separated list of the IDs of the Teams to which the user is assigned.stringUse the Teams API to obtain the team IDs.
supervisor_in_teamsA comma-separated list of the IDs of the Teams that the user supervises.stringUse the Teams API to obtain the team IDs.
assigned_skillsAn object containing an array of the names of the skills and the assigned skill level.objectThe skills are returned as a comma-separated list of key-value pairs, both of type string in this format: "name": "number"
assigned_queuesA comma-separated list of queue names.string
employee_idThe value assigned to the user in the Employee ID field of the user profile.string

Response sample
#

{
  "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, 7850",
  "supervisor_in_teams": "Support",
  "assigned_skills": {
            "Claims": "1",
            "Technical": "10",
            "Mandarin": "1"
        },
  "assigned_queues": "AG Queue, Support",
  "employee_id"": "123"
}

Troubleshooting
#

The following issues are sometimes encountered:

Invalid User API Key
#

The users API requires the user API key to validate the request. If you see this error, "error": "Invalid User API Key", check that you use the correct user API key. For more information about API keys, refer to Authentication.


Was this page helpful?

Thank you! Your feedback has been received.