Get list of wrapup codes

Returns a paginated list of all wrapup codes in the contact center.

The Get list of wrapup codes endpoint returns the wrap-up codes you can access.

Requirements: Base URL, Authentication, Error codes

Scope: contact_center.wrapup_codes.read

What this does

When you send a Get list of wrapup codes request,

Voiso
returns a paginated list of wrap-up code objects.

Endpoint


GET /api/v4/wrapup_codes

Query parameters

All query parameters are optional.

  • limit
    The number of items to return. Default is 100. Maximum is 100.
  • offset
    The number of items to skip before collecting results. Default is 0.

Example request

curl -X GET "https://{cluster_id}.voiso.com/api/v4/wrapup_codes?limit=20&offset=40" \
  -H "Authorization: Bearer <contact_center_api_key>" \
  -H "Content-Type: application/json"

Response

If successful, the API returns a wrapup_codes array and pagination metadata.

{
  "wrapup_codes": [
    {
      "id": 12,
      "name": "Payment collected",
      "code": "PAY-01",
      "group": {
        "id": 3,
        "name": "Billing"
      }
    }
  ],
  "metadata": {
    "total": 100
  }
}

Notes

  • Use wrap-up codes to categorize call outcomes for reporting.

Troubleshooting

401 Unauthorized

What to check:

  • You are sending Authorization: Bearer <contact_center_api_key>.

403 Forbidden

What to check:

  • The API key is valid, but does not have access to wrap-up code resources.

429 Too many requests

What to do:

  • Reduce request frequency and retry with backoff.
Query Params
integer
0 to 1000
Defaults to 100

The number of items to return.

integer
≥ 0
Defaults to 0

The number of items to skip before starting to collect the result set.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json