tencent cloud

Cloud Contact Center

DocumentaçãoCloud Contact CenterDesk API ReferenceAPI ReferenceChatbot and Knowledge BaseGet Chatbot General Setting

Get Chatbot General Setting

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

API Call Description

App admin proactively invokes RESTful APIs to view chatbot configuration on production environment.

Sample Request URL

https://xxxxxx/v4/openim_console_http_svc/desc_robot_config?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/desc_robot_config
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.

Sample Request Packet

{
    "LanguageTag": ""
}

Request Packet Fields

Field
Type
Description
LanguageTag
String
Multilingual filtering. Default can be empty.

Response Packet Body Example

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "WelcomeCardEnable": 1,
    "WelcomeCardTitle": "What You Might Ask"
    "WelcomeCardQuestions": [
        "What functionalities does the smart customer service provide?"
        How to modify the robot knowledge base
        Where does customer service send/receive messages?
        how to set working hour
        Whether sending satisfaction evaluation is supported
        Can the robot functionality be disabled?
        Which message channels are supported?
        "What situations will enter the queue"
    ],
    "ToAgentEnable": 1,
    "DirectAnsweringReaches": 0.8,
    "ChitchatEnable": 0,
    "ChitchatReaches": "0.8",
    "ClarifyEnable": 0,
    "ClarifyReaches": "0.6",
    "ClarifyMessage": "You may want to ask:"
    "ClarifyNumber": 5,
    "FallbackMsg": "Sorry, I haven't learned this issue yet. Please rephrase or try asking me other questions."
}

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.
WelcomeCardEnable
Integer
Welcome card feature toggle.
WelcomeCardTitle
String
Welcome card title.
WelcomeCardQuestions
Array
Welcome card question list.
ToAgentEnable
Integer
Agent transfer intent recognition toggle
DirectAnsweringReaches
String
Direct answer similarity threshold in the Q&A database (maximum similarity threshold for prompt questions).
ChitchatEnable
Integer
Small talk library toggle.
ChitchatReaches
String
Similarity threshold for direct answers in the small talk library.
ClarifyEnable
Integer
Guided questions toggle
ClarifyReaches
String
Minimum similarity threshold for guided questions.
ClarifyMessage
String
Guided question prompt script.
ClarifyNumber
Integer
Number of Suggestions: Return to 'n' matches each time guided.
FallbackMsg
String
Fallback response script.

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 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 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.
-50003
Desk resource is invalid.
-50040
The requested application has not created desk service/application.

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)

Anterior: Create GroupPróximo: Update Chabot Basic Setting

Ajuda e Suporte

Esta página foi útil?

comentários