发送应用消息到企业微信
发送应用消息到企业微信
请求方式: POST(HTTPS)
请求地址: https://open.wshoto.com/openapi/qyapi/message/send
Query参数:
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
access_token | string | 是 | 调用接口凭证 |
消息类型: 文本消息、文本卡片消息
Body参数:
{
"to_user": "YiZhong",
"to_party": "",
"to_tag": "",
"msg_type": "text",
"title": "这是一个标题",
"description": "这是一个描述",
"content":"这是一个内容",
"url": "",
"btn_txt": "详情",
"app_id": "123123",
"page": "https://wwww.baidu.com",
"enable_id_trans": 0,
"enable_duplicate_check": 0,
"duplicate_check_interval": 100
}
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
to_user | string | 否 | 指定接收消息的成员,成员ID列表,多个接收者用'|'分隔,最多支持1000个。 |
to_party | string | 否 | 指定接收消息的部门,部门ID列表,多个接收者用'|'分隔,最多支持100个。 |
to_tag | string | 否 | 指定接收消息的标签,标签ID列表,多个接收者用'|'分隔,最多支持100个。 |
msg_type | string | 是 | 消息类型 文本消息:text,文本卡片消息:textcard |
title | string | 否 | 标题,不超过128个字节,超过会自动截断 |
description | string | 否 | 描述,不超过512个字节,超过会自动截断 |
content | string | 否 | 内容,不超过2048个字节,超过会自动截断 |
url | string | 否 | 点击后跳转的链接。最长2048字节,请确保包含了协议头(http/https) |
btn_txt | string | 否 | 按钮文字。 默认为“详情”, 不超过4个文字,超过自动截断。 |
enable_id_trans | Int | 否 | 表示是开启id转译,0表示,1表示是,默认0。 |
enable_duplicate_check | Int | 否 | 表示是开启重复消息检查,0表示,1表示是,默认0 |
duplicate_check_interval | Int | 否 | 表示是重复消息检查的时间间隔,默认1800s,最大不超过4小时 |
消息类型: 图文消息
Body参数:
{
"to_user": "YiZhong",
"to_party": "",
"to_tag": "",
"msg_type": "text",
"articles": [{
"title": "这是一个标题",
"description": "这是一个描述",
"url": "",
"pic_url": ""
}],
"app_id": "123123",
"page": "/page",
"enable_id_trans": 0,
"enable_duplicate_check": 0,
"duplicate_check_interval": 100
}
参数 | 类型 | 必填 | 说明 |
---|---|---|---|
to_user | string | 否 | 指定接收消息的成员,成员ID列表,多个接收者用'|'分隔,最多支持1000个。 |
to_party | string | 否 | 指定接收消息的部门,部门ID列表,多个接收者用'|'分隔,最多支持100个。 |
to_tag | string | 否 | 指定接收消息的标签,标签ID列表,多个接收者用'|'分隔,最多支持100个。 |
msg_type | string | 是 | 消息类型 图文消息:news |
articles | array | 是 | |
title | string | 否 | 标题,不超过128个字节,超过会自动截断 |
description | string | 否 | 描述,不超过512个字节,超过会自动截断 |
url | string | 否 | 点击后跳转的链接。最长2048字节,请确保包含了协议头(http/https) |
pic_url | string | 否 | 图片链接 |
enable_id_trans | Int | 否 | 表示是开启id转译,0表示,1表示是,默认0。 |
enable_duplicate_check | Int | 否 | 表示是开启重复消息检查,0表示,1表示是,默认0 |
duplicate_check_interval | Int | 否 | 表示是重复消息检查的时间间隔,默认1800s,最大不超过4小时 |
注意事项:
to_user、to_party、to_tag不能同时为空
文本消息:content为必填字段
文本卡片消息:description为必填字段,title为必填字段
返回值:
{
"code": 0,
"msg": "请求成功",
"data": {
"invalid_user": null,
"invalid_party": null,
"invalid_tag": null,
"msg_id": "fcLc6UhB2absSaoEDgOVFBnSTAvw301AsDkCm49f3q2FGGcDZOAvZ0TcKohM4ze5uf5bBoM0Zga717G92SOUTw",
"response_code": null
}
}
参数说明:
参数 | 类型 | 说明 |
---|---|---|
code | int | 返回码,0-请求成功, |
msg | string | 对返回码的文本描述内容 |
data | long | 敏感词组id |
invalid_user | string | 无效的用户 |
invalid_party | string | 无效方 |
invalid_tag | string | 无效标签 |
msg_id | string | 消息ID |
response_code | string | 响应Code |