Wrap-up codes

API Docs by APIMATIC
API OverviewAgent Application

Wrap-up codes
#

Wrap-up Codes
#

The Warp-up Codes API is part of Voiso's Agent Application APIs. Use it to obtain a list of all wrap-up codes and their descriptions that you can access based on your user API key. The API description is here.

Prerequisites
#

  • The requesting user must be configured in your contact center.
  • You must have at least one wrap-up code configured for your contact center.

Making requests
#

The Wrap-up codes API requires the base URL (cluster_id) and the user API key (user_api_key). This tells Voiso which user is making the request. Voiso responds with the list of wrap-up codes the requesting user can access.

Use the API request to initiate a call. For example:

{
  "method": "GET",
  "url": "https://cluster1.voiso.com/api/v2/cdr/wrapup_codes",
  "params": {
    "key": "cc7c76b8987a27ab57...00ab6c3"
  }
}

Response
#

The following table describes the elements of the response.

ElementDescriptionTypeNotes
descriptionThe name of the wrap-up code and its associated code number.string
codeThe wrap-up code number.string

Response sample
#

[
    {
        "description": "0100: Qualified Lead",
        "code": "0100"
    },
    {
        "description": "0101: Lead discarded",
        "code": "0101"
    },
    {
        "description": "1007: Premium",
        "code": "1007"
    },
    {
        "description": "2112: Rush Sale",
        "code": "2112"
    }
]

Troubleshooting
#

The following issues are sometimes encountered:

Invalid User API Key
#

The Wrap-up codes API requires the user API key to validate the request. If you see this error, "error": "Invalid User API Key", check that you are using the correct user API key. For more information about API keys, refer to Authentication.


Was this page helpful?

Thank you! Your feedback has been received.