Versions Compared

Key

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

The GET /groups/{groupId} endpoint returns the group matching the group ID provided.

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

Table of Contents

Parameters

The endpoint accepts the following path parameter:

groupId

Type

Required

Example

StringTrue8e22b1fe-d2ea-403d-8c03-50eb21188e79

The group ID of the required group.

Responses

Responses contain the requested skill object.

Successful response

Successful requests return a 200 Success code and the requested skill.

Example response

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