助手
扣子 AI 帮助与支持
你好,我是 扣子 文档问答助手 🎉 你在阅读当前文档的过程中,无论对文档概念的解释,还是文档内容方面的疑问,都可以随时向我提问,我会全力为你解答
推荐问题
如何快速了解这个空间的核心内容?
有哪些近期更新的重点文档?
我应该从哪些文档开始阅读?
文档反馈
低代码项目
快速开始
智能体
工作流
应用
资源
发布
模型
多人协作
开发工具
Coze CLI
API 参考
鉴权
智能体和应用
工作空间
文件夹
企业/组织
会话与消息
对话
工作流
文件
智能音视频
知识库
数据库
插件
变量
用量限额
账单与权益
回调
API 教程
SDK 参考
音视频
推广与变现

绑定设备

更新于: 2026-06-25 19:29:14

将设备与自定义渠道绑定。

接口描述

硬件厂商可以调用本 API 将企业内的硬件设备与企业的自定义渠道绑定,当开发者发布智能体到该自定义渠道时,在发布配置页面的设备列表中选择对应的设备,即可快速发布到对应设备。
支持批量绑定多台设备。

说明

创建自定义渠道后,默认未开启 API 绑定设备的能力,如果需要调用本 API,你需要将自定义渠道的渠道 ID 提供给扣子商务经理,申请开通渠道设备绑定的能力,并由商务经理配置设备绑定的 key。

基础信息

请求方式

POST

请求地址

https://api.coze.cn/v1/connectors/:connector_id/user_configs

权限

bindConnectorConfig
确保调用该接口使用的访问令牌开通了 bindConnectorConfig 权限,详细信息参考准备工作

接口说明

将设备与自定义渠道绑定。

请求参数

参数

取值

说明

Authorization

Bearer $Access_Token

用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌,详细信息,参考准备工作

Content-Type

application/json

解释请求正文的方式。

Path

参数

类型

是否必选

示例

说明

connector_id

String

必选

745264392345******

企业自定义渠道的渠道 ID。
自定义渠道 ID 的获取方式如下:在扣子编程左下角单击头像,在账号设置 > 发布渠道 > 企业自定义渠道管理页面查看渠道 ID。自定义渠道入驻扣子编程的方式可参考渠道入驻文档。

Body

参数

类型

是否必选

示例

说明

configs

Array of UserConfig

必选

[{“key”:“device_id”,“enums”:[{“label”:“设备123”,“value”:“1237824***”}]}]

设备配置信息列表。

user_id

String

可选

4497462571***

智能体开发者的扣子用户 UID,用于标识设备绑定的扣子用户。
你可以单击扣子编程左下角的头像,选择账号设置,在页面底部查看扣子用户的 UID。

UserConfig

参数

类型

是否必选

示例

说明

key

String

必选

device_id

参数的键值,需要与提供给商务经理的 key 保持一致,用于标识设备配置信息的具体类型。

enums

Array of UserConfigEnum

必选

[{“label”:“设备123”,“value”:“1237824***”}]

设备信息的数组,可以批量添加该渠道中的所有设备。

UserConfigEnum

参数

类型

是否必选

示例

说明

label

String

必选

智能音箱-客厅

设备的显示名称,用于在用户界面中标识设备,方便用户识别和管理。

value

String

必选

51237824***

设备的 ID。

返回参数

参数

类型

示例

说明

code

Long

0

调用状态码。0 表示调用成功,其他值表示调用失败,你可以通过 msg 字段判断详细的错误原因。

msg

String

“”

状态信息。API 调用失败时可通过此字段查看详细错误信息。
状态码为 0 时,msg 默认为空。

detail

Object of ResponseDetail

{“logid”:“20241210152726467C48D89D6DB2****”}

包含请求的详细信息的对象,主要用于记录请求的日志 ID 以便于排查问题。

ResponseDetail

参数

类型

示例

说明

logid

String

20241210152726467C48D89D6DB2****

本次请求的日志 ID。如果遇到异常报错场景,且反复重试仍然报错,可以根据此 logid 及错误码联系扣子团队获取帮助。详细说明可参考获取帮助和技术支持

示例

请求示例

curl --location --request POST 'https://api.coze.cn/v1/connectors/745264392345******/user_configs' \
--header 'Authorization: Bearer pat_xitq****' \
--header 'Content-Type: application/json' \
--data-raw '{
    "configs": [
        {
            "key": "device_id",
            "enums": [
                {
                    "label": "智能音箱-客厅",
                    "value": "51237824***"
                },
                {
                    "label": "智能音箱-主卧",
                    "value": "51237825***"
                }
            ]
        }
    ]
}'

返回示例

{
  "detail": {
    "logid": "20241029152003BC531DC784F1897B****"
  },
  "code": 0,
  "msg": ""
}

错误码

如果成功调用扣子编程的 API,返回信息中 code 字段为 0。如果状态码为其他值,则表示接口调用失败。此时 msg 字段中包含详细错误信息,你可以参考错误码文档查看对应的解决方法。