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
ドキュメントCloud Contact CenterDesk API ReferenceAPI ReferenceChatbot and Knowledge BaseUpdate Chabot Basic Setting

Update Chabot Basic Setting

フォーカスモード
フォントサイズ
最終更新日: 2025-03-31 20:08:43

API Call Description

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

Sample Request URL

https://xxxxxx/v4/openim_console_http_svc/update_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/update_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 is fixed as json.

Sample Request Packet

{
    "WelcomeCardQuestions": [
        "How's the weather today?"
        Set RESTAPI welcome message
    ],
    "WelcomeCardEnable": 1,
    "WelcomeCardTitle": "What You Might Ask"
    "ToAgentEnable": 0,
    "DirectAnsweringReaches": "0.56",
    "ChitchatEnable": 1,
    "ChitchatReaches": "0.88",
    "ClarifyEnable": 1,
    "ClarifyReaches": "0.21",
    "ClarifyMessage": "You may want to ask"
    "ClarifyNumber": 6,
    "FallbackMsg": "Fallback triggered"
    "LanguageTag": ""
}

Request Packet Fields

Field
Type
Description
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
Q&A database direct answer similarity threshold (maximum similarity threshold for prompt question similarity).
ChitchatEnable
Integer
Small talk library toggle.
ChitchatReaches
String
Small talk library direct answer similarity threshold.
ClarifyEnable
Integer
Guided questions toggle.
ClarifyReaches
String
Minimum similarity threshold for prompt question.
ClarifyMessage
String
Guided question prompt script.
ClarifyNumber
Integer
Number of Suggestions: Return to 'n' matches each time guided.
FallbackMsg
String
Fallback response script.
LanguageTag
String
The language to be updated must have been added. The default language is empty.

Response Packet Body Sample

{
    "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 indicates success, non-zero indicates failure.
ErrorInfo
String
Error message.

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

API Debugging Tools

Debug this interface using the REST API online debugging tool.

References

Query one-to-one messages (v4/openim/admin_getroammsg)
前の記事へ: Get Chatbot General Setting次の記事へ: Delete Chatbot Smalltalk Library Category

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック