批量发送消息

给多个用户或者多个部门发送消息。

注意事项:

• 频控说明
• 应用需要启用机器人能力
• 只能发送给用户，无法发送给群组（群聊）
• 接口权限说明：
  • 必须拥有[API]批量发送单聊消息权限
  • [API]批量发送单聊消息，权限可能存在于多个权限组，开通不同的权限组生效范围不同
  • [权限组]批量向用户发送消息，用于给用户发送批量消息
  • [权限组]批量向部门发送消息，用于给部门发送批量消息
• 应用需要拥有对所发送用户或部门的可用性
• 通过该接口发送的消息 不支持更新以及回复等变更操作
• 异步接口，会有一定延迟，每个应用待发送的消息按顺序处理，请合理安排批量发送范围和顺序。发送消息给单个用户的场景请使用发送消息接口
• 单个应用每天通过该接口发送的总消息条数不超过50万

请求

基本
HTTP URL	https://hi-gw.weizhipin.com/open-apis/im/v2/batch_send
HTTP Method	POST
支持的应用类型	自建应用 商店应用
权限要求 根据发送目标申请相应权限	批量向用户发送消息 批量向部门发送消息

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560"
Content-Type	string	是	固定值："application/json; charset=utf-8"

请求体

参数	类型	必填	描述
msg_type	string	是	消息类型，支持多种消息类型。
content	object	否	消息内容，具体格式见下面示例。
department_ids	list	否	支持自定义部门ID，和open_department_id，列表长度小于等于 200，部门Id列表和用户ID列表必须填一个 注：部门下的所有子部门包含的成员也会收到消息 示例值：["3dceba33a33226","d502aaa9514059", "od-5b91c9affb665451a16b90b4be367efa"] 部门ID和用户ID不能同时为空
user_ids	list	否	用户 user_id 列表，长度小于等于 200，部门Id列表和用户ID列表必须填一个 示例值：["1234"] 注：部门ID与用户ID与open_id与union_id不能同时为空
open_ids	list	否	用户 open_id 列表，长度小于等于 200，部门Id列表和用户ID列表必须填一个 示例值：["7cdcc7c2","ca51d83b"] 注：部门ID与用户ID与open_id与union_id不能同时为空
union_ids	list	否	用户 union_id 列表，长度小于等于 200，部门Id列表和用户ID列表必须填一个 示例值：["7cdcc7c2","ca51d83b"] 注：部门ID与用户ID与open_id与union_id不能同时为空
uuid	string	否	由开发者生成的唯一字符串序列，用于发送消息请求去重；持有相同uuid的请求1小时内至多成功执行一次 示例值："a0d69e20-1dd1-458b-k525-dfeca4015204" 数据校验规则： 最大长度：50 字符

请求体实例

普通消息

{
    "content": "{\"text\":\" test content\"}",
    "msg_type": "text",
    "department_ids":["010402"],
    "user_ids":["3430","11111111392"],
  "uuid":"a0d69e20-1dd1-458b-k525-dfeca4015204"
}

消息卡片(compressive_card)

新的卡片消息，持续迭代中资源介绍

{
  "content": "{    \"header\": {        \"text\": {            \"content\": \"多文本1\",            \"tag\": \"plain_text\"        },        \"color\": \"white\"    },    \"cardLink\": {        \"url\": \"https://hi.zhipin.com\",        \"pcUrl\": \"https://www.4399.com\",        \"androidUrl\": \"\",        \"iosUrl\": \"\"    },    \"globalConfig\": {        \"forward\": false,        \"shareCard\": true    },    \"modules\": [        {            \"tag\": \"split_line\"        },        {            \"fields\": [                {                    \"text\": {                        \"content\": \"多文本1\",                        \"tag\": \"plain_text\"                    },                    \"needLayout\": true                },                {                    \"text\": {                        \"content\": \"多文本2\",                        \"tag\": \"plain_text\"                    },                    \"needLayout\": true                },                {                    \"text\": {                        \"content\": \"多文本3\",                        \"tag\": \"plain_text\"                    },                    \"needLayout\": true                },                {                    \"text\": {                        \"content\": \"多文本4\",                        \"tag\": \"plain_text\"                    },                    \"needLayout\": true                }            ],            \"extra\": {                \"text\": {                    \"content\": \"按钮中展示的文本\",                    \"tag\": \"plain_text\"                },                \"multiUrl\": {                    \"url\": \"https://hi.zhipin.com\",                    \"pcUrl\": \"https://www.4399.com\",                    \"androidUrl\": \"\",                    \"iosUrl\": \"\"                },                \"callBacks\": [                    {                        \"key\": \"click1\",                        \"value\": \"1\"                    }                ],                \"confirm\": {                    \"title\": {                        \"content\": \"弹窗标题\",                        \"tag\": \"plain_text\"                    },                    \"text\": {                        \"content\": \"弹窗内容\",                        \"tag\": \"plain_text\"                    }                },                \"type\": \"primary\",                \"tag\": \"button\"            },            \"arrange\": \"bisected\",            \"tag\": \"div\"        },        {            \"actions\": [                {                    \"text\": {                        \"content\": \"按钮中展示的文本1\",                        \"tag\": \"plain_text\"                    },                    \"multiUrl\": {                        \"url\": \"https://hi.zhipin.com\",                        \"pcUrl\": \"https://www.4399.com\",                        \"androidUrl\": \"\",                        \"iosUrl\": \"\"                    },                    \"callBacks\": [                        {                            \"key\": \"click1\",                            \"value\": \"1\"                        }                    ],                    \"confirm\": {                        \"title\": {                            \"content\": \"弹窗标题\",                            \"tag\": \"plain_text\"                        },                        \"text\": {                            \"content\": \"弹窗内容\",                            \"tag\": \"plain_text\"                        }                    },                    \"needLayout\": true,                    \"type\": \"primary\",                    \"tag\": \"button\"                },                {                    \"text\": {                        \"content\": \"按钮中展示的文本2\",                        \"tag\": \"plain_text\"                    },                    \"multiUrl\": {                        \"url\": \"https://hi.zhipin.com\",                        \"pcUrl\": \"https://www.4399.com\",                        \"androidUrl\": \"\",                        \"iosUrl\": \"\"                    },                    \"callBacks\": [                        {                            \"key\": \"click1\",                            \"value\": \"1\"                        }                    ],                    \"confirm\": {                        \"title\": {                            \"content\": \"弹窗标题\",                            \"tag\": \"plain_text\"                        },                        \"text\": {                            \"content\": \"弹窗内容\",                            \"tag\": \"plain_text\"                        }                    },                    \"type\": \"primary\",                    \"tag\": \"button\"                },                {                    \"text\": {                        \"content\": \"按钮中展示的文本3\",                        \"tag\": \"plain_text\"                    },                    \"multiUrl\": {                        \"url\": \"https://hi.zhipin.com\",                        \"pcUrl\": \"https://www.4399.com\",                        \"androidUrl\": \"\",                        \"iosUrl\": \"\"                    },                    \"callBacks\": [                        {                            \"key\": \"click1\",                            \"value\": \"1\"                        }                    ],                    \"confirm\": {                        \"title\": {                            \"content\": \"弹窗标题\",                            \"tag\": \"plain_text\"                        },                        \"text\": {                            \"content\": \"弹窗内容\",                            \"tag\": \"plain_text\"                        }                    },                    \"type\": \"primary\",                    \"tag\": \"button\"                }            ],            \"arrange\": \"bisected\",            \"tag\": \"actions\"        }    ]}",
  "msg_type": "compressive_card",
  "department_ids":["010402"],
  "user_ids":["3430","11111111392"],
  "uuid":"a0d69e20-1dd1-458b-k525-dfeca4015204"
}

图文卡片消息

用图片v2接口上传图片，来获取图片链接内容参数格式详情见 发送消息

{
  "receive_id": "11111111436",
  "content": "{\"browser\":0,\"noHead\":0,\"originImage\":{\"height\":828,\"url\":\"https://bosshi-admin-qa.weizhipin.com/api/media/download/Tcr7RJo4E7SzvrcXD5SoFS_zTrppKu1AkwBIXJQLrMhHi1JTRGYL.JPG\",\"width\":1242},\"text\":\"test message\"}",
  "msg_type": "image_card",
  "uuid":"a0d69e20-1dd1-458b-k525-dfeca4015204"
}

图片消息

用图片v2接口上传图片

{
  "content": "{\"originImage\":{\"height\":2160,\"url\":\"https://bosshi-admin-qa.weizhipin.com/api/media/download/TsH7SJs0E7OztL1PZZX9LB7zPMFJGPQszlAvaYRYhqcq_zlUQ00W_NCjEv0UUc-2mw~~.PNG\",\"width\":1080},\"tinyImage\":{\"height\":300,\"url\":\"https://bosshi-admin-qa.weizhipin.com/api/media/download/TsH7SJs0E7OztL1PZZX9LB7zPMFJGPQszlAvaYRYhqcq_zlUQ00W_NCjEv0UUc-2mw~~_s139.jpg\",\"width\":150}}",
  "msg_type": "image",
  "department_ids":["010402"],
  "user_ids":["3430","11111111392"],
  "uuid":"a0d69e20-1dd1-458b-k525-dfeca4015204"
}

文件消息

用文件v2接口上传文件，来获取文件链接，大小等参数。

{
  "receive_id": "11111111435",
  "content": "{\"size\":10391599,\"name\":\"研发安全培训-202210.pdf\",\"url\":\"https://bosshi-admin-qa.weizhipin.com/api/media/download/TsH6QJkxE7Wz0r1MD-qWQHHOUK10doJBmQ9IZIQPhvgq5idyfGw__K6eRf8cb5E~.pdf\"}",
  "msg_type": "file",
  "uuid":"a0d69e20-1dd1-458b-k525-dfeca4015204"
}

音频消息

用文件v2接口上传文件，来获取语音文件链接，大小等参数。

{
  "receive_id": "11111111435",
  "content": "{\"duration\":14,\"transText\":\"test\",\"size\":14412,\"transType\":2,\"url\":\"https://hi.zhipin.com/api/media/download/TsD7RJk2E7azkr1PYZX-Ehb6UMt0Ke0RmVQna-lgkshF4TxTWnIW3cDOfKgeAsPfkoEv.amr\"}",
  "msg_type": "audio",
  "uuid":"a0d69e20-1dd1-458b-k525-dfeca4015204"
}

响应体

参数	类型	说明
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	-	-
∟message_id	string	批任务-ID-非消息ID
∟invalid_department_ids	list	不合法的部门 ID 列表
∟invalid_user_ids	list	不合法的 user_id 列表
∟invalid_open_ids	list	不合法的 open_id 列表
∟invalid_union_ids	list	不合法的 union_id 列表

响应体示例

{
    "code": 0,
    "traceId": "_Ao59UOIBLPCeAAu",
    "msg": "ok",
    "data":{
      "invalid_department_ids": [
          "d502aaa9514059"
      ],
      "invalid_user_ids": ["7cdcc7c22"],
      "message_id": "bm-d4be107c616aed9c1da8ed8068570a9f"
      }
}

错误码