跳至主要內容

群（社群）

2025/7/10大约 9 分钟

群（社群）

社群信息查询

  • 描述

    分页查询当前公司下的社群（群）信息列表，仅支持分页，不支持条件筛选。

  • URI

    /wscrm-bus-api/open/group/page

  • 请求方式

    POST、Content-Type: application/json

  • 请求参数说明

参数名类型是否必填备注
currentInteger否页码，默认 1
pageSizeInteger否每页条数，默认 20
  • 请求示例
{
  "current": 1,
  "pageSize": 20
}
  • 响应参数说明
参数名类型是否必填备注
codeint是状态码
messageString否描述
dataObject否数据

data 参数说明

参数名类型是否必填备注
totalInteger是总记录数
sizeInteger是每页条数
currentInteger是当前页码
pagesInteger是总页数
recordsarray是社群列表

records 参数说明

参数名类型是否必填备注
groupWhatsIdString是群 id，群唯一标识
groupNameString否群名称
groupDescString否群描述，无数据时为空字符串
groupTypeInteger否群类型：1 普通群、2 公告群、3 社群
parentGroupIdString否父群 id（社群子群时有值），无数据时为空字符串
groupAdministratorList(String)否群管理员 WhatsApp 号码列表
languageTagString否群组语言，无数据时为空字符串
serialNumberString否群编号，无数据时为空字符串
remarkString否群备注，无数据时为空字符串
lastChatTimeString否最后发言时间，格式 yyyy-MM-dd HH:mm:ss；无数据时为空字符串
createByLong/String否创建人用户 id；无数据时为空字符串
  • 响应示例
{
  "code": 200,
  "message": "成功 ",
  "data": {
    "records": [
      {
        "groupWhatsId": "120363319748513635",
        "lastChatTime": "",
        "groupName": "API SocialEpoch",
        "groupAdministrator": ["628888777959"],
        "groupDesc": "",
        "groupType": 1,
        "parentGroupId": "",
        "languageTag": "",
        "serialNumber": "",
        "remark": "",
        "createBy": ""
      },
      {
        "groupWhatsId": "120363329406583946",
        "lastChatTime": "2026-06-10 10:20:18",
        "groupName": "WADesk外贸沟通群-3",
        "groupAdministrator": ["8615317302709", "8613563589897", "8618103105602"],
        "groupDesc": "欢迎大家加入【WADesk外贸沟通群】",
        "groupType": 1,
        "parentGroupId": "",
        "languageTag": "",
        "serialNumber": "",
        "remark": "",
        "createBy": ""
      }
    ],
    "total": 13,
    "size": 20,
    "current": 1,
    "pages": 1
  }
}

社群成员信息查询

  • 描述

    根据群 id 分页查询指定社群的成员列表，仅支持分页，不支持条件筛选。

  • URI

    /wscrm-bus-api/open/group/memberPage

  • 请求方式

    POST、Content-Type: application/json

  • 请求参数说明

参数名类型是否必填备注
infoObject是查询条件
currentInteger否页码，默认 1
pageSizeInteger否每页条数，默认 20

info 参数说明

参数名类型是否必填备注
groupWhatsIdString是群 id
  • 请求示例
{
  "current": 1,
  "pageSize": 20,
  "info": {
    "groupWhatsId": "120363047520944442"
  }
}
  • 响应参数说明
参数名类型是否必填备注
codeint是状态码
messageString否描述
dataObject否数据

data 参数说明

参数名类型是否必填备注
totalInteger是总记录数
sizeInteger是每页条数
currentInteger是当前页码
pagesInteger是总页数
recordsarray是群成员列表

records 参数说明

参数名类型是否必填备注
friendWhatsIdString是成员 WhatsApp 号码
avatarString否头像地址，无数据时为空字符串
pushNameString否成员昵称，无数据时为空字符串
statusInteger否成员状态：1 在群、2 已退群
roleInteger否成员角色：1 群主、2 管理员、3 普通群成员
countryCodeString否国家区号，无数据时为空字符串
chatCountInteger否发言次数
lastChatTimeString否最后发言时间，格式 yyyy-MM-dd HH:mm:ss；无数据时为空字符串
joinTimeString否进群时间，格式 yyyy-MM-dd HH:mm:ss；无数据时为空字符串
leaveTimeString否退群时间，格式 yyyy-MM-dd HH:mm:ss；无数据时为空字符串
intoCountInteger否历史在群次数
  • 响应示例
{
  "code": 200,
  "message": "成功 ",
  "data": {
    "records": [
      {
        "friendWhatsId": "8618730334344",
        "avatar": "",
        "pushName": "张三",
        "status": 1,
        "role": 1,
        "countryCode": "86",
        "chatCount": 15,
        "lastChatTime": "2025-06-20 14:30:00",
        "joinTime": "2025-01-10 09:00:00",
        "leaveTime": "",
        "intoCount": 1
      }
    ],
    "total": 1,
    "size": 20,
    "current": 1,
    "pages": 1
  }
}

导入群链接接口

  • URI

    /wscrm-bus-api/open/group/api/groupAnalysis

  • 请求方式 i

    POST、Content-Type: application/json

  • 说明

    导入群链接(之前导入过的也视为成功)

  • 请求参数说明

字段类型是否必填备注
tenantIdlong是公司 id
userNameString是管理员账号)
tokenString是token
createTimeString是创建时间
groupLinkListList(String)是群链接
  • 请求示例
{
  "tenantId": 123456,
  "userName": "yunyingbao",
  "token": "48ac86f77f26e4719a62d3b2c569a67b",
  "createTime": "2021-03-08 14:25:00",
  "groupLinkList": [
    "https://test/DQ3ifKjTEOv6Zp5zODQtVP",
    "https://test/EPXN27hnko67vdwQEBhqBY"
  ]
}
  • 响应参数说明
字段名称类型描述
codeintcode
messageString
dataObject导入结果

data参数说明

字段名称类型描述
successLinkList(String)成功导入链接
failLinkList(String)失败导入链接
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": {
    "successLink": ["https://test/EPXN27hnko67vdwQEBhqBY"],
    "failLink": ["https://test/DQ3ifKjTEOv6Zp5zODQtVP"]
  }
}

根据群链接获取群信息信息接口

  • URI

    /wscrm-bus-api/open/group/api/getInfo

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    给定一个加群链接，返回群名称，群 id ，以及当前在群成员人数

    (解析群链接需要一定时间,若未解析完成errorCode:538)

  • 请求参数说明

字段类型是否必填备注
tenantIdLong是公司 id
userNameString是管理员账号)
tokenString是token
createTimeString是创建时间
groupLinkListList(String)是加群链接
  • 请求示例
{
  "tenantId": 1223,
  "userName": "ykts",
  "token": "9eb3ce8c5fd0f98ee783696a860af2a5",
  "createTime": "2021-03-08 14:25:00",
  "groupLinkList": [
    "https://test/DQ3ifKjTEOv6Zp5zODQtVP",
    "https://test/EPXN27hnko67vdwQEBhqBY"
  ]
}
  • 响应参数说明
字段名称类型描述
codeintcode
messageString
dataList

data参数说明

字段名称类型描述
groupIdString群 id，群唯一标识
groupNameString群名称
memberCountint群成员数量
linkString群链接
errorCodeint错误码-正确为0, 错误详见码值表
errorMessageString错误信息
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": [
    {
      "link": "https://test/EPXN27hnko67vdwQEBhqBY",
      "groupId": "120363047520944442",
      "groupName": "13",
      "memberCount": 23,
      "errorCode": 0,
      "errorMessage": ""
    },
    {
      "link": "https://test/DQ3ifKjTEOv6Zp5zODQtVP",
      "groupId": "120363028860968958",
      "groupName": "ykts00003",
      "memberCount": 3,
      "errorCode": 0,
      "errorMessage": ""
    }
  ]
}

根据群链接获取具体群成员的信息接口

  • URI

    /wscrm-bus-api/open/group/api/getMemberV2

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    给定一个群id，返回当前在群成员

  • 请求参数说明

字段类型是否必填备注
tenantIdLong是公司 id
userNameString是管理员账号)
tokenString是验证 token
whatsIdString否指定whatsapp客服号码
createTimeString是创建时间
dataList(String)是群id
  • 请求示例:
{
  "tenantId": 1223,
  "userName": "ykts",
  "token": "9eb3ce8c5fd0f98ee783696a860af2a5",
  "createTime": "2021-03-08 14:25:00",
  "data": ["120363193885101672", "22508384307-1569973680"]
}
  • 响应参数说明
字段名称类型描述
codeintcode
messageString
dataList

data参数说明

字段名称类型描述
groupLinkString加群链接
groupIdString群 id，群唯一标识
groupMemberListList(String)群成员列表
errorCodeint错误码-正确为0, 错误详见码值表
errorMessageString错误信息
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": [
    {
      "groupLink": "https://test/E29F7siQ5ecEgabLbVhE6e",
      "groupId": "120xxxxxxxx",
      "groupName": "wa运营宝加群",
      "groupMemberList": [
        "8618730334344",
        "8618730334345",
        "8618730334344",
        "8618730334345"
      ],
      "errorCode": 0,
      "errorMessage": ""
    }
  ]
}

检索当前 whatsapp 所在内部群

  • URI

    /wscrm-bus-api/open/group/api/getMemberGroup

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    给定一个 whatsapp 账号，返回当前 whatsapp 账号所在公司内部群

  • 请求参数说明

字段类型是否必填备注
tenantIdlong是公司 id
userNameString是管理员账号)
tokenString是token
createTimeString是创建时间
infostring是whatsapp
  • 请求示例
{
  "tenantId": 123456,
  "userName": "yunyingbao",
  "token": "48ac86f77f26e4719a62d3b2c569a67b",
  "createTime": "2021-03-08 14:25:00",
  "info": "8618730334344"
}
  • 响应参数说明
字段名称类型描述
codeintcode
messageString
dataList

data参数说明

字段名称类型描述
groupWhatsIdstring群 id
groupNamestring群名称
groupLinkstring群链接(未导入的群链接可以为空)
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": [
    {
      "groupWhatsId": "120363069789899789",
      "groupName": "ykts00000029",
      "groupLink": "https://chat.whatsapp.com/CxskaTxKMYtCkSnTL5QPeY"
    },
    {
      "groupWhatsId": "120363044994344621",
      "groupName": "test11122",
      "groupLink": "https://chat.whatsapp.com/CN5JcKBvyrg7aUEC4PCZaF"
    },
    {
      "groupWhatsId": "120363078398672384",
      "groupName": "123",
      "groupLink": ""
    }
  ]
}

判断 whatsapp 是否 是群成员接口

  • URI

    /wscrm-bus-api/open/group/api/checkMember

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    给定一个 whatsapp 账号，检测是否是此公司下的内部群

    内部群:该公司成功导入的群链接群组

  • 请求参数说明

字段类型是否必填备注
tenantIdLong是公司 id
userNameString是管理员账号
tokenString是token
createTimeString是创建时间
infoString是whatsapp 手机号
  • 请求示例
{
  "tenantId": 123456,
  "userName": "yunyingbao",
  "token": "48ac86f77f26e4719a62d3b2c569a67b",
  "createTime": "2021-03-08 14:25:00",
  "info": "8618730334344"
}
  • 响应参数说明
字段名称类型描述
codeintcode
messageString
dataBoolean是否首次
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": true
}

根据群链接查询群活码信息接口

  • URI

    /wscrm-bus-api/open/group/api/getDisperseFlowGroupInfo

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    给定一个群链接，返回设置该群所在群活码的分流信息

  • 请求参数说明

字段类型是否必填备注
tenantIdLong是公司 id
userNameString是管理员账号
tokenString是token
createTimeString是创建时间
groupLinkString是群链接
  • 请求示例
{
  "tenantId": 123456,
  "userName": "yunyingbao",
  "token": "48ac86f77f26e4719a62d3b2c569a67b",
  "createTime": "2021-03-08 14:25:00",
  "groupLink": "https://chat.whatsapp.com/1212"
}
  • 响应参数说明
字段名称类型描述
codeintcode
messageString
dataList

data参数说明

字段名称类型描述
nameString分流名称
createTimeString分流创建时间
clickNumString分流链接总分流次数
urlString分流链接
noteString标签名称
groupIdString群id
memberNumInteger成员数量
memberList成员对象

member参数说明

字段名称类型描述
disperseFlowGroupIdLong分流ID
createTimeString该活码中此加群链接创建时间
useNumLong该活码中此加群链接分流次数(因为一个活码中可以设置多个群链接)
waUrlStringWhatsApp群链接
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": [
    {
      "id": 25582,
      "name": "miniso",
      "url": "http://192.168.1.4:16600/api/addgroup/qeomOzUb",
      "createTime": "2023-03-21 13:40:04",
      "note": "miniso",
      "clickNum": 2,
      "memberNum": 1,
      "groupId": "",
      "member": [
        {
          "disperseFlowGroupId": 25582,
          "waUrl": "https://chat.whatsapp.com/DQ3ifKjTEOv6Zp5zODQtVP",
          "createTime": "2023-03-21 13:40:04",
          "useNum": 2
        }
      ]
    }
  ]
}

查询活码访问记录接口

  • URI

    /wscrm-bus-api/open/group/api/getDisperseFlowVisiterRecord

  • 请求方式

    POST、Content-Type: application/json

  • 接口说明

    给定一个群链接，返回访问记录

  • 请求参数说明

字段类型是否必填备注
tenantIdLong是公司 id
userNameString是管理员账号)
tokenString是token
createTimeString是创建时间
groupLinkString是群链接
currentInteger否页码
pageSizeInteger否条数
  • 请求示例
{
  "tenantId": 123456,
  "userName": "yunyingbao",
  "token": "48ac86f77f26e4719a62d3b2c569a67b",
  "createTime": "2021-03-08 14:25:00",
  "groupLink": "https://chat.whatsapp.com/888888"
}
  • 响应参数说明
字段名称类型描述
codeintcode
messageString
dataList

data参数说明

字段名称类型描述
nameString分流名称
createTimeString访问时间
urlString分流链接
waUrlStringwhatsapp群链接(分流号码)
ipStringip
countryCodeString国家code
countryNameString国家名称
countryEnNameString国家英文名称
disperseFlowGroupIdString分流id
disperseFlowCustomerServiceIdString分流自定义服务id
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": [
    {
      "name": "问",
      "url": "http://www.batteroperation.com/gN7HXTT0",
      "ip": "20.187.107.54",
      "countryCode": "HK",
      "countryName": "香港(中国)",
      "countryEnName": "HongKong(China)",
      "createTime": "2023-03-09 11:20:12",
      "waUrl": "https://chat.whatsapp.com/888888",
      "disperseFlowGroupId": 25582,
      "disperseFlowCustomerServiceId": 25866
    }
  ]
}

群行为埋点通知

当 whatsapp 触发加群退群动作时，主动推送通知成员加群、退群的日志

  • WebHook

  • 配置 ID <GROUP_IN_OR_OUT_GROUP>

  • 请求参数说明

字段类型是否必填备注
accessTokenString是签名字符串 token
tenantIdint是公司 id
timestampLong是毫秒时间戳
dataList是格式[{},{}],详细如下(数量 0-50 条

data 参数说明

字段类型是否必填备注
idString是数据 id 标识(uuid)
friendWhatsIdString是whatsapp 手机号
actionTypeint是1 进群 2 退群
createTimeString是操作时间，进群时间或者退群时间
groupWhatsIdString是群 ID
groupLinkString否群链接
dataTypeint是是否是虚拟数据 数据类型 1 真实 2 虚拟
  • 请求示例
{
  "accessToken": "e6e18763d8d5a756d45c01486d7ad6742152ac",
  "callBackUrl": "host/wscrm-bus-api/part/callback/groupAction",
  "tenantId": 1238,
  "timestamp": 1667295870936,
  "data": [
    {
      "id": "30e873ab8f4840e2b610c414fe967327",
      "friendWhatsId": "8617633819542",
      "actionType": 1,
      "create_time": "2023-02-01 00:00:00",
      "groupWhatsId": "120xxxxx",
      "dataType": 1,
      "groupLink": "https://chat.xxx.com/CEwwCoiy7Qa1MVKex3x4p4"
    }
  ]
}
  • 响应示例
{
  "code": 200,
  "message": "Success",
  "data": ""
}
最近更新: