tencent cloud

Cloud Contact Center

DocumentaçãoCloud Contact CenterDesk API ReferenceAPI ReferenceChatbot and Knowledge BaseRetrieve Chatbot Smalltalk Library Category List

Retrieve Chatbot Smalltalk Library Category List

Modo Foco
Tamanho da Fonte
Última atualização: 2025-03-31 20:20:38

API Call Description

Support proactive invocation of RESTful APIs in the App backend to retrieve chatbot smalltalk library category list.

Sample Request URL

https://xxxxxx/v4/openim_console_http_svc/desc_chitchat_category?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request Parameters

The following table only lists the parameters involved in modification when calling this API and their descriptions. For more parameter details, please see REST API Introduction.
Parameter
Description
v4/openim_console_http_svc/desc_chitchat_category
Request API.
sdkappid
Assigned SDKAppID in the IM console when creating an application.
identifier
Must be an App administrator account. For more details, see App Administrator.
usersig
Generated signature of the App administrator account. For specific operations, see Generate UserSig.
random
Enter a random 32-bit unsigned integer in the range of [0,4294967295].
contenttype
The request format has a fixed value of json.

Maximum Calling Frequency

5 times/second.

Sample Request Packet

{
}
Notes:
Just fill in the blank of the request payload with the JSON structure.

Response Package Example

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "Total": 8,
    "List": [
        {
            "CategoryId": 10506,
            "ParentId": 0,
            "Title": "System preset category"
            "MenuType": 2,
            "Status": 1
        },
        {
            "CategoryId": 10507,
            "ParentId": 0,
            All categories
            "MenuType": 1,
            "Status": 1
        },
        {
            "CategoryId": 10508,
            "ParentId": 10506,
            "Title": "Daily greeting"
            "MenuType": 2,
            "Status": 1
        },
        {
            "CategoryId": 10509,
            "ParentId": 10506,
            "Title": "Ask robot information"
            "MenuType": 2,
            "Status": 1
        },
        {
            "CategoryId": 10510,
            "ParentId": 10506,
            "Title": "Emotional expression"
            "MenuType": 2,
            "Status": 1
        },
        {
            "CategoryId": 10511,
            "ParentId": 10506,
            "Title": "hobbies"
            "MenuType": 2,
            "Status": 1
        },
        {
            "CategoryId": 10512,
            "ParentId": 10506,
            "Title": "Customer service scenario QA"
            "MenuType": 2,
            "Status": 1
        },
        {
            "CategoryId": 10513,
            "ParentId": 0,
            "Title": "Update of small talk library categorization"
            "MenuType": 0,
            "Status": 1
        }
    ]
}

Response Packet Fields

Field
Type
Description
ActionStatus
String
Request processing result. OK: processing successful; FAIL: processing failed.
ErrorCode
Integer
Error code: 0 indicates success, non-zero indicates failure.
ErrorInfo
String
Error message.
Total
String
Total number of categories.
List
Array
Classification list.
CategoryId
Integer
Category unique ID.
ParentId
Integer
Parent category ID. When the category is a sub-category, this value is not 0 and points to the parent category ID.
MenuType
Integer
Classification Type
0: Ordinary categorization.
Represent all categories.
2: Represent preset classifications.
Status
Integer
Category status:
1: Enable.

Error Code Description

Unless a network error (for example, 502 error) occurs, the HTTP return code of this API is 200. The actual error code and error information are indicated by ErrorCode and ErrorInfo in the response packet body.
For common error codes (60000 to 79999), see the Error Code document.
The private error codes of this API are as follows:
Error Code
Description
-7
Parameter parsing failed. Check whether the request package complies with the JSON Specification or the request parameters meet requirements.
-14
Exceeds the maximum frequency limit allowed by this API.
-20
Request requires App administrator permissions.

API Debugging Tools

Debug this interface using the Online Debugging Tool for REST API.

References

Query one-to-one chat messages (v4/openim/admin_getroammsg)
Anterior: Add Chatbot FAQ Library QuestionPróximo: Retrieve Chatbot Smalltalk Library Question

Ajuda e Suporte

Esta página foi útil?

comentários