Get group by group ID
The GET /groups/{groupId} endpoint returns the group matching the group ID provided.
In this page
Most URLs in the example code use the following values:
- ***. To access the API for your region, replace *** with the correct subdomain for your region:
Region URL subdomain Base URL EMEA emea https://emea.api.newvoicemedia.com USA nam https://nam.api.newvoicemedia.com APAC apac https://apac.api.newvoicemedia.com - <ACCESS_TOKEN>. The value represents a bearer access token which you must use to validate every request. Replace <ACCESS_TOKEN> where used with your bearer access token. For information about getting a bearer access token, see How to authenticate with a Vonage Contact Center (VCC) API.
Headers
Header parameters in Requests (User Admin API) apply to this endpoint.
Authorization scopes supported:
| Scope | Access granted |
|---|---|
users:read | Entire endpoint |
users:write | Entire endpoint |
Parameters
The endpoint accepts the following path parameter:
groupId
Type | Required | Example |
|---|---|---|
| String | True | 8e22b1fe-d2ea-403d-8c03-50eb21188e79 |
The group ID of the required group.
Requests
Request a single group
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
{
"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.
Try it out
For information, see Trying out Vonage Contact Center APIs.