Create group
The POST /groups endpoint creates a new group using the provided values.
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:write | Entire endpoint |
Requests
Example Request
curl -L -X POST "https://***.api.newvoicemedia.com/useradmin/groups" \ -H "Content-Type: application/json" \ -H "Accept: application/vnd.newvoicemedia.v4+json" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ --data-raw "<JSON BODY>"
Request body
The endpoint requires a skill object in JSON format as in the request body.
Example body
{
"groupName": "GroupName",
"groupMaxUnexpectedTime": 1000,
"groupMaxWrapUpTime": 1250,
"groupDisplayId": "85479"
}
where:
groupName. The name of the group.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 secondsgroupDisplayId. The group’s unique ID.
Responses
Successful response
Successful requests return a 200 Success code.
Try it out
For information, see Trying out Vonage Contact Center APIs.