Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The POST /groups endpoint creates a new group using the provided values.

Panel
borderColor#eeeeee
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#7ec9f4#0276D5
borderStylesolid
titleIn this page

Table of Contents

Insert excerpt
_ExcerptAPICloudNextGen
_ExcerptAPICloudNextGen
nopaneltrue

Headers

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

Authorization scopes supported:

ScopeAccess granted
users:writeEntire endpoint

Requests

Example Request

Code Block
languagepowershell
themeMidnight
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>"

...

Code Block
languagejs
themeMidnight
{
  "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.

Insert excerpt
_ExcerptRunInPostman
_ExcerptRunInPostman
nopaneltrue