Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Current »

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:

Headers

Header parameters in Requests (User Admin API) apply to this endpoint.

Authorization scopes supported:

ScopeAccess granted
users:writeEntire 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:

  • groupNameThe 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 seconds
  • groupDisplayIdThe 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.

  • No labels