营销自动化

大约 3 分钟

营销自动化

添加群发任务接口

描述
群发 API 接口
URI
/wscrm-bus-api/open/mark/batchAdd
请求方式
POST、Content-Type: application/json
请求参数说明

参数名	类型	是否必填	备注
tenantId	Long	是	公司编号(联系管理员获取)
userName	String	是	管理员账号
data	List	是	格式[{},{}],详细如下(数量 0-50 条)
token	String	是	token
createTime	String	是	创建时间

data参数说明

参数名	类型	是否必填	备注
name	String	是	任务名称
executor	List	是	执行人
reachedNum	Integer	否	可执行陌生人员数量
customerGroupKey	Integer	是	客群类型 0 客户阶段 1 客户标签 2 群聊
customerGroupValue	String	是	客群或标签名称或指定客服号_群名称
startTime	String	否	任务开始时间(yyyy-mm-dd)
contentType	Integer	是	1 不存在文件 2 图片 3 视频 4 其他文档类型
content	String	是	发送内容(不论 contentType 必须存在内容)
type	Integer	是	任务类型 1 直接执行 2 排期发送(根据 startTime)
fileName	String	否	文件名称
fileUrl	String	否	文件 url
sendTimeMin	Integer	是	发送最小间隔时间(s)
sendTimeMax	Integer	是	发送最大间隔时间(s)

请求示例

{
  "tenantId": 82,
  "userName": "kubrick",
  "token": "48ac86f77f26e4719a62d3b2c569a67b",
  "createTime": "2021-03-08 14:25:00",
  "data": [
    {
      "name": "open-Api-task-01",
      "executor": "[lsl001]",
      "reachedNum": 10,
      "customerGroupKey": 0,
      "customerGroupValue": "需求匹配",
      "contentType": 1,
      "content": "open-Api-test",
      "type": 1,
      "startTime": "",
      "fileName": "",
      "fileUrl": "",
      "sendTimeMin": 1,
      "sendTimeMax": 10
    },
    {
      "name": "open-Api-task-02",
      "executor": "[lsl001]",
      "reachedNum": 10,
      "customerGroupKey": 2,
      "customerGroupValue": "2348134513901_自动化群",
      "contentType": 1,
      "content": "open-Api-test",
      "type": 1,
      "startTime": "",
      "fileName": "",
      "fileUrl": "",
      "sendTimeMin": 1,
      "sendTimeMax": 10
    }
  ]
}

响应参数说明
参数名类型是否必填示例值备注
code int 是 200 状态码
message String 否成功描述
data String 否 [] 数据
data参数说明
参数名类型是否必填示例值备注
tenantId Integer 是 1 公司 id
taskList List 是任务基本信息及回调 id
请求示例

参数名	类型	是否必填	示例值	备注
code	int	是	200	状态码
message	String	否	成功	描述
data	String	否	[]	数据

参数名	类型	是否必填	示例值	备注
tenantId	Integer	是	1	公司 id
taskList	List	是		任务基本信息及回调 id

{
  "code": 200,
  "message": "Success",
  "data": {
    "tenantId": 520274,
    "taskList": [
      {
        "taskId": 6275,
        "name": "open-Api-task-01"
      },
      {
        "taskId": 6276,
        "name": "open-Api-task-02"
      }
    ]
  }
}

任务执行完成后会进行回调所配置的 url 接口 , 表示该任务已经执行完毕。任务 taskId 及 name 自行对应

回调接口

回调请求需要在 webhook 配置信息中添加 ma 类型,即可进行回调

请求参数说明

参数名	类型	是否必填	备注
tenantId	Long	是	公司id
callBackUrl	String	是	查询执行详情接口
userName	String	是	管理员账号)
data	List	是	格式[{},{}],详细如下
token	String	是	token
createTime	String	是	创建时间

请求示例

{
  "tenantId": 520274,
  "userName": "lsl001",
  "createTime": "2022-11-15 20:50:17",
  "token": "a0ca798be85c3200e9f73ed7e5c952c1",
  "callBackUrl": "192.168.2.23:10003/wscrm-bus-api/open/mark/record",
  "data": [
    {
      "taskId": 6275,
      "name": "open-Api-task-01"
    },
    {
      "taskId": 6276,
      "name": "open-Api-task-02"
    }
  ]
}

查询执行详情接口

URI
/wscrm-bus-api/open/mark/record
请求方式
POST、Content-Type: application/json
请求参数说明

参数名	类型	是否必填	备注
tenantId	Integer	是	公司 id
createTime	String	是	创建时间 (yyyy-MM-dd HH:mm:ss)
userName	String	是	昵称(为管理员登录账号)
token	String	是	签名字符串 token
data	List	是	查询任务列表

请求示例

{
  "tenantId": 500975,
  "createTime": "2022-11-15 20:50:17",
  "token": "cb2809b756cb2b2c47dd22581e832e0a0a204299787499ef405ebfa908382fbc",
  "userName":"zz",
  "data":[
    {
      "taskId": 1,
      "name": "营销任务 - A"
    },
    {
      "taskId": 2,
      "name": "营销任务 - B"
    }
  ]
}
}

响应参数说明

参数名	类型	是否必填	备注
taskId	Integer	是	任务 id
name	String	是	任务名称
status	Integer	是	任务状态 0 已执行 1 未执行
data	List	是	任务发送信息

data参数说明

参数名	类型	是否必填	备注
friendWhatsId	String	是	营销对象
executor	String	是	执行人
whatsId	String	是	发送人
status	Integer	是	执行状态 0 已执行 1 未执行 2 已删除
isStrangerType	Integer	是	关系类型 0 好友 1 陌生人

响应示例

{
  "code": 200,
  "message": "Success",
  "data": [
    {
      "taskId": 6279,
      "name": "open-Api-task-01",
      "status": 0,
      "taskRecordList": [
        {
          "executor": "testlsl001",
          "friendWhatsId": "436602094064@c.us",
          "whatsId": "33766604583@c.us",
          "status": 1,
          "isStrangerType": 1
        },
        {
          "executor": "testlsl001",
          "friendWhatsId": "436602090410@c.us",
          "whatsId": "33766604583@c.us",
          "status": 1,
          "isStrangerType": 1
        }
      ]
    },
    {
      "taskId": 6279,
      "name": "open-Api-task-02",
      "status": 0,
      "taskRecordList": [
        {
          "executor": "testlsl001",
          "friendWhatsId": "436602094064@c.us",
          "whatsId": "33766604583@c.us",
          "status": 1,
          "isStrangerType": 1
        },
        {
          "executor": "testlsl001",
          "friendWhatsId": "436602090410@c.us",
          "whatsId": "33766604583@c.us",
          "status": 1,
          "isStrangerType": 1
        }
      ]
    }
  ]
}

营销自动化

# 营销自动化

# 添加群发任务接口

# 回调接口

# 查询执行详情接口

营销自动化

添加群发任务接口

回调接口

查询执行详情接口