tencent cloud

Cloud Contact Center

DocumentaçãoCloud Contact CenterDesk API ReferenceAPI ReferenceChatbot and Knowledge BaseAdd Chatbot FAQ Library Question

Add Chatbot FAQ Library Question

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

API Call Description

Support invoking RESTful APIs in the App backend to add questions to the chatbot FAQ library.
Caution:
Take effect directly on the live network after being set via the REST API (set and publish in the management console).

Sample Request URL

https://xxxxxx/v4/openim_console_http_svc/add_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 see REST API Introduction.
Parameter
Description
v4/openim_console_http_svc/add_faq
Request API.
sdkappid
The assigned SDKAppID of the 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 of json.

Maximum Calling Frequency

5 times/second.

Sample Request Packet

{
    "CategoryId": 77514,
    Add Question to REST_API
    "Answer":"Add response for REST_API"
    "AnswerType":0,
    "SimilarQuestions":[
        "Similar question 1"
        Similar question 2
    ],
    "LanguageTag": ""
}

Request Packet Fields

Field
Type
Description
CategoryId
Integer
The category to add to.
Question
String
The problem to add.
Answer
String
Answer.
AnswerType
Integer
Answer type.
To meet enumeration value:
Ordinary text response.
2 - Rich text response.
SimilarQuestions
Array
Similar questions.
LanguageTag
String
Multilingual tag.

Response Packet Body 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: success; non-0: 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 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 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 CategoryPróximo: Retrieve Chatbot Smalltalk Library Category List

Ajuda e Suporte

Esta página foi útil?

comentários