机器人
id 和令牌需要替换为自己的
获取令牌
获取机器人列表
GET /v1/robots
示例
Hamibot 示例
var res = http.request('https://api.hamibot.com/v1/robots', {
method: 'GET',
headers: {
authorization: '你的令牌(hmp 开头)',
},
});
log(res.body.json());
curl 示例
curl -H "Authorization: 你的令牌(hmp 开头)" \
https://api.hamibot.com/v1/robots
响应
200 成功
{
"count": 1,
"items": [
{
"_id": "a51d237e9af41ecc021c9ff6",
"online": true,
"tags": ["tag1", "tag2"],
"name": "零号机",
"brand": "Xiaomi",
"model": "MI 11"
}
]
}
获取机器人
GET /v1/robots/机器人id
示例
Hamibot 示例
var res = http.request('https://api.hamibot.com/v1/robots/机器人id', {
method: 'GET',
headers: {
authorization: '你的令牌(hmp 开头)',
},
});
log(res.body.json());
curl 示例
curl -H "Authorization: 你的令牌(hmp 开头)" \
https://api.hamibot.com/v1/robots/机器人id
响应
200 成功
{
"_id": "a51d237e9af41ecc021c9ff6",
"online": true,
"tags": ["tag1", "tag2"],
"name": "零号机",
"brand": "Xiaomi",
"model": "MI 11"
}
修改机器人
PUT /v1/robots/机器人id
参数
名称 | 类型 | 描述 |
---|---|---|
name | string | 机器人名字,最大长度 20 字符 |
tags | [string] | 机器人标签,标签最大长度 10 字符,标签数量最多 1 个 |
示例
curl 示例
curl \
-X PUT \
-H "Authorization: 你的令牌(hmp 开头)" \
-d '{"name": "新的机器人名字", "tags": ["新的标签"]}' \
https://api.hamibot.com/v1/robots/机器人id
响应
204 成功
停止所有脚本
PUT /v1/robots/机器人id/stop
示例
Hamibot 示例
http.request('https://api.hamibot.com/v1/robots/机器人id/stop', {
method: 'PUT',
headers: {
authorization: '你的令牌(hmp 开头)',
},
});
curl 示例
curl -X PUT -H "Authorization: 你的令牌(hmp 开头)" \
https://api.hamibot.com/v1/robots/机器人id/stop
响应
204 成功
消息推送
最低版本要求:Hamibot 1.2.2
前往下载
感谢 sl1097643327git 提交本功能
POST /v1/robots/机器人id/messages
参数
名称 | 类型 | 描述 |
---|---|---|
title | string | 标题,最大长度 128 |
text | string | 消息内容,最大长度 512 |
示例
Hamibot 示例
http.request('https://api.hamibot.com/v1/robots/机器人id/messages', {
method: 'POST',
contentType: 'application/json',
headers: {
authorization: '你的令牌(hmp 开头)',
},
body: JSON.stringify({ title: '标题', text: '消息内容' }),
});
curl 示例
curl \
-X POST \
-H "Authorization: 你的令牌(hmp 开头)" \
-H "Content-Type: application/json" \
-d '{"title": "标题", "text": "消息内容"}' \
https://api.hamibot.com/v1/robots/机器人id/messages
响应
204 成功