注册设备
更新时间: 2025/10/31 15:51:13
注册设备,绑定用户 ID 和 Agent 到设备 ID,实现设备与用户的关联管理。
请求信息
请求 URI
POST https://rtc-agent.yunxinapi.com/v1/device/register
请求头参数
请求 Header 的参数说明请参考 请求结构。
请求体参数
| 参数名称 | 类型 | 是否必选 | 示例 | 说明 |
|---|---|---|---|---|
| agentId | String | 是 | agent123 | agent ID,用于标识特定的智能体实例 |
| deviceId | String | 是 | device123 | 设备 ID,最多 64 个字符,支持字母、数字、".-_:#()[]"等字符 |
| userId | String | 是 | user123456 | 用户 ID,需要先创建该用户。最大长度 32 字节,只允许字母、数字以及 "_@.-" |
| - customProperties | Array | 否 | - | 设备的自定义属性,用于在 MCP 调用中传递设备信息 |
| key | String | 否 | deviceType | 自定义属性的名称,最多 32 个字符,字符只能是 a-zA-Z0-9 以及 - _ |
| value | String | 否 | smartSpeaker | 自定义属性的值,最多 64 个字符 |
请求体示例
JSON{
"agentId": "agent123",
"deviceId": "device123",
"userId": "user123456",
"customProperties": [
{
"key": "deviceType",
"value": "smartSpeaker"
},
{
"key": "location",
"value": "livingRoom"
}
]
}
响应信息
响应参数
| 参数名称 | 类型 | 说明 | 是否必返回 |
|---|---|---|---|
| code | Integer | 状态码,200 表示请求成功 | 是 |
| message | String | 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。 | 是 |
| requestId | String | 请求的唯一标识 ID | 是 |
| data | Object | 响应数据,注册操作成功时为 null | 否 |
| success | Boolean | 操作是否成功 | 是 |
响应体示例
JSON{
"code": 200,
"message": "操作成功",
"requestId": "ai56f35572d3174c45b2ce383297e1847a",
"data": null,
"success": true
}
此文档是否对你有帮助?




