云湖开放文档

Appearance

On this page

机器人批量发送消息 ​

请求URL ​

https://chat-go.jwzhd.com/open-apis/v1/bot/batch_send?token=xxxxxxxxxx

请求示例 ​

curl --location --request POST 'https://chat-go.jwzhd.com/open-apis/v1/bot/batch_send?token=xxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "recvIds": ["7058262", "7058263"],
    "recvType": "user",
    "contentType": "text",
    "content": {
        "text": "这里是消息内容"
    }
}'

请求头 ​

Content-Type: "application/json; charset=utf-8"

请求参数 ​

字段名类型是否必填说明
recvIdslist是接收消息对象ID列表，用户为userIds，群组为groupIds
recvTypestring是接收对象类型，取值为user或group
contentTypestring是消息类型，取值包括text、image、file、markdown
contentContent对象是消息内容对象

Content对象 ​

contentType为text ​

字段类型是否必填说明
textstring是消息正文
buttonsButton对象列表否消息中包括button

contentType为image ​

字段名类型是否必填说明
imageUrlstring是图片 URL
buttonsButton 列表否消息中包含的 Button 对象列表

contentType为markdown ​

字段名类型是否必填说明
textstring是Markdown 格式字符串
buttonsButton 列表否消息中包含的 Button 对象列表

contentType为file ​

字段名类型是否必填说明
fileNamestring是文件名
fileUrlstring是文件 URL
buttonsButton 列表否消息中包含的 Button 对象列表

Button对象 ​

字段名类型是否必填说明
textstring是按钮上的文字
actionTypeint是动作类型，取值为 1、2、3，分别表示跳转 URL、复制、点击汇报
urlstring否当 actionType 为 1 时使用，表示要跳转的 URL
valuestring否当 actionType 为 2 时使用，该值会被复制到剪贴板；当 actionType 为 3 时使用，该值会被发送给订阅端

响应内容 ​

字段名类型说明
codeint响应代码
messagestring响应信息，包括异常信息
dataObject返回数据
json
{
  "recvIds": [
    "7058262",
    "7058263"
  ],
  "recvType": "user",
  "contentType": "text",
  "content": {
    "text": "这里是消息内容",
    "buttons": [
      [
        {
          "text": "复制",
          "actionType": 2,
          "value": "xxxx"
        },
        {
          "text": "点击跳转",
          "actionType": 1,
          "url": "http://www.baidu.com"
        }
      ]
    ]
  }
}