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

Data Processing And Security Agreement

Service Level Agreements

TENCENT CLOUD CONTACT CENTRE TERMS OF USE

Glossary

Retrieve Chatbot Smalltalk Library Question

Focus Mode

Font Size

Last updated: 2025-03-31 20:24:15

API Call Description
Support proactive invocation of RESTful APIs in the App backend to get chatbot smalltalk library questions.
Caution:
The question bank retrieved via REST API is the one that takes effect in the live network (status after release).
Sample Request URL
https://xxxxxx/v4/openim_console_http_svc/list_chitchat?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/list_chitchat
Request API.
sdkappid
The assigned SDKAppID in the Chat 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
{
    "PageIndex": 1,
    "PageSize": 3,
    "Question":"robot"
    "CategoryId":10463,
    "Status":4
}
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.
Filter by category ID.
Status
Integer
Optional.
Status filtering. 
If filling in needs to meet the enumerated status:
4 - Come into effect.
5 - Disabled.
Other value is illegal.
Response Package Example
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "AllQuestionCount": 4,
    "StandardQuestionCount": 2,
    "QuestionList": [
        {
            "StandardQuestionId": "1500086166-@RBT#DeskDefaultRobot-dhoLfseT3tvxP4HB",
            "StandardQuestion": "Are you an AI?",
            "Status": 4,
            "CategoryId": 10463,
            "Answer": "I'm an intelligent robot. I can answer your questions and provide information. If you have any questions or need assistance, please tell me at any time."
            "AnswerType": 0,
            "QuestionType": 1,
            "SimilarQuestions": []
        },
        {
            "StandardQuestionId": "1500086166-@RBT#DeskDefaultRobot-y0WjnE0Siv1oDbLR",
            "StandardQuestion": "Are you an intelligent robot?"
            "Status": 4,
            "CategoryId": 10463,
            "Answer": "I'm an intelligent robot. I can answer your questions and provide information. If you have any questions or need assistance, please tell me at any time."
            "AnswerType": 0,
            "QuestionType": 1,
            "SimilarQuestions": []
        }
    ]
}
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 - Come into 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. Problem type enumeration:
0 - Ordinary question.
1 - System preset.
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 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 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 rate limit allowed by this API.
-20
Request requires App administrator permissions.
API Debugging Tool
Debug this interface using the REST API online debugging tool.
References
Query one-to-one chat messages (v4/openim/admin_getroammsg)

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

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

Feedback

Parameter	Description
v4/openim_console_http_svc/list_chitchat	Request API.
sdkappid	The assigned SDKAppID in the Chat 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`.

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.	Filter by category ID.
Status	Integer	Optional.	Status filtering. If filling in needs to meet the enumerated status: 4 - Come into effect. 5 - Disabled. Other value is illegal.

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 rate limit allowed by this API.
-20	Request requires App administrator permissions.

tencent cloud

Cloud Contact Center

Retrieve Chatbot Smalltalk Library Question

API Call Description

Sample Request URL

Request Parameters

Maximum Calling Frequency

Sample Request Packet

Request Packet Fields

Response Package Example

Response Packet Fields

Error Code Explanation

API Debugging Tool

References

Help and Support