tencent cloud

Cloud Contact Center

DocumentaçãoCloud Contact CenterDesk API ReferenceAPI ReferenceChatbot and Knowledge BaseAdd Chatbot Small Talk Library Category

Add Chatbot Small Talk Library Category

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

API Call Description

An App admin proactively invokes a RESTful API to add a new category to the chatbot's smalltalk library.

Sample Request URL

https://xxxxxx/v4/openim_console_http_svc/add_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 refer to REST API Introduction.
Parameter
Description
v4/openim_console_http_svc/add_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 to 4294967295.
contenttype
The request format has a fixed value of json.

Maximum Calling Frequency

5 times/second.

Sample Request Packet

{
    "ParentId": 10479,
    "Title": "This is a secondary category"
}

Request Packet Fields

Field
Type
Required
Description
Title
String
Required
Category title.
ParentId
Integer
Optional.
If you need to add a multi-level category, set the parent category ID here (the management console currently only supports two levels).

Response Package Example

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "CategoryId": 10515
}

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.
CategoryId
Integer
Added category ID.

Error Code Explanation

Unless a network error (for example, 502 error) occurs, the HTTP return code of this API is always 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 meets 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 Tool

Debug this interface through the online debugging tool for REST API.

References

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

Ajuda e Suporte

Esta página foi útil?

comentários