The POST /groups
endpoint creates a new group using the provided values.
Panel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
Insert excerpt _ExcerptAPICloudNextGen _ExcerptAPICloudNextGen nopanel true
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
Code Block | ||||
---|---|---|---|---|
| ||||
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 | ||||
---|---|---|---|---|
| ||||
{ "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.
Insert excerpt _ExcerptRunInPostman _ExcerptRunInPostman nopanel true