tencent cloud

Cloud Contact Center

DocumentationCloud Contact CenterDesk API ReferenceAPI ReferenceChatbot and Knowledge BaseUpdate Chatbot FAQ library

Update Chatbot FAQ library

Focus Mode
Font Size
Last updated: 2025-03-31 20:16:41

API Call Instructions

App admin proactively invokes RESTful APIs to update questions in the chatbot FAQ library.
Caution:
Take effect directly on the live network after configuration through REST API (set and publish in the management console).

Request URL Sample

https://xxxxxx/v4/openim_console_http_svc/update_faq?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 details about the parameters, please refer to REST API Introduction.
Parameter
Description
v4/openim_console_http_svc/update_faq
Request API.
sdkappid
The assigned SDKAppID of Chat 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: json.

Maximum Calling Frequency

5 times/second.

Sample Request Packet

{
    "StandardQuestionId": "1500086040-@RBT#DeskDefaultRobot-qJLb9mKIA4bmdv9j",
    "Answer":"This is an answer"
    "AnswerType":2,
    "CategoryId":77514,
    "Question":"Test modifying the main issue"
}

Request Packet Fields

Field
Type
Description
StandardQuestionId
String
The ID of the standard question to be modified.
Answer
String
Answer (optional, leave blank if not modifying the answer).
AnswerType
Integer
Answer type (optional, leave blank if not modifying the answer type).
0-Ordinary text QA.
Rich text document 2
CategoryId
Integer
Category ID (optional, leave blank if not modifying the category).
Question
String
Question (optional, leave blank if not modifying the question).

Response Package Example

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

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.

Error Code Description

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 represented by ErrorCode and ErrorInfo in the response packet body.
For common error codes (60000 to 79999), see Error Code document.
The private error codes of this API are as follows:
Error Code
Description
-7
Parameter parsing failure. Check whether the request package conforms to the JSON Specification or the request parameters meet requirements.
-14
Exceeds the maximum rate limit allowed by this API.
-20
Request requires App administrator permissions.
-50003
Smart customer service resource is unavailable.
-50040
The requested application has not enabled intelligent customer service.
-50011
Delete system preset classification.

API Debugging Tool

Debug this interface using the REST API online debugging tool.

References

Query one-to-one chat messages (v4/openim/admin_getroammsg)
Previous Topic: Update Chatbot FAQ Library Similar QuestionNext Topic: Add Chatbot Small Talk Library Category

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback