# 发送企业微信群消息 API
开始使用前,请先创建应用,申请开通短信邮件服务。
# 请求
POST https://apigate.glodon.com/colibri/api/qywx
1
# 说明
注意
发送频率限制:每个机器人发送的消息不能超过20条/分钟。
# header 参数
参数名 | 必选 | 类型 | 描述 |
---|---|---|---|
Authorization | 是 | String | Bearer app_access_token. 注:该 access_token 是应用级别 |
Content-Type | 是 | String | application/json |
# body 参数
参数名 | 必选 | 类型 | 描述 |
---|---|---|---|
msgtype | 是 | String | 消息类型,text/markdown 可选 |
content | 是 | String | 当msgtype=text是,此为文本内容,最长不超过2048个字节,必须是utf8编码;当msgtype=markdown时,此为markdown内容,最长不超过4096个字节,必须是utf8编码 |
robotKey | 是 | String | 群机器人的id key.假设webhook是:https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=693a91f6-7xxx-4bc4-97a0-0ec2sifa5aaa,则该值为 693a91f6-7xxx-4bc4-97a0-0ec2sifa5aaa |
注意
目前支持的markdown语法是如下的子集: ####1.标题 (支持1至6级标题,注意#与文字中间要有空格)
# 标题一
## 标题二
### 标题三
#### 标题四
##### 标题五
###### 标题六
1
2
3
4
5
6
2
3
4
5
6
# 2.加粗
**bold**
1
# 3.行内代码段(暂不支持跨行)
`code`
1
# 4.链接
[这是一个链接](https://aecore.glodon.com/doc)
1
# 5.引用
> 引用文字
1
# 6.字体颜色(只支持3种内置颜色)
<font color="info">绿色</font>
<font color="comment">灰色</font>
<font color="warning">橙红色</font>
1
2
3
2
3
# body 参数示例
{
"robotKey":"693a91f6-7xxx-4bc4-97a0-0ec2sifa5aaa",
"msgtype": "text",
"text": {
"content": "hello world"
}
}
或者
{
"robotKey":"693a91f6-7xxx-4bc4-97a0-0ec2sifa5aaa",
"msgtype": "markdown",
"markdown": {
"content": "实时新增用户反馈<font color=\"warning\">132例</font>,请相关同事注意。\n
>类型:<font color=\"comment\">用户反馈</font>
>普通用户反馈:<font color=\"comment\">117例</font>
>VIP用户反馈:<font color=\"comment\">15例</font>"
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# 响应
HTTP 代码 | 说明 | 类型 |
---|---|---|
200 | ok | 请求成功,根据业务 code 解析实际结果 |
401 | invalid_token | 请求头里面的 accessToken 无效 |
600 | 业务异常 | 业务异常 |
# HTTP 请求示例
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n\"robotKey\":\"693a91f6-7xxx-4bc4-97a0-0ec2sifa5aaa\",\n\"msgtype\": \"text\",\n \"text\": {\n \"content\": \"北京今日天气:29度,大部分多云,降雨概率:60%\" }\n}");
Request request = new Request.Builder()
.url("https://apigate.glodon.com/colibri/api/qywx")
.post(body)
.addHeader("authorization", "bearer cn-110xxxxx-caa9-4237-b8c2-0df1af4xxxxx")
.addHeader("content-type", "application/json")
.build();
Response response = client.newCall(request).execute();
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
curl -X POST \
https://apigate.glodon.com/colibri/api/qywx \
-H 'authorization: bearer cn-110xxxxx-caa9-4237-b8c2-0df1af4xxxxx' \
-H 'content-type: application/json' \
-d '{
"robotKey":"693a91f6-7xxx-4bc4-97a0-0ec2sifa5aaa",
"msgtype": "text",
"text": {
"content": "北京今日天气:29度,大部分多云,降雨概率:60%"
}
}'
1
2
3
4
5
6
7
8
9
10
11
2
3
4
5
6
7
8
9
10
11
# 成功返回结果
{
"code": 40000,
"error": "OK",
"description": "OK"
}
1
2
3
4
5
2
3
4
5
# 异常返回结果
{"code":40100,"error":"colibri.unauthorized","description":"认证失败"}
{"code":40200,"error":"colibri.oauth.scope.error","description":"没有分配权限"}
{"code":40202,"error":"colibri.invalid.template.id","description":"无效的模板ID"}
{ "error": "invalid_token", "error_description": "cn-24b92d2f-66cc-45d2-8e8b-e08916bca2d62"}
1
2
3
4
2
3
4
← 发送邮件 API