Page Comparison

The GET /users/by/agentDisplayId/{agentDisplayId} endpoint returns the agent user matching the agent ID provided.

...

Authorization scopes supported:

Scope	Access granted
`users:read`	Entire endpoint
`users:write`	Entire endpoint

Parameters

The endpoint accepts the following path parameter:

...

Type	Required	Example
String	True	123

The unique ID of the required agent user.

Requests

Get single user by username

Code Block

language	powershell
theme	Midnight

curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/users/by/agentDisplayId/123" \
-H "Accept: application/vnd.newvoicemedia.v4+json" \
-H "Authorization: Bearer <ACCESS_TOKEN>"

Responses

Responses contain the requested agent user object.

Successful response

Successful requests return a 200 Success code and the requested agent user.

Example response

Code Block

language	js
theme	Midnight

{
  "userId": "e439bc44-f867-4779-a3f5-0802e3e7f816",
  "username": "wallboard",
  "name": "Wallboard",
  "email": "wallboard@vonage.com",
  "userId": "8e22b1fe-d2ea-403d-8c03-50eb21188e79",
  "lastLoginTime": "2021-08-26T07:37:55.465Z",
  "active": true,
  "locked": false,
  "ssoExternalId": "exampleSso",
  "userAccountConfiguration": {
    "role": "Wallboard",
    "chargeable": true,
    "actAsAgent": true,
    "agentConfiguration": {
      "agentDisplayId": "123",
      "webrtc": true,
      "agentControlWebrtc": true,
      "handleMultipleInteractions": true,
      "enforcedDispositionCodes": false,
      "transcribeCalls": true,
      "screenRecording": false,
      "callParking": true,
      "salesCadence": false,
      "outboundAutoanswer": true,
      "inboundAutoanswer": true,
      "outboundWrapUp": 100,
      "backToReadyAfterNoAnswer": 100,
      "backToReadyAfterLineBusy": 90,
      "backToReadyAfterInvalidNumber": 80,
      "backToReadyAfterNetworkIssue": 5,
      "callRatingFrequency": 56,
      "video": true,
      "transcribeCallsRealTime": true,
      "callRecordingControls": true,
      "location": "GB",
      "telephonyAddress": {
        "telephoneAddress": "800100",
        "telephonyExtension": "44",
        "outboundTelephonyRegion": "ab6fd03e-de5a-41fb-9ad8-0e9fcb39f827",
        "nationalDisplay": true,
        "virtualLocation": "PL"
      },
      "capacity": {
        "isAgentLevel": false,
        "live": 60,
        "nonlive": 15,
        "semilive": 75
      },
      "associatedUsers": [
        {
          "username": "supervisor_vbc",
          "applicationType": "VBC"
        }
      ]
    }
  }
}

where:

Insert excerpt

	_ExcerptAPIUserObject
	_ExcerptAPIUserObject
nopanel	true