The GET /groups/{groupId}
endpoint returns the group matching the group ID provided.
...
Type | Required | Example |
---|---|---|
String | True | 8e22b1fe-d2ea-403d-8c03-50eb21188e79 |
The group ID of the required group.
Requests
Request a single group
Code Block | ||||
---|---|---|---|---|
| ||||
curl -L -X GET "https://***.api.newvoicemedia.com/useradmin/groups/8e22b1fe-d2ea-403d-8c03-50eb21188e79" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" |
Responses
Responses contain the requested skill object.
Successful response
Successful requests return a 200 Success
code and the requested skill.
Example response
Code Block | ||||
---|---|---|---|---|
| ||||
{ "groupId": "38baddf8-932d-4bb4-9840-5e28f719fa3e", "groupName": "Group", "groupMaxUnexpectedTime": 1500, "groupMaxWrapUpTime": 500, "groupDisplayId": "795" } |
where:
groupId
. The unique ID of the group.groupName
. The group’s name, used for display purposes throughout the Vonage Contact Center (VCC) platform.groupMaxUnexpectedTime
. The maximum time, in seconds, that a user in the group can be in any of the Unexpected or Fault states, such as Fault on Line, No Answer, or Line Busy. The default is 10 seconds.groupMaxWrapUpTime
. The maximum time, in seconds, that a user in the group can be in the Wrap Up (Auto) state. The default is 10 seconds.groupDisplayId
. The group's unique ID.