文档反馈官招募中，报名立赚积分兑换代金券！> HOT
文档中心>即时通信 IM>智能客服（Desk）>服务端 API>REST API>智能机器人知识库相关>查询机器人基础配置

查询机器人基础配置

最近更新时间：2026-07-01 15:55:35

我的收藏

本页目录：

接口调用说明

App 管理员主动调用 REST API 接口，查看当前机器人现网发布状态配置。

请求 URL 示例

https://xxxxxx/v4/openim_console_http_svc/desc_robot_config?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
v4/openim_console_http_svc/desc_robot_config
请求接口。
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID。
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员。
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig。
random
请输入随机的32位无符号整数，取值范围0 - 4294967295。
contenttype
请求格式固定值为 json。

请求包示例

{
    "RobotId": "@RBT#DeskDefaultRobot",
    "LanguageTag": ""
}

请求包字段说明

字段
类型
属性
说明
RobotId
String
必填
机器人 ID。若为空则代表默认机器人。
LanguageTag
String
选填
语言标签，开启多语言后需传入，获取对应语言的机器人基础配置。
不传默认查询默认兜底语言的配置。

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "Prompt": "你是一个友好的智能客服助手",
    "WelcomeCardEnable": 1,
    "WelcomeCardTitle": "猜你想问",
    "WelcomeCardQuestions": [
        "智能客服提供哪些功能",
        "如何修改机器人知识库",
        "客服在哪里收发消息",
        "如何设置工作时间",
        "是否支持发送满意度评价",
        "机器人功能可以关闭吗",
        "支持哪些消息渠道",
        "什么情况会进入排队"
    ],
    "EnableStreamingOutput": 1,
    "EnableFaq": 1,
    "EnableFile": 1,
    "EnableTaskFlow": 0,
    "ResponseMethodOutOfFaq": 1,
    "FallbackResponseContent": "抱歉，我还没有学会这个问题，请换种问法或尝试询问我其他问题。",
    "EnableToAgent": 1
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果，OK 表示处理成功，FAIL 表示失败。
ErrorCode
Integer
错误码，0表示成功，非0表示失败。
ErrorInfo
String
错误信息。
Prompt
String
提示词，用于设定机器人角色。
WelcomeCardEnable
Integer
欢迎卡片功能开关。
WelcomeCardTitle
String
欢迎卡片标题。
WelcomeCardQuestions
Array
欢迎卡片问题列表。
EnableStreamingOutput
Integer
流式输出开关。
0：关闭。
1：开启。
EnableFaq
Integer
问答库开关。
0：关闭。
1：开启。
EnableFile
Integer
文档库开关。
0：关闭。
1：开启。
EnableTaskFlow
Integer
任务流开关。
0：关闭。
1：开启。
ResponseMethodOutOfFaq
Integer
超出知识库后的回复方式。
1：实时 AI 生成。
2：固定兜底内容。
FallbackResponseContent
String
兜底回复内容。
EnableToAgent
Integer
转人工开关。
0：关闭。
1：开启。

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
描述
-7
参数解析失败，请检查请求包是否符合 JSON 规范或者请求参数符合要求。
-14
超过该接口允许的最大频率限制。
-20
请求需要 App 管理员权限。
-50003
智能客服资源无效。
-50040
请求应用未开通智能客服服务。

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考

查询单聊消息（v4/openim/admin_getroammsg）

联系我们

如果您在接入过程中有任何疑问，请用微信或企业微信扫码加入智能客服交流群进行咨询。

中国站