Agents enter reason codes on their agent desktops when they go Not Ready. Reason codes appear in Unified Intelligence Center reports and help identify agent behavior.
Use the Reason Code API to define new reason codes, and edit and delete records of existing reason codes.
URL
https://<server>/unifiedconfig/config/reasoncode
Operations
- create: Creates one reason code.
- delete: Marks one reason code for deletion.
- get: Returns one reason code, using the URL https://<server>/unifiedconfig/config/reasoncode/<id>.
- list: Retrieves a list of reason codes.
- update: Updates one reason code.
Parameters
- refURL: The refURL of the reason code. See Shared parameters.
- changestamp: See Shared parameters.
- description: See Shared parameters.
- code: Required. The unique reason code. Integers between 0 and 65535. Value cannot be updated after the reason code has been created.
- text: Required. The text that describes the reason code. Maximum length of 40 characters allowed.
Search and sort values
The following table shows the parameters that are searched and the parameters that are sortable.
Search parameters |
Sort parameters |
|
- text (default)
- description
- code
|
See Search and Sort.
Example get response
<reasonCode>
<changeStamp>0</changeStamp>
<refURL>/unifiedconfig/config/reasoncode/5001</refURL>
<code>1</code>
<description>This is a reason code.</description>
<text>Reason Code1</text>
</reasonCode>