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
DocumentationCloud Contact CenterDesk API ReferenceAPI ReferenceChatbot and Knowledge BaseRetrieve Chatbot FAQ Library Category List

Retrieve Chatbot FAQ Library Category List

Focus Mode
Font Size
Last updated: 2025-03-31 20:25:05

API Call Description

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

Sample Request URL

https://xxxxxx/v4/openim_console_http_svc/desc_faq_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/desc_faq_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
Signature generated by 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 Packet Body Sample

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "Total": 2,
    "List": [
        {
            "CategoryId": 77519,
            "ParentId": 0,
            "Title": "All categories"
            "MenuType": 1,
            "Status": 1
        },
        {
            "CategoryId": 77520,
            "ParentId": 0,
            "Title": "Preset Q&A database"
            "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.
Status
Integer
Category status.
Enable.

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 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 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 APIs.

References

Query one-to-one chat messages (v4/openim/admin_getroammsg)
Previous Topic: Retrieve Chatbot Smalltalk Library QuestionNext Topic: Retrieve Chatbot FAQ Library

Help and Support

Was this page helpful?

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

Feedback