tencent cloud

Cloud Contact Center

Announcement
What's New
Cloud Contact Center Terminology Update
What is Tencent Cloud Contact Center
Overview
Feature List
Terms Introduction
Handling Firewall Restrictions
AI Voicebot
Billing Guide
Voice Call Billing Overview
Desk Billing Overview
View Billing
Refund Policy
New User Guide
Voice Guide
Desk Guide
Use Case
Inbound: Customer Experience
Outbound: Telemarketing
Auto Dialer: Voice Notification
Integration Use Case (SDK)
Administrator Guide
Voice Guide
Desk Guide
Member Guide
Voice Guide
Desk Guide
AI Voice Agent Guide
Introducing AI Voice Agent
AI Voice Agent Practical Tutorial
Set Up Your AI Voice Agent
Activate AI Voice Agent Call
AI Voice Agent Call Logs
Developer Guide
SDK Development Guide
Data Push
Voice API Reference
History
Introduction
API Category
Making API Requests
Agent APIs
Skill Group APIs
Number APIs
Dual Call APIs
Predictive Outbound Call APIs
SIP Phone APIs
Call Service Record APIs
Billing APIs
Other APIs
Outbound Call APIs
Speech Intelligent Agent APIs
Data Types
Error Codes
Desk API Reference
API Reference
Callback Configuration
FAQs
Data Deletion Guide
Legal
Privacy Policy
Data Processing And Security Agreement
Service Level Agreements
TENCENT CLOUD CONTACT CENTRE TERMS OF USE
Glossary
Contact Us

Retrieve Chatbot FAQ Library

Mode fokus
Ukuran font
Terakhir diperbarui: 2025-03-31 20:25:56

API Call Description

Support active call of RESTful APIs in App backend to retrieve chatbot Q&A library questions.
Caution:
The question bank retrieved via REST API is the production-effective question bank (status after release).

Sample Request URL

https://xxxxxx/v4/openim_console_http_svc/list_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 parameter details, please see REST API Introduction.
Parameter
Description
v4/openim_console_http_svc/list_faq
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

{
"PageIndex": 1,
"PageSize": 3,
"Question":"robot"
"CategoryId":10463,
"Status":4,
"LanguageTag":""
}

Request Packet Fields

Field
Type
Required
Description
PageIndex
Integer
Required
Pagination parameters (more than 0).
PageSize
Integer
Required
Pagination parameters (more than 0).
Question
String
Optional.
Main issue keyword-based filtering.
CategoryId
Integer
Optional.
Category ID-based filtering.
Status
Integer
Optional.
Status filtering. If filling in, To meet enumerated statuses:.
4 - Take effect.
5 - Disabled.
Other value is illegal.
LanguageTag
String
Optional.
Multilingual filtering.
Note: If this language tag is not provided, tags in other languages will not be pulled.

Response Packet Body Example

{
"ActionStatus": "OK",
"ErrorInfo": "",
"ErrorCode": 0,
"AllQuestionCount": 4,
"StandardQuestionCount": 2,
"QuestionList": [
{
"StandardQuestionId": "1721001306-@RBT#DeskDefaultRobot-7TBD7Xl2XuK8LL3X",
"StandardQuestion": "how to modify robot knowledge base"
"Status": 4,
"CategoryId": 10464,
"Answer": "You can click intelligent bot > knowledge base in the left menu bar on the management console. After the update is completed, click the publish button in the top right corner. It will take effect in the official environment after successful release.
"AnswerType": 0,
"QuestionType": 0,
"SimilarQuestions": [
How to add Q&A
]
},
{
"StandardQuestionId": "1721001306-@RBT#DeskDefaultRobot-YuJtJBLlmnwbZlSV",
"StandardQuestion": "Can robot functionality be disabled?"
"Status": 4,
"CategoryId": 10464,
"Answer": "You can click Intelligent Robot > Knowledge Base in the left menu bar on the management console. Click Disable in the upper-right corner of the opened page. Once disabled, user consultations will be directly transferred to manual customer service."
"AnswerType": 0,
"QuestionType": 0,
"SimilarQuestions": [
How to implement that all questions are replied by customer service
]
}
]
}

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.
AllQuestionCount
Integer
Total number of issues.
StandardQuestionCount
Integer
Number of standard questions.
QuestionList
Array
Problem list.
StandardQuestionId
String
Standard question ID.
StandardQuestion
String
Standard question.
Status
Integer
Status. Status value enumeration:
4 - Take effect.
5 - Disabled.
CategoryId
Integer
Category ID.
Answer
String
Answer.
AnswerType
Integer
Answer type.
Answer Type Enumeration
0 - Ordinary text.
2 - Rich text.
QuestionType
Integer
Problem type. Enumerate problem types.
0 - Ordinary issue
SimilarQuestions
Array
Similar question list.

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 complies with 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.

API Debugging Tool

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

References

Query one-to-one chat messages (v4/openim/admin_getroammsg)

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan