跳至主要內容

群发相关接口

大约 30 分钟

群发相关接口

创建群发接口

**群发任务的好友号码数量上限为 5000,单条消息的内容长度不能大于 1024。

手机端目前只支持 文本、图片、超链(不可点击)。

PC 端目前只支持 文本、图片。

快速创建群发任务(指定客服号,单个发送目标)

  • 类型

    API

  • URI

    /group-dispatch-api/gsTask/assign/soCreate

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    创建群发任务,且指定一个发送目标,支持多条和单条内容。

  • 请求参数说明

字段类型是否必填备注
nameString任务名称
startTaskTimeString预约任务开始时间 默认当前时间
endTaskTimeString预约任务结束时间 未来时间
sendTypeint发送方式 1 PC 2 手机 WaChat 默认 PC
agentAccountstring坐席账号(指定坐席进行发送)
targetTypeint目标类型 1、个人 2、群组
sendWhatsAppString客服号 whatsapp
friendWhatsAppString好友 whatsapp/群 id
contentList内容列表
  • content 参数说明
参数名类型是否必填备注
typeint内容类型 1.文字 2.图片 3.音频 4.文件 5.视频 6.名片 10.名片超链 11.分流超链
textString文本内容
urlString静态资源链接
sortint排序
variableFieldsList变量列表
transIdStringtransId
routeTypeint1 坐席分流 2 客服号分组分流 3 自定义接粉 (消息类型为分流超链使用)
routeListList分流目标 坐席就是坐席 id 客服号分组就是客服号分组 id 3 自定义的就是 whatsapp 手机号码,对应 routeType 类型的值 (消息类型为分流超链使用)
titleString标题 (消息类型为名片超链使用)
descString备注 (消息类型为名片超链使用)
linkString链接 (消息类型为名片超链使用)
adsTemplateIdint广告模版 id,目前只支持名片超链,存在时将覆盖(title,desc,link,url)字段,如需使用,请提前配置
  • variableField 参数说明
参数名类型是否必填备注
typeint变量类型 1、基本属性 2、扩展字段 (管理后台配置)
nameString字段名称
  • 基本属性
字段描述
whatsApp客服号
friendName姓名
sex性别
birthday生日
address地址
email邮箱
profession职业
income收入
desc说明
source来源
stage阶段
languageTag语言
tabName标签
followStatus跟进状态
  • 请求示例-1:
{
  "name": "task-202403201653119191",
  "sendType": 1,
  "startTaskTime": "2024-04-21 17:01:27",
  "targetType": 1,
  "sendWhatsApp": "8618217331213",
  "friendWhatsApp": "8618217331211",
  "content": [
    {
      "type": 1,
      "text": "你好啊,今天所有商品9折,快来看一看呀。",
      "url": "",
      "sort": 0,
      "variableFields": [],
      "transId": ""
    }
  ]
}
  • 请求示例-2:
{
  "name": "task-202403201653119191",
  "sendType": 1,
  "startTaskTime": "2024-04-21 17:01:27",
  "targetType": 1,
  "sendWhatsApp": "8618217331213",
  "friendWhatsApp": "8618217331211",
  "content": [
    {
      "type": 1,
      "text": "你好{friendName},今天是你{birthday}生日,所有商品3折,快来看一看呀。",
      "url": "",
      "sort": 0,
      "variableFields": [
        {
          "type": 1,
          "name": "friendName"
        },
        {
          "type": 1,
          "name": "birthday"
        }
      ],
      "transId": ""
    }
  ]
}
  • 请求示例-3:
{
  "name": "api-指定客服号,单个发送目标",
  "targetType": 1,
  "startTaskTime": "2024-10-16 17:49:02",
  "endTaskTime": null,
  "sendType": 2,
  "sendWhatsApp": "8618812341234",
  "friendWhatsApp": "8615212877543",
  "content": [
    {
      "type": 11,
      "text": "hello, 这是超链坐席分流",
      "sort": 0,
      "routeType": 1,
      "routeList": ["801406"]
    },
    {
      "type": 11,
      "text": "hello,这是超链客服号分组分流",
      "sort": 1,
      "routeType": 2,
      "routeList": ["67"]
    },
    {
      "type": 11,
      "text": "hello,这是超链客服号分组分流",
      "sort": 2,
      "routeType": 3,
      "routeList": ["8619876543210"]
    },
    {
      "type": 10,
      "text": "hello,这是名片超链",
      "sort": 3,
      "url": "https://www.google.com/favicon.ico",
      "title": "标题",
      "desc": "这是名片超链",
      "link": "https://www.google.com/"
    },
    {
      "type": 10,
      "text": "hello,这是名片超链2",
      "sort": 4,
      "adsTemplateId": 32
    }
  ]
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataObject数据
  • data 响应参数
参数名类型是否必填备注
taskIdString任务 id
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "taskId": "6a2724fa2b7055971f960cc162632595"
  }
}

快速创建群发任务(指定客服号&多目标,内容相同)

  • 类型

    API

  • URI

    /group-dispatch-api/gsTask/assign/moscCreate

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    创建群发任务,多个客服号,多个发送目标,支持多条和单条内容。
    注:绑定发送者和接收者的关系。

  • 请求参数说明

字段类型是否必填备注
nameString任务名称
startTaskTimeString预约任务开始时间 默认当前时间
endTaskTimeString预约任务结束时间
sendTypeint发送方式 1 PC 2 手机 WaChat 默认 PC
agentAccountstring坐席账号(指定坐席进行发送)
targetTypeint目标类型 1、个人 2、群组
sendInfosList客服号发送信息列表
contentList内容列表
  • sendInfos
字段类型是否必填备注
sendWhatsAppString客服号 whatsapp
friendWhatsAppString好友 whatsapp/群 id
  • content 参数说明
参数名类型是否必填备注
typeint内容类型 1.文字 2.图片 3.音频 4.文件 5.视频 6.名片 10.名片超链 11.分流超链
textString文本内容
urlString静态资源链接
fileNameString文件名 url 不为空时使用
sortint排序
variableFieldsList变量列表
transIdStringtransId
routeTypeint1 坐席分流 2 客服号分组分流 3 自定义接粉 (消息类型为分流超链使用)
routeListList分流目标 坐席就是坐席 id 客服号分组就是客服号分组 id 3 自定义的就是 whatsapp 手机号码,对应 routeType 类型的值 (消息类型为分流超链使用)
titleString标题 (消息类型为名片超链使用)
descString备注 (消息类型为名片超链使用)
linkString链接 (消息类型为名片超链使用)
adsTemplateIdint广告模版 id,目前只支持名片超链,存在时将覆盖(title,desc,link,url)字段,如需使用,请提前配置
  • variableField 参数说明
参数名类型是否必填备注
typeint变量类型 1、基本属性 2、扩展字段 (管理后台配置)
nameString字段名称
  • 基本属性

同上

  • 请求示例-1:
{
  "name": "task-202403201653119191",
  "sendType": 1,
  "startTaskTime": "2024-04-21 17:01:27",
  "targetType": 1,
  "sendInfos": [
    {
      "sendWhatsApp": "8618217331213",
      "friendWhatsApp": "8618217331211"
    }
  ],
  "content": [
    {
      "type": 1,
      "text": "你好啊,今天所有商品9折,快来看一看呀。",
      "url": "",
      "sort": 0,
      "variableFields": []
    }
  ]
}
  • 请求示例-2:
{
  "name": "task-202403201653119191",
  "sendType": 1,
  "startTaskTime": "2024-04-21 17:01:27",
  "targetType": 1,
  "sendInfos": [
    {
      "sendWhatsApp": "8618217331213",
      "friendWhatsApp": "8618217331211"
    }
  ],
  "content": [
    {
      "type": 1,
      "text": "你好{friendName},今天是你{birthday}生日,所有商品3折,快来看一看呀。",
      "url": "",
      "sort": 0,
      "variableFields": [
        {
          "type": 1,
          "name": "friendName"
        },
        {
          "type": 1,
          "name": "birthday"
        }
      ]
    }
  ]
}
  • 请求示例-3:
{
  "name": "api-task",
  "targetType": 1,
  "startTaskTime": "2024-10-16 18:00:00",
  "sendType": 2,
  "sendInfos": [
    {
      "sendWhatsApp": "8618812341234",
      "friendWhatsApp": "8615212877543"
    }
  ],
  "content": [
    {
      "type": 11,
      "text": "hello, 这是超链坐席分流",
      "sort": 0,
      "routeType": 1,
      "routeList": ["801406"]
    },
    {
      "type": 11,
      "text": "hello,这是超链客服号分组分流",
      "sort": 1,
      "routeType": 2,
      "routeList": ["67"]
    },
    {
      "type": 11,
      "text": "hello,这是超链客服号分组分流",
      "sort": 2,
      "routeType": 3,
      "routeList": ["8619876543210"]
    },
    {
      "type": 10,
      "text": "hello,这是名片超链",
      "sort": 3,
      "url": "https://www.google.com/favicon.ico",
      "title": "标题",
      "desc": "这是名片超链",
      "link": "https://www.google.com/"
    },
    {
      "type": 10,
      "text": "hello,这是名片超链2",
      "sort": 4,
      "adsTemplateId": 32
    }
  ]
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataString数据
  • data 响应参数

    参数名类型是否必填备注
    taskIdString任务 id
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "taskId": "6a2724fa2b7055971f960cc162632595"
  }
}

快速创建群发任务(指定客服号&多目标,内容不同)

  • 类型

    API

  • URI

    /group-dispatch-api/gsTask/assign/modcCreate

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    创建群发任务,多个客服号,多个发送目标,支持多条和单条内容。

  • 请求参数说明

字段类型是否必填备注
nameString任务名称
startTaskTimeString预约任务开始时间 默认当前时间
endTaskTimeString预约任务结束时间
sendTypeint发送方式 1 PC 2 手机 WaChat 默认 PC
agentAccountstring坐席账号(指定坐席进行发送)
targetTypeint目标类型 1、个人 2、群组
sendInfosList发送内容
  • sendInfos 参数说明
字段类型是否必填备注
sendWhatsAppString客服号 whatsapp
friendWhatsAppString好友 whatsapp/群 id
contentList内容列表
  • content 参数说明
参数名类型是否必填备注
typeint内容类型 1.文字 2.图片 3.音频 4.文件 5.视频 6.名片 10.名片超链 11.分流超链
textString文本内容
urlString静态资源链接
sortint排序
variableFieldsList变量列表
transIdStringtransId
routeTypeint1 坐席分流 2 客服号分组分流 3 自定义接粉 (消息类型为分流超链使用)
routeListList分流目标 坐席就是坐席 id 客服号分组就是客服号分组 id 3 自定义的就是 whatsapp 手机号码,对应 routeType 类型的值 (消息类型为分流超链使用)
titleString标题 (消息类型为名片超链使用)
descString备注 (消息类型为名片超链使用)
linkString链接 (消息类型为名片超链使用)
adsTemplateIdint广告模版 id,目前只支持名片超链,存在时将覆盖(title,desc,link,url)字段,如需使用,请提前配置
  • variableField 参数说明
参数名类型是否必填备注
typeint变量类型 1、基本属性 2、扩展字段 (管理后台配置)
nameString字段名称
  • 基本属性

    同上

  • 请求示例-1:

{
  "name": "task-202403201653119191",
  "targetType": 1,
  "startTaskTime": "2024-04-22 10:29:55",
  "endTaskTime": null,
  "sendType": 2,
  "sendInfos": [
    {
      "sendWhatsApp": "8618217331213",
      "friendWhatsApp": "8618217331211",
      "content": [
        {
          "type": 1,
          "text": "你好啊,今天所有商品9折,快来看一看呀。",
          "url": "",
          "sort": 0,
          "variableFields": []
        }
      ]
    }
  ]
}
  • 请求示例-2:
{
  "name": "api-task",
  "targetType": 1,
  "startTaskTime": "2024-10-16 18:00:00",
  "sendType": 2,
  "sendInfos": [
    {
      "sendWhatsApp": "8618812341234",
      "friendWhatsApp": "8615212877543",
      "content": [
        {
          "type": 11,
          "text": "hello, 这是超链坐席分流",
          "sort": 0,
          "routeType": 1,
          "routeList": ["801406"]
        },
        {
          "type": 11,
          "text": "hello,这是超链客服号分组分流",
          "sort": 1,
          "routeType": 2,
          "routeList": ["67"]
        },
        {
          "type": 11,
          "text": "hello,这是超链客服号分组分流",
          "sort": 2,
          "routeType": 3,
          "routeList": ["8619876543210"]
        },
        {
          "type": 10,
          "text": "hello,这是名片超链",
          "sort": 3,
          "url": "https://www.google.com/favicon.ico",
          "title": "标题",
          "desc": "这是名片超链",
          "link": "https://www.google.com/"
        },
        {
          "type": 10,
          "text": "hello,这是名片超链2",
          "sort": 4,
          "adsTemplateId": 32
        }
      ]
    }
  ]
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataString数据
  • data 响应参数

    参数名类型是否必填备注
    taskIdString任务 id
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "taskId": "6a2724fa2b7055971f960cc162632595"
  }
}

快速创建群发任务(指定多客服号&多目标,不绑定关系)

  • 类型

    API

  • URI

    /group-dispatch-api/gsTask/assign/mmCreate

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    创建群发任务,指定多个客服号和发送目标,支持多条和单条内容,不绑定关系,自由分配。

  • 请求参数说明
字段类型是否必填备注
nameString任务名称
startTaskTimeString预约任务开始时间 默认当前时间
endTaskTimeString预约任务结束时间
sendTypeint发送方式 1 PC 2 手机 WaChat 默认 PC
agentAccountstring坐席账号(指定坐席进行发送)
targetTypeint目标类型 1、个人 2、群组
sendWhatsAppListList客服号 list
friendWhatsAppListList好友 whatsapp list/群 id
contentList内容列表
  • content 参数说明
参数名类型是否必填备注
typeint内容类型 1.文字 2.图片 3.音频 4.文件 5.视频 6.名片 10.名片超链 11.分流超链
textString文本内容
urlString静态资源链接
sortint排序
variableFieldsList变量列表
transIdStringtransId
routeTypeint1 坐席分流 2 客服号分组分流 3 自定义接粉 (消息类型为分流超链使用)
routeListList分流目标 坐席就是坐席 id 客服号分组就是客服号分组 id 3 自定义的就是 whatsapp 手机号码,对应 routeType 类型的值 (消息类型为分流超链使用)
titleString标题 (消息类型为名片超链使用)
descString备注 (消息类型为名片超链使用)
linkString链接 (消息类型为名片超链使用)
adsTemplateIdint广告模版 id,目前只支持名片超链,存在时将覆盖(title,desc,link,url)字段,如需使用,请提前配置
  • variableField 参数说明
参数名类型是否必填备注
typeint变量类型 1、基本属性 2、扩展字段 (管理后台配置)
nameString字段名称
  • 基本属性
字段描述
whatsApp客服号
friendName姓名
sex性别
birthday生日
address地址
email邮箱
profession职业
income收入
desc说明
source来源
stage阶段
languageTag语言
tabName标签
followStatus跟进状态
  • 请求示例-1:
{
  "name": "多对多创建-1",
  "startTaskTime": "2024-07-21 17:01:27",
  "endTaskTime": null,
  "sendType": 1,
  "targetType": 1,
  "sendWhatsAppList": ["6578645661211"],
  "friendWhatsAppList": ["8618217331211"],
  "content": [
    {
      "type": 1,
      "text": "你好啊,今天所有商品9折,快来看一看呀。",
      "url": "",
      "sort": 0,
      "transId": "tr00003",
      "variableFields": []
    },
    {
      "type": 1,
      "text": "你好 {friendName},今天是你生日,所有商品3折,快来看一看呀。",
      "url": "",
      "sort": "",
      "transId": "tr00002",
      "variableFields": [
        {
          "type": 1,
          "name": "friendName"
        }
      ]
    }
  ]
}
  • 请求示例-2:
{
  "name": "多对多创建-2",
  "startTaskTime": "2024-10-16 18:00:00",
  "sendType": 1,
  "targetType": 1,
  "sendWhatsAppList": ["8618812341234"],
  "friendWhatsAppList": ["8615212877543"],
  "content": [
    {
      "type": 11,
      "text": "hello, 这是超链坐席分流",
      "sort": 0,
      "routeType": 1,
      "routeList": ["801406"]
    },
    {
      "type": 11,
      "text": "hello,这是超链客服号分组分流",
      "sort": 1,
      "routeType": 2,
      "routeList": ["67"]
    },
    {
      "type": 11,
      "text": "hello,这是超链客服号分组分流",
      "sort": 2,
      "routeType": 3,
      "routeList": ["8619876543210"]
    },
    {
      "type": 10,
      "text": "hello,这是名片超链",
      "sort": 3,
      "url": "https://www.google.com/favicon.ico",
      "title": "标题",
      "desc": "这是名片超链",
      "link": "https://www.google.com/"
    },
    {
      "type": 10,
      "text": "hello,这是名片超链2",
      "sort": 4,
      "adsTemplateId": 32
    }
  ]
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataString数据

data 响应参数

参数名类型是否必填备注
taskIdString任务 id
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "taskId": "278881"
  }
}

快速创建群发任务(指定客服号分组)

  • 类型

    API

  • URI

    /group-dispatch-api/gsTask/assign/groupCreate

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    创建群发任务,指定客服号分组创建群发

  • 请求参数说明
字段类型是否必填备注
nameString任务名称
startTaskTimeString预约任务开始时间 默认当前时间
endTaskTimeString预约任务结束时间
sendTypeint发送方式 1 PC 2 手机 WaChat 默认 PC
agentAccountstring坐席账号(指定坐席进行发送)
targetTypeint目标类型 1、个人 2、群组
whatsappGroupIdint客服号分组 id
friendWhatsAppListList好友 whatsapp list/群 id
contentList内容列表
  • content 参数说明
参数名类型是否必填备注
typeint内容类型 1.文字 2.图片 3.音频 4.文件 5.视频 6.名片 10.名片超链 11.分流超链
textString文本内容
urlString静态资源链接
sortint排序
variableFieldsList变量列表
transIdStringtransId
routeTypeint1 坐席分流 2 客服号分组分流 3 自定义接粉 (消息类型为分流超链使用)
routeListList分流目标 对应 routeType 的值,坐席就是坐席 id、客服号分组就是客服号分组 id、自定义的就是 whatsapp 手机号码(消息类型为分流超链使用)
titleString标题 (消息类型为名片超链使用)
descString备注 (消息类型为名片超链使用)
linkString链接 (消息类型为名片超链使用)
adsTemplateIdint广告模版 id,目前只支持名片超链,存在时将覆盖(title,desc,link,url)字段,如需使用,请提前配置
  • variableField 参数说明
参数名类型是否必填备注
typeint变量类型 1、基本属性 2、扩展字段 (管理后台配置)
nameString字段名称
  • 基本属性
字段描述
whatsApp客服号
friendName姓名
sex性别
birthday生日
address地址
email邮箱
profession职业
income收入
desc说明
source来源
stage阶段
languageTag语言
tabName标签
followStatus跟进状态
  • 请求示例-1:
{
  "name": "客服号分组创建群发-1",
  "startTaskTime": "2024-07-21 17:01:27",
  "endTaskTime": null,
  "sendType": 1,
  "targetType": 1,
  "whatsappGroupId": 68,
  "friendWhatsApp": ["8618217331211"],
  "content": [
    {
      "type": 1,
      "text": "你好啊,今天所有商品9折,快来看一看呀。",
      "transId": "tr00003"
    },
    {
      "type": 1,
      "text": "你好 {friendName},今天是你生日,所有商品3折,快来看一看呀。",
      "transId": "tr00002",
      "variableFields": [
        {
          "type": 1,
          "name": "friendName"
        }
      ]
    },
    {
      "type": 11,
      "text": "hello, 这是超链坐席分流",
      "sort": 0,
      "routeType": 1,
      "routeList": ["801406"]
    },
    {
      "type": 11,
      "text": "hello,这是超链客服号分组分流",
      "sort": 1,
      "routeType": 2,
      "routeList": ["67"]
    },
    {
      "type": 11,
      "text": "hello,这是超链客服号分组分流",
      "sort": 2,
      "routeType": 3,
      "routeList": ["8619876543210"]
    },
    {
      "type": 10,
      "text": "hello,这是名片超链",
      "sort": 3,
      "url": "https://www.google.com/favicon.ico",
      "title": "标题",
      "desc": "这是名片超链",
      "link": "https://www.google.com/"
    },
    {
      "type": 10,
      "text": "hello,这是名片超链2",
      "sort": 4,
      "adsTemplateId": 32
    }
  ]
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataString数据

data 响应参数

参数名类型是否必填备注
taskIdString任务 id
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "taskId": "876"
  }
}

快速创建群发任务(不指定客服号,单目标)

  • 类型

    API

  • URI

    /group-dispatch-api/gsTask/noAssign/soCreate

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    创建群发任务,且指定一个发送目标,支持多条和单条内容。

  • 请求参数说明

字段类型是否必填备注
nameString任务名称
startTaskTimeString预约任务开始时间 默认当前时间
endTaskTimeString预约任务结束时间
sendTypeint发送方式 1 PC 2 手机 WaChat 默认 PC
agentAccountstring坐席账号(指定坐席进行发送)
targetTypeint目标类型 1、个人 2、群组
friendWhatsAppString好友 whatsapp/群 id
contentList内容列表
  • content 参数说明
参数名类型是否必填备注
typeint内容类型 1.文字 2.图片 3.音频 4.文件 5.视频 6.名片 10.名片超链 11.分流超链
textString文本内容
urlString静态资源链接
sortint排序
variableFieldsList变量列表
transIdStringtransId
routeTypeint1 坐席分流 2 客服号分组分流 3 自定义接粉 (消息类型为分流超链使用)
routeListList分流目标 坐席就是坐席 id 客服号分组就是客服号分组 id 3 自定义的就是 whatsapp 手机号码,对应 routeType 类型的值 (消息类型为分流超链使用)
titleString标题 (消息类型为名片超链使用)
descString备注 (消息类型为名片超链使用)
linkString链接 (消息类型为名片超链使用)
adsTemplateIdint广告模版 id,目前只支持名片超链,存在时将覆盖(title,desc,link,url)字段,如需使用,请提前配置
  • variableField 参数说明
参数名类型是否必填备注
typeint变量类型 1、基本属性 2、扩展字段 (管理后台配置)
nameString字段名称
  • 基本属性
字段描述
whatsApp客服号
friendName姓名
sex性别
birthday生日
address地址
email邮箱
profession职业
income收入
desc说明
source来源
stage阶段
languageTag语言
tabName标签
followStatus跟进状态
  • 请求示例-1:
{
  "name": "task-202403201653119191",
  "startTaskTime": "2024-04-22 10:29:55",
  "endTaskTime": null,
  "sendType": 2,
  "targetType": 1,
  "friendWhatsApp": "8618217331211",
  "content": [
    {
      "type": 1,
      "text": "你好啊,今天所有商品9折,快来看一看呀。",
      "url": "",
      "sort": 0,
      "variableFields": []
    }
  ]
}
  • 请求示例-2:
{
  "name": "task-202403201653119191",
  "targetType": 1,
  "startTaskTime": "2024-04-22 10:29:55",
  "endTaskTime": null,
  "sendType": 2,
  "friendWhatsApp": "8618217331211",
  "content": [
    {
      "type": 1,
      "text": "你好{friendName},今天是你的生日,所有商品3折,快来看一看呀。",
      "url": "",
      "sort": 0,
      "variableFields": [
        {
          "type": 1,
          "name": "friendName"
        }
      ]
    }
  ]
}
  • 请求示例-3:
{
  "name": "api-task",
  "targetType": 1,
  "startTaskTime": "2024-10-16 18:00:00",
  "sendType": 2,
  "friendWhatsApp": "8615212877543",
  "content": [
    {
      "type": 11,
      "text": "hello, 这是超链坐席分流",
      "sort": 0,
      "routeType": 1,
      "routeList": ["801406"]
    },
    {
      "type": 11,
      "text": "hello,这是超链客服号分组分流",
      "sort": 1,
      "routeType": 2,
      "routeList": ["67"]
    },
    {
      "type": 11,
      "text": "hello,这是超链客服号分组分流",
      "sort": 2,
      "routeType": 3,
      "routeList": ["8619876543210"]
    },
    {
      "type": 10,
      "text": "hello,这是名片超链",
      "sort": 3,
      "url": "https://www.google.com/favicon.ico",
      "title": "标题",
      "desc": "这是名片超链",
      "link": "https://www.google.com/"
    },
    {
      "type": 10,
      "text": "hello,这是名片超链2",
      "sort": 4,
      "adsTemplateId": 32
    }
  ]
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataString数据
  • data 响应参数

    参数名类型是否必填备注
    taskIdString任务 id
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "taskId": "6a2724fa2b7055971f960cc162632595"
  }
}

快速创建群发任务(不指定客服号,多目标)

  • 类型

    API

  • URI

    /group-dispatch-api/gsTask/noAssign/moCreate

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    创建群发任务,且指定一个发送目标,支持多条和单条内容。

  • 请求参数说明

字段类型是否必填备注
nameString任务名称
startTaskTimeString预约任务开始时间 默认当前时间
endTaskTimeString预约任务结束时间
sendTypeint发送方式 1 PC 2 手机 WaChat 默认 PC
agentAccountstring坐席账号(指定坐席进行发送)
targetTypeint目标类型 1、个人 2、群组
friendWhatsAppList好友 whatsapp/群 id
contentList内容列表
  • content 参数说明
参数名类型是否必填备注
typeint内容类型 1.文字 2.图片 3.音频 4.文件 5.视频 6.名片 10.名片超链 11.分流超链
textString文本内容
urlString静态资源链接
sortint排序
variableFieldsList变量列表
transIdStringtransId
routeTypeint1 坐席分流 2 客服号分组分流 3 自定义接粉 (消息类型为分流超链使用)
routeListList分流目标 坐席就是坐席 id 客服号分组就是客服号分组 id 3 自定义的就是 whatsapp 手机号码,对应 routeType 类型的值 (消息类型为分流超链使用)
titleString标题 (消息类型为名片超链使用)
descString备注 (消息类型为名片超链使用)
linkString链接 (消息类型为名片超链使用)
adsTemplateIdint广告模版 id,目前只支持名片超链,存在时将覆盖(title,desc,link,url)字段,如需使用,请提前配置
  • variableField 参数说明
参数名类型是否必填备注
typeint变量类型 1、基本属性 2、扩展字段 (管理后台配置)
nameString字段名称
  • 基本属性
字段描述
whatsApp客服号
friendName姓名
sex性别
birthday生日
address地址
email邮箱
profession职业
income收入
desc说明
source来源
stage阶段
languageTag语言
tabName标签
followStatus跟进状态
  • 请求示例-1:
{
  "name": "task-202403201653119191",
  "startTaskTime": "2024-04-22 10:29:55",
  "endTaskTime": null,
  "sendType": 2,
  "targetType": 1,
  "friendWhatsApp": ["8618217331211"],
  "content": [
    {
      "type": 1,
      "text": "你好啊,今天所有商品9折,快来看一看呀。",
      "url": "",
      "sort": 0,
      "variableFields": []
    }
  ]
}
  • 请求示例-2:
{
  "targetType": 1,
  "startTaskTime": "2024-04-22 10:29:55",
  "endTaskTime": null,
  "sendType": 2,
  "friendWhatsApp": ["8618217331211"],
  "content": [
    {
      "type": 1,
      "text": "你好{friendName},今天是你的生日,所有商品3折,快来看一看呀。",
      "url": "",
      "sort": 0,
      "variableFields": [
        {
          "type": 1,
          "name": "friendName"
        }
      ]
    }
  ]
}
  • 请求示例-3:
{
  "name": "api-task",
  "targetType": 1,
  "startTaskTime": "2024-10-16 18:00:00",
  "sendType": 2,
  "friendWhatsApp": ["8615212877543"],
  "content": [
    {
      "type": 11,
      "text": "hello, 这是超链坐席分流",
      "sort": 0,
      "routeType": 1,
      "routeList": ["801406"]
    },
    {
      "type": 11,
      "text": "hello,这是超链客服号分组分流",
      "sort": 1,
      "routeType": 2,
      "routeList": ["67"]
    },
    {
      "type": 11,
      "text": "hello,这是超链客服号分组分流",
      "sort": 2,
      "routeType": 3,
      "routeList": ["8619876543210"]
    },
    {
      "type": 10,
      "text": "hello,这是名片超链",
      "sort": 3,
      "url": "https://www.google.com/favicon.ico",
      "title": "标题",
      "desc": "这是名片超链",
      "link": "https://www.google.com/"
    },
    {
      "type": 10,
      "text": "hello,这是名片超链2",
      "sort": 4,
      "adsTemplateId": 32
    }
  ]
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataString数据

data 响应参数

参数名类型是否必填备注
taskIdString任务 id
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "taskId": "6a2724fa2b7055971f960cc162632595"
  }
}

快速创建群发任务(不指定客服号,条件目标)

  • 类型

    API

  • URI

    /group-dispatch-api/gsTask/noAssign/comoCreate

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    创建群发任务,不指定客服号,根据条件进行检索发送目标,并且支持自动化行为。 注:群组群发不支持消息变量

  • 请求参数说明
字段类型是否必填备注
nameString任务名称
startTaskTimeString预约任务开始时间 默认当前时间
endTaskTimeString预约任务结束时间
sendTypeint发送方式 1 PC 2 手机 WaChat 默认 PC
agentAccountstring坐席账号(指定坐席进行发送)
targetTypeint目标类型 1、个人 2、群组
targetAudienceConditionList目标受众条件,个人
targetAudienceConditionOnGroupTargetAudienceConditionOnGroup目标受众查询条件,群组
automatedBehaviorList自动化触发行为
contentList内容列表
  • targetAudienceCondition 参数说明
字段类型是否必填备注
typeString内容类型 1、基本属性 2、扩展字段
nameString名称(字段)
opsTypeint操作类型 1、小于 2、等于 3、大于 4、大于等于,小于等于
valueString
rangeValueStartString开始值 (opsType=4)
rangeValueEndString结束值 (opsType=4)
  • automatedBehavior 参数说明
字段类型是否必填备注
eventTypeint事件类型 1、消息发送成功 2、消息发送失败
actionTypeint行为类型 1、客户阶段变更 2、客户标签变更
opsTypeint操作类型 1、增加 2、删除 3、修改
customerTagValueList标签值列表
customerStageValueint客户阶段
  • content 参数说明
参数名类型是否必填备注
typeint内容类型 1.文字 2.图片 3.音频 4.文件 5.视频 6.名片 10.名片超链 11.分流超链
textString文本内容
urlString静态资源链接
sortint排序
variableFieldsList变量列表
transIdStringtransId
routeTypeint1 坐席分流 2 客服号分组分流 3 自定义接粉 (消息类型为分流超链使用)
routeListList分流目标 坐席就是坐席 id 客服号分组就是客服号分组 id 3 自定义的就是 whatsapp 手机号码,对应 routeType 类型的值 (消息类型为分流超链使用)
titleString标题 (消息类型为名片超链使用)
descString备注 (消息类型为名片超链使用)
linkString链接 (消息类型为名片超链使用)
adsTemplateIdint广告模版 id,目前只支持名片超链,存在时将覆盖(title,desc,link,url)字段,如需使用,请提前配置
  • variableField 参数说明
参数名类型是否必填备注
typeint变量类型 1、基本属性 2、扩展字段 (管理后台配置)
nameString字段名称
  • 基本属性
字段描述
whatsApp客服号
friendName姓名
sex性别
birthday生日
address地址
email邮箱
profession职业
income收入
desc说明
source来源
stage阶段
languageTag语言
tabName标签
followStatus跟进状态
  • TargetAudienceConditionOnGroup 参数说明
参数名类型是否必填备注
whatsappListList客服号号码列表
groupTabIdsList群组标签 id 列表
principalListList负责人
groupNameString群组名称,支持模糊查询
  • 请求示例-1:
{
  "name": "task-20240320175301",
  "targetType": 1,
  "startTaskTime": "2024-04-22 10:29:55",
  "endTaskTime": null,
  "sendType": 2,
  "content": [
    {
      "type": 1,
      "text": "你好{friendName},今天是你的{birthday}生日,所有商品3折,快来看一看呀。",
      "url": "",
      "sort": 0,
      "variableFields": [
        {
          "type": 1,
          "name": "friendName"
        },
        {
          "type": 1,
          "name": "birthday"
        }
      ]
    }
  ],
  "targetAudienceCondition": [
    {
      "type": "1",
      "name": "Age",
      "opsType": "1",
      "value": "20"
    },
    {
      "type": "1",
      "name": "money",
      "opsType": "4",
      "rangeValueStart": "5000",
      "rangeValueEnd": "10000"
    }
  ],
  "automatedBehavior": [
    {
      "eventType": "1",
      "actionType": "1",
      "opsType": "3",
      "customerTagValue": "已沟通"
    }
  ]
}
  • 请求示例-2:
{
  "name": "20240802165237",
  "sendType": 1,
  "startTime": "2024-08-02 16:52:37",
  "targetType": 1,
  "content": [
    {
      "type": 11,
      "text": "hello, 这是超链坐席分流",
      "sort": 0,
      "routeType": 1,
      "routeList": ["801406"]
    },
    {
      "type": 11,
      "text": "hello,这是超链客服号分组分流",
      "sort": 1,
      "routeType": 2,
      "routeList": ["67"]
    },
    {
      "type": 11,
      "text": "hello,这是超链客服号分组分流",
      "sort": 2,
      "routeType": 3,
      "routeList": ["8619876543210"]
    },
    {
      "type": 10,
      "text": "hello,这是名片超链",
      "sort": 3,
      "url": "https://www.google.com/favicon.ico",
      "title": "标题",
      "desc": "这是名片超链",
      "link": "https://www.google.com/"
    },
    {
      "type": 10,
      "text": "hello,这是名片超链2",
      "sort": 4,
      "adsTemplateId": 32
    }
  ],
  "automatedBehaviorDTOS": [],
  "targetAudienceConditionOnGroup": {
    "groupName": "test",
    "whatsappList": ["8615266290625"],
    "groupTabIds": [10295],
    "principalList": [621485]
  }
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataString数据
  • data 响应参数
参数名类型是否必填备注
taskIdString任务 id
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "taskId": "6a2724fa2b7055971f960cc162632595"
  }
}

群发查询接口

查询群发任务执行状态

  • 类型

    API

  • URI

    /group-dispatch-api/gsTask/queryExecuteStatus

  • 请求方式

    Get、Content-Type: application/json

  • 接口说明

    查询群发任务的执行状态

  • 请求参数说明

字段类型是否必填备注
taskIdString订单编号
  • 请求示例:

group-dispatch-api/gsTask/queryExecuteStatus?taskId=174

  • 响应参数说明

    名称类型是否必填备注
    codeint状态码
    messageString描述
    dataObject数据
  • data 参数说明

    名称类型是否必填备注
    infoList群发任务详情
    taskIdString任务 id
    statusint任务状态 1、待开始 2、待发送 3、群发中 4、已停止 5、已完成 6、已暂停
  • info 参数说明

    名称类型是否必填备注
    whatsAppStringwhatsapp
    friendWhatsAppString好友 whatsapp/群 id
    statusint状态 0、待下发 1、待发送 2、发送中 3、已发送 4、已到达 5、已读 6、已读已回 7、已读未回 -1、发送失败
    timeString时间(对应状态触发时间)
  • 响应示例
{
  "data": {
    "taskId": "7ecb410f496db67f549aac211cf2be7d",
    "status": 1,
    "info": [
      {
        "whatsApp": "86172162521",
        "friendWhatsApp": "86172162521",
        "time": "2023-07-12 10:43:00",
        "status": 1
      },
      {
        "whatsApp": "86172162522",
        "friendWhatsApp": "86172162522",
        "time": "2023-07-12 10:43:00",
        "status": 2
      }
    ]
  },
  "code": 200,
  "message": "success"
}

异步通知接口(webhook)

异步通知群发任务执行状态

  • 配置 ID <GS_V3_SYNC_TASK_STATUS>

  • 类型

WebHook

  • URI

    /callback/gsTask/syncTaskStatus

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    异步通知订单执行状态

  • 请求参数说明

字段类型是否必填备注
taskIdString订单 id
statusString任务状态 1、待开始 2、待发送 3、群发中 4、已停止 5、已完成 6、已暂停

请求示例:

{
  "taskId": "6a2724fa2b7055971f960cc162632595",
  "status": "1"
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataObject数据
{
  "data": "",
  "code": 200,
  "message": "success"
}

异步通知群发任务详情执行状态

  • 配置 ID GS_V3_SYNC_TASK_DETAIL_STATUS

  • 类型

    WebHook

  • URI

    /callback/gsTask/syncGsTaskInfoStatus

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    异步通知订单详情执行状态

  • 请求参数说明

字段类型是否必填备注
groupSendInfoStatusListList任务列表
  • 请求参数说明
字段类型是否必填备注
taskIdString任务 id
infoList任务详情
  • info 参数说明
参数名类型是否必填备注
senderWhatsAppString客服号
friendWhatsAppString好友 whatsapp/群 id
statusint状态 0、待下发 1、待发送 2、发送中 3、已发送 4、已到达 5、已读 6、已读已回 7、已读未回 -1、发送失败
timelong时间(对应状态的触发时间)
infoIdint任务详情 id
failReasonCodeint发送失败 code(20250819 更新)
transIdStringtransId
  • failReasonCode 对照表:

pc客户端发送失败错误码

code错误描述
800退出客户端
801端口不存在
802客户端发送逻辑错误
803发送中文限制
804资源下载失败
805whatsApp发送文本逻辑错误
806whatsApp发送多媒体逻辑错误
807whatsApp发送名片逻辑错误
808未找到群
809好友被封
810未找到好友名片
811客服号登出
812刷新客服号
813好友不能发送
814群组不能发送
815无效群
816仅管理可发送
799不在群或被禁言

手机WaChat 发送失败错误码

code错误描述
700账号已经不存在
701群发数量已达上限
702任务完成并回收
703超时
704出现登录弹窗
705封号
706未检测到登录成功
707主动停止
708小时钟超时
709图片下载失败
710账号异常不可用
712号码异常
713群发任务发送失败
714账号异常:苹果账号
715消息响应超时
716发送超时

其他错误

code错误描述
900待发送超时
999未知错误
  • 请求示例:
{
  "groupSendInfoStatusList": [
    {
      "taskId": "6a2724fa2b7055971f960cc162632595",
      "info": [
        {
          "senderWhatsApp": "861271625212",
          "friendWhatsApp": "911827121626",
          "time": 1721358108467,
          "status": 1,
          "infoId": 95,
          "failReasonCode": null,
          "transId": null
        },
        {
          "senderWhatsApp": "861271625212",
          "friendWhatsApp": "911827121621",
          "time": 1721358108467,
          "status": 1,
          "infoId": 96,
          "failReasonCode": null,
          "transId": null
        }
      ]
    }
  ]
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataObject数据
{
  "data": "",
  "code": 200,
  "message": "success"
}

异步通知群发任务-回复消息回调

  • 配置 ID <GS_V3_REPLY_MESSAGE>

  • 类型

    WebHook

  • URI

    /callback/gsTask/syncGsTaskInfoReplyMessage

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    异步通知群发任务-回复消息回调

  • 请求参数说明

字段类型是否必填备注
userIdString用户 id
serialNumberint编号
whatsAppStringwhatsapp(消息接收方)
friendWhatsAppStringfriendWhatsApp(消息发送方)
taskIdString任务 id
taskInfoIdString任务详情 id
contentList回复内容
  • content 参数说明
参数名类型是否必填备注
typeint内容类型 1、文字 2、图片 3、音频 4、文件 5、视频
textString文本内容
urlString静态资源信息
messageIdString消息 id
timelong时间
  • url 参数说明
参数名类型是否必填备注
filenameString文件名称
urlString链接地址
mimeTypeString媒体类型
captionString标题
{
  "userId": "101",
  "serialNumber": "",
  "whatsApp": "86172272727",
  "friendWhatsApp": "61191828282",
  "taskId": "6a2724fa2b7055971f960cc162632595",
  "taskInfoId": "9812343432",
  "content": [
    {
      "type": 1,
      "text": "hello",
      "messageId": "19282dskdasldjl21",
      "time": 1689129792000
    },
    {
      "type": 2,
      "url": {
        "filename": "e70faa31-62dc-4d00-a42a-8a07735aa350",
        "url": "https://id-wscrm.oss-accelerate.aliyuncs.com/client/d584b8cfb9185cc999389f17b4236b3b/61733005-dfdb-4704-9c5d-944423c70dd1",
        "mimeType": "image/jpeg",
        "caption": ""
      },
      "messageId": "1282190210219082198",
      "time": 1689129792000
    }
  ]
}
  • 响应参数说明

    参数名类型是否必填备注
    codeint状态码
    messageString描述
    dataObject数据
{
  "data": "",
  "code": 200,
  "message": "success"
}

群发客服号分组管理接口

添加客服号分组

  • 类型

    API

  • URI

    /group-dispatch-api/whatsapp-audience/addWhatsappAudience

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    添加客服号分组

  • 请求参数说明

字段类型是否必填备注
nameString分组名称
whatsIdListListwhatsapp 集合
  • 请求示例:
{
  "name": "this name",
  "whatsIdList": ["99123456", "98123456"]
}
  • 响应参数说明

    名称类型是否必填备注
    codeint状态码
    messageString描述
    dataObject数据
  • data 参数说明

    名称类型是否必填备注
    idint客服号分组 id
    countint保存成功条数
  • 响应示例
{
  "data": {
    "id": 73,
    "count": 2
  },
  "code": 200,
  "message": "success"
}

查询客服号分组

  • 类型

    API

  • URI

    /group-dispatch-api/whatsapp-audience/query

  • 请求方式

    GET、Content-Type: application/json

  • 接口说明

    查询客服号分组

  • 请求参数说明

字段类型是否必填备注
nameString分组名称
idint客服号分组 id
currentint分页查询参数,当前页码 默认 1
sizeint分页查询参数,每页条数 默认 10
  • 请求示例:

group-dispatch-api/whatsapp-audience/query?id=73

  • 响应参数说明

    名称类型是否必填备注
    codeint状态码
    messageString描述
    dataObject数据
  • data 参数说明

    名称类型是否必填备注
    recordsList客服号分组列表
    totalint总条数
  • records 参数说明

    名称类型是否必填备注
    idint客服号分组 id
    nameString分组名称
    itemsList客服号信息
  • items 参数说明

    名称类型是否必填备注
    phoneString客服号
    countryCodeString客服号归属地,会根据请求头语言进行国际化
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "records": [
      {
        "id": 73,
        "name": "this name",
        "items": [
          {
            "phone": "99123456",
            "countryCode": "UNKNOWN"
          },
          {
            "phone": "98123456",
            "countryCode": "伊朗"
          }
        ]
      }
    ],
    "total": 1
  }
}

查询客服号分组详情

  • 类型

    API

  • URI

    /group-dispatch-api/whatsapp-audience/queryDetail

  • 请求方式

    GET、Content-Type: application/json

  • 接口说明

    查询客服号分组详情

  • 请求参数说明

字段类型是否必填备注
idint客服号分组 id
  • 请求示例:

/group-dispatch-api/whatsapp-audience/queryDetail?id=73

  • 响应参数说明

    名称类型是否必填备注
    codeint状态码
    messageString描述
    dataObject数据
  • data 参数说明

    名称类型是否必填备注
    phoneString客服号
    countryCodeString客服号归属地,会根据请求头语言进行国际化
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": [
    {
      "phone": "99123456",
      "countryCode": "UNKNOWN"
    },
    {
      "phone": "98123456",
      "countryCode": "伊朗"
    }
  ]
}
上次编辑于:
贡献者: kubrick,songjun,zhuang,罗英杰