Skip to main content

Group link

About 4 min

Group link

  • URI

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

  • Request method

    POST、Content-Type: application/json

  • Description

    Import group links (previously imported are also considered successful)

Request params:

  • Request params
AttributeTypeRequiredDescription
tenantIdlongyestenant id
userNameStringyesuser name(login account)
tokenStringyestoken
createTimeStringyesrequest time (yyyy-MM-dd HH:mm:ss)
groupLinkListList(String)yesgroup link

Example request:

{
  "tenantId": 123456,
  "userName": "yunyingbao",
  "token": "48ac86f77f26e4719a62d3b2c569a67b",
  "createTime": "2021-03-08 14:25:00",
  "groupLinkList": [
    "https://test/DQ3ifKjTEOv6Zp5zODQtVP",
    "https://test/EPXN27hnko67vdwQEBhqBY"
  ]
}

Response:

AttributeTypeDescription
codeintcode
messageStringmessage
dataObjectdata

data

AttributeTypeDescription
successLinkList(String)success import group link
failLinkList(String)faild import group link

Example response

{
  "code": 200,
  "message": "Success",
  "data": {
    "successLink": ["https://test/EPXN27hnko67vdwQEBhqBY"],
    "failLink": ["https://test/DQ3ifKjTEOv6Zp5zODQtVP"]
  }
}
  • URI

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

  • Request method

    POST、Content-Type: application/json

  • Description

    Given a group link, return the group name, group ID, and the number of current group members

    (It takes some time to parse the group link, if the resolution is not completed errorCode:538)

Request params:

  • Request params
AttributeTypeRequiredDescription
tenantIdLongyestenant id
userNameStringyesuser name (login account)
tokenStringyestoken
createTimeStringyesrequest time (yyyy-MM-dd HH:mm:ss)
groupLinkListList(String)yesgroup link list

Example request:

{
  "tenantId": 1223,
  "userName": "ykts",
  "token": "9eb3ce8c5fd0f98ee783696a860af2a5",
  "createTime": "2021-03-08 14:25:00",
  "groupLinkList": [
    "https://test/DQ3ifKjTEOv6Zp5zODQtVP",
    "https://test/EPXN27hnko67vdwQEBhqBY"
  ]
}

Response:

AttributeTypeDescription
codeintcode
messageString
dataList

data:

AttributeTypeDescription
groupIdStringgroup id
groupNameStringgroup name
memberCountIntegergroup member count
linkStringgroup link
errorCodeIntegererror code
errorMessageStringerror message

Example response:

{
  "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

  • Request method

    POST、Content-Type: application/json

  • Description

    Given a group id, the current group members are returned

Request params:

AttributeTypeis yesDescription
tenantIdlongyestenant id
userNameStringyesuser name(login account)
tokenStringyestoken
createTimeStringyesrequest time (yyyy-MM-dd HH:mm:ss)
dataList(String)yesgroup id list

Example request:

{
  "tenantId": 1223,
  "userName": "ykts",
  "token": "9eb3ce8c5fd0f98ee783696a860af2a5",
  "createTime": "2021-03-08 14:25:00",
  "data": [
    "120363193885101672",
    "22508384307-1569973680"
  ]
}

Response:

AttributeTypeDescription
codeintcode
messageStringmessage
dataListdata

data:

AttributeTypeDescription
groupLinkStringgroup link
groupIdStringgroup id
groupMemberListList(String)group member list
errorCodeIntegererror code
errorMessageStringerror message

Example response:

{
  "code": 200,
  "message": "Success",
  "data": [
    {
      "groupLink": "https://test/E29F7siQ5ecEgabLbVhE6e",
      "groupId": "120xxxxxxxx",
      "groupName": "wa scrm add group",
      "groupMemberList": [
        "8618730334344",
        "8618730334345",
        "8618730334344",
        "8618730334345"
      ],
      "errorCode": 0,
      "errorMessage": ""
    }
  ]
}

Check whatsapp is exists tenant whatsapp group api

  • URI

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

  • Request method

    POST、Content-Type: application/json

  • Description

    Given a WhatsApp account, return the internal group of the company where the current WhatsApp account belongs

Request params:

AttributeTypeRequiredDescription
tenantIdlongyestenant id
userNameStringyesuser name (login account)
tokenStringyestoken
createTimeStringyesrequest time (yyyy-MM-dd HH:mm:ss)
infostringyeswhatsapp

Example request:

{
  "tenantId": 123456,
  "userName": "yunyingbao",
  "token": "48ac86f77f26e4719a62d3b2c569a67b",
  "createTime": "2021-03-08 14:25:00",
  "info": "8618730334344"
}

Response:

AttributeTypeDescription
codeintcode
messageStringmessage
dataListdata

data:

AttributeTypeDescription
groupWhatsIdstringgroup id
groupNamestringgroup name
groupLinkstringgroup link

Example response:

{
  "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": ""
    }
  ]
}

Check whatsapp is group member api

  • URI

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

  • Request method

    POST、Content-Type: application/json

  • Description

    Given a WhatsApp account, detect whether it is an internal group under this company

    Internal group: The group link group that the company successfully imported

Request params:

AttributeTypeRequiredDescription
tenantIdLongyestenant id
userNameStringyesuser name(login account)
tokenStringyestoken
createTimeStringyesrequest time (yyyy-MM-dd HH:mm:ss)
infoStringyeswhatsapp

Example request:

{
  "tenantId": 123456,
  "userName": "yunyingbao",
  "token": "48ac86f77f26e4719a62d3b2c569a67b",
  "createTime": "2021-03-08 14:25:00",
  "info": "8618730334344"
}

Response:

AttributeTypeDescription
codeintcode
messageStringmessage
dataBooleandata

Example response:

{
  "code": 200,
  "message": "Success",
  "data": true
}
  • URI

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

  • Request method

    POST、Content-Type: application/json

  • Description

    Given a group link, the distribution information of the group liveness code to be set is returned

Request params:

AttributeTypeRequiredDescription
tenantIdlongyestenant id
userNameStringyesuser name (login account)
tokenStringyestoken
createTimeStringyesrequest time (yyyy-MM-dd HH:mm:ss)
groupLinkstringyesgroup link list

Example request:

{
  "tenantId": 123456,
  "userName": "yunyingbao",
  "token": "48ac86f77f26e4719a62d3b2c569a67b",
  "createTime": "2021-03-08 14:25:00",
  "groupLink": "https://chat.whatsapp.com/1212"
}

Response:

AttributeTypeDescription
codeintcode
messageStringmessage
dataListdata

data:

AttributeTypeDescription
nameStringdistributary name
createTimeStringcreate time
clickNumStringclick num
urlStringurl
noteStringname
groupIdStringgroup id
memberNumIntegermember num
memberdataListmember

member

AttributeTypeDescription
disperseFlowGroupIdLongdisperse Flow Group ID
createTimeStringcreate time
useNumLongThe number of times this group link is diverted in this livecode (because multiple group links can be set in one livecode)
waUrlStringWhatsApp group url

Example response:

{
  "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
        }
      ]
    }
  ]
}

Query disperseFlow visiter record api

  • URI

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

  • Request method

    POST、Content-Type: application/json

  • Description

    Given a swarm link, the access record is returned

Request params:

AttributeTypeRequiredDescription
tenantIdlongtenant id
userNameStringyesuser name(login account)
tokenStringyestoken
createTimeStringyesrequest time (yyyy-MM-dd HH:mm:ss)
groupLinkstringyesgroup link
currentIntegernocurrent page
pageSizeIntegernopage size

Example request:

{
  "tenantId": 123456,
  "userName": "yunyingbao",
  "token": "48ac86f77f26e4719a62d3b2c569a67b",
  "createTime": "2021-03-08 14:25:00",
  "groupLink": "https://chat.whatsapp.com/888888"
}

Response:

AttributeTypeDescription
codeintcode
messageStringmessage
dataListdata

data:

AttributeTypeDescription
nameStringname
createTimeStringtime
urlStringurl
waUrlStringwhatsapp group link
ipStringip
countryCodeStringcountry code
countryNameStringcountry name
countryEnNameStringcountry en name
disperseFlowGroupIdStringid
disperseFlowCustomerServiceIdStringservice id

Example response:

{
  "code": 200,
  "message": "Success",
  "data": [
    {
      "name": "yewen",
      "url": "http://www.batteroperation.com/gN7HXTT0",
      "ip": "20.187.107.54",
      "countryCode": "HK",
      "countryName": "hongkang(china)",
      "countryEnName": "HongKong(China)",
      "createTime": "2023-03-09 11:20:12",
      "waUrl": "https://chat.whatsapp.com/888888",
      "disperseFlowGroupId": 25582,
      "disperseFlowCustomerServiceId": 25866
    }
  ]
}
Last update:
Contributors: zhangzhuangzhuang,罗英杰