友米聚合 - 开放API
  1. BulkSend
友米聚合 - 开放API
  • 应用场景
    • 自有订单系统 嵌入 企客聊侧边栏
  • v1
    • 文档
      • 介绍
        • 开发文档阅读说明
        • 错误码返回说明
      • 入门说明
        • 生成signature
        • 获取TOKEN方法
        • 请求Headers说明
      • 接口详情
        • 基础数据类接口
        • 数据读取类接口
        • 行为操作类接口
        • 回调数据
  • v2
    • 事件发布格式说明
    • ChatMess
      • 发送消息
      • 申请接管
      • 终止接管
      • 激活会话
      • 发送通知
      • 读取聊天记录
    • Report
      • 获取员工客服统计
      • 获取员工激活客户数统计
    • System
      • 获取部门列表
      • 根据部门获得组
      • 根据组获得员工
      • 获得员工列表
    • Friend
      • 读取粉丝列表
      • 读取粉丝总数
    • Todo
      • 新增待办记录
      • 新增待办记录(返回编号)
      • 获取待办列表
      • 获取待办列表总数
    • Ad
      • 读取广告列表
      • 读取广告条数
    • BulkSend
      • 保存RPA群发
        POST
      • 删除RPA群发
        POST
    • 注册回调地址
      POST
    • 订阅事件
      POST
    • 获取商户TOKEN
      POST
  1. BulkSend

保存RPA群发

开发中
POST
/v2/BulkSend/SaveBulkSendTask

task_content 格式:#

[
  // 文本格式
  {
    "data": {
      "content": "123"
    },
    "type": "0"//文本
  },
  // 图片格式
  {
    "data": {
      "imgName": "微信图片_20210302111815.png",
      "imgFormat": "png",
      "imgMediaUrl": "http://ttimg.yunshouzhi.net/640462692/taskRes/1731296918605_YZ6mxXw4.png?cos=3"
    },
    "type": "1"//图片
  },
  // 视频格式
  {
    "data": {
      "videoName": "video(5).mp4",
      "videoFormat": "mp4",
      "videoMediaUrl": "http://ttimg.yunshouzhi.net/640462692/taskRes/1731296925628_bhQrsirs.mp4?cos=3"
    },
    "type": "2"//视频
  },
  // 链接格式
  {
    "data": {
      "title": "xxx",
      "linkUrl": "http://baidu.com/",
      "description": "ddd",
      "thumbMediaUrl": "http://ttimg.yunshouzhi.net/640462692/taskRes/1731296934394_awDYwYsT.png?cos=3"
    },
    "type": "3"//链接
  },
  // 文件格式
  {
    "data": {
      "fileName": "video(15).mp4",
      "fileFormat": "mp4",
      "fileMediaUrl": "http://ttimg.yunshouzhi.net/640462692/taskRes/1731296956880_6xMiXaxX.mp4?cos=3"
    },
    "type": "4"//文件
  },
  // 群共享格式
  {
    "data": {
      "flag": "flag:000022",
      "roomId": "46218981780@chatroom",
      "msgType": "6",
      "roomName": "8.22群共享",
      "wechatId": 3430,
      "wechatLei": 0
    },
    "type": "30"//群共享
  }
]

chooseLabel(标签群发选择的标签,包含的标签) 格式:#

[
  {
    "ad_label_id": 262,
    "ad_label_info_id": 1317,
    "ad_label_info_name": "测试"
  }
]

task_content(标签群发选择的标签,排除标签) 格式:#

[
  {
    "ad_label_id": 262,
    "ad_label_info_id": 1317,
    "ad_label_info_name": "测试"
  }
]

请求参数

Header 参数
Authorization
string 
可选
授权TOKEN,Bearer
TenantId
string 
可选
租户ID,仅限代理商使用
Body 参数application/json
bulksend
object 
必需
task_theme
string 
群发主题
必需
task_type
integer 
必需
任务类型(;0=即时、1=定时)
choose_type
integer 
必需
选择类型(按好友选择 = 0, 按标签选择 = 1,按群组选择 = 2)
start_time
string 
必需
发送时间,定时任务必选,精确到秒的时间戳
task_content
string 
必需
任务内容(传入格式详情看说明)JSON转换成字符串
task_exec_type
integer 
可选
执行方式(0=RPA、1=优先使用企微群发助手执行
ad_is_freeze
integer 
可选
是否开启冻结时段(0不开启,1开启)
freeze_start
number 
可选
冻结开始时间(从零点开始到选择时间的相隔的秒)
freeze_end
number 
可选
冻结结束时间(从零点开始到选择时间的相隔的秒)
listMass
array [object {3}] 
选择的群发对象
必需
ad_wechat_id
integer 
运营机编号
必需
object_id
number 
必需
对象标识(好友的编号,选择好友或者群群发必传)
belong_staff_code
string 
必需
所属员工(好友归属员工。选择好友或者群群发必传)
chooseLabel
string 
可选
群发标签选择的标签(标签群发必选)JSON转换成字符串
labelFilterType
integer 
可选
标签筛选方式(0=默认匹配:同分类标签部分匹配,跨分类标签完全匹配, 1=部分匹配:匹配所选标签之一即可,2=完整匹配:必须匹配所有选择标签
excludeLabel
string 
可选
群发标签排除的标签(JSON转换成字符串)
示例
{
  "bulksend": {
    "task_theme": "测试2",
    "task_type": 1,
    "choose_type": 0,
    "start_time": "1734624000",
    "task_source": 0,
    "task_content": "[{\"data\":{\"content\":\"test12345\"},\"type\":\"0\"}]"
  },
  "listMass": [
    {
      "ad_wechat_id": 45292,
      "machine_key": "zvzv9223",
      "machine_name": "P01",
      "qv_company_id": "",
      "object_id": "2716475",
      "object_nickname": "利芝",
      "belong_staff_code": "hex"
    }
  ],
  "chooseLabel": ""
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/BulkSend/SaveBulkSendTask' \
--header 'Authorization;' \
--header 'TenantId;' \
--header 'Content-Type: application/json' \
--data-raw '{
	"bulksend": {
		"task_theme": "测试2",
		"task_type": 1,
		"choose_type": 0,
		"start_time": "1734624000",
		"task_source": 0,
		"task_content": "[{\"data\":{\"content\":\"test12345\"},\"type\":\"0\"}]"
	},
	"listMass": [{
		"ad_wechat_id": 45292,
		"machine_key": "zvzv9223",
		"machine_name": "P01",
		"qv_company_id": "",
		"object_id": "2716475",
		"object_nickname": "利芝",
		"belong_staff_code": "hex"
	}],
	"chooseLabel": ""
}'

返回响应

🟢200成功
application/json
Body
requestId
string 
必需
errmsg
integer 
必需
succeed
boolean 
必需
msgTime
string 
必需
values
object 
必需
ad_bulk_send_id
integer 
必需
RPA群发编号,大于0则成功,否则失败
failFriend
array[string]
必需
失败的群发列表(选择群发好友或者群发组返回,如果运营机不存在则不返回该运营机的错误数据)
errdesc
null 
必需
示例
{
  "requestId": "bd8b326b-481a-46c9-aade-2002bfe7c9f0",
  "errmsg": 20000,
  "succeed": true,
  "msgTime": "2024-12-19T17:21:51.6355932+08:00",
  "values": 880,
  "errdesc": null
}
上一页
读取广告条数
下一页
删除RPA群发
Built with