Group link
Group link
Import grop 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
Attribute | Type | Required | Description |
---|---|---|---|
tenantId | long | yes | tenant id |
userName | String | yes | user name(login account) |
token | String | yes | token |
createTime | String | yes | request time (yyyy-MM-dd HH:mm:ss) |
groupLinkList | List(String) | yes | group link |
Example request:
{
"tenantId": 123456,
"userName": "yunyingbao",
"token": "48ac86f77f26e4719a62d3b2c569a67b",
"createTime": "2021-03-08 14:25:00",
"groupLinkList": [
"https://test/DQ3ifKjTEOv6Zp5zODQtVP",
"https://test/EPXN27hnko67vdwQEBhqBY"
]
}
Response:
Attribute | Type | Description |
---|---|---|
code | int | code |
message | String | message |
data | Object | data |
data
Attribute | Type | Description |
---|---|---|
successLink | List(String) | success import group link |
failLink | List(String) | faild import group link |
Example response
{
"code": 200,
"message": "Success",
"data": {
"successLink": ["https://test/EPXN27hnko67vdwQEBhqBY"],
"failLink": ["https://test/DQ3ifKjTEOv6Zp5zODQtVP"]
}
}
Get Group infomation by group link api
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
Attribute | Type | Required | Description |
---|---|---|---|
tenantId | Long | yes | tenant id |
userName | String | yes | user name (login account) |
token | String | yes | token |
createTime | String | yes | request time (yyyy-MM-dd HH:mm:ss) |
groupLinkList | List(String) | yes | group 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:
Attribute | Type | Description |
---|---|---|
code | int | code |
message | String | |
data | List |
data:
Attribute | Type | Description |
---|---|---|
groupId | String | group id |
groupName | String | group name |
memberCount | Integer | group member count |
link | String | group link |
errorCode | Integer | error code |
errorMessage | String | error 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": ""
}
]
}
Get group member by group link api
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:
Attribute | Type | is yes | Description |
---|---|---|---|
tenantId | long | yes | tenant id |
userName | String | yes | user name(login account) |
token | String | yes | token |
createTime | String | yes | request time (yyyy-MM-dd HH:mm:ss) |
data | List(String) | yes | group id list |
Example request:
{
"tenantId": 1223,
"userName": "ykts",
"token": "9eb3ce8c5fd0f98ee783696a860af2a5",
"createTime": "2021-03-08 14:25:00",
"data": [
"120363193885101672",
"22508384307-1569973680"
]
}
Response:
Attribute | Type | Description |
---|---|---|
code | int | code |
message | String | message |
data | List | data |
data:
Attribute | Type | Description |
---|---|---|
groupLink | String | group link |
groupId | String | group id |
groupMemberList | List(String) | group member list |
errorCode | Integer | error code |
errorMessage | String | error 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:
Attribute | Type | Required | Description |
---|---|---|---|
tenantId | long | yes | tenant id |
userName | String | yes | user name (login account) |
token | String | yes | token |
createTime | String | yes | request time (yyyy-MM-dd HH:mm:ss) |
info | string | yes |
Example request:
{
"tenantId": 123456,
"userName": "yunyingbao",
"token": "48ac86f77f26e4719a62d3b2c569a67b",
"createTime": "2021-03-08 14:25:00",
"info": "8618730334344"
}
Response:
Attribute | Type | Description |
---|---|---|
code | int | code |
message | String | message |
data | List | data |
data:
Attribute | Type | Description |
---|---|---|
groupWhatsId | string | group id |
groupName | string | group name |
groupLink | string | group 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:
Attribute | Type | Required | Description |
---|---|---|---|
tenantId | Long | yes | tenant id |
userName | String | yes | user name(login account) |
token | String | yes | token |
createTime | String | yes | request time (yyyy-MM-dd HH:mm:ss) |
info | String | yes |
Example request:
{
"tenantId": 123456,
"userName": "yunyingbao",
"token": "48ac86f77f26e4719a62d3b2c569a67b",
"createTime": "2021-03-08 14:25:00",
"info": "8618730334344"
}
Response:
Attribute | Type | Description |
---|---|---|
code | int | code |
message | String | message |
data | Boolean | data |
Example response:
{
"code": 200,
"message": "Success",
"data": true
}
Query group active code by group link api
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:
Attribute | Type | Required | Description |
---|---|---|---|
tenantId | long | yes | tenant id |
userName | String | yes | user name (login account) |
token | String | yes | token |
createTime | String | yes | request time (yyyy-MM-dd HH:mm:ss) |
groupLink | string | yes | group link list |
Example request:
{
"tenantId": 123456,
"userName": "yunyingbao",
"token": "48ac86f77f26e4719a62d3b2c569a67b",
"createTime": "2021-03-08 14:25:00",
"groupLink": "https://chat.whatsapp.com/1212"
}
Response:
Attribute | Type | Description |
---|---|---|
code | int | code |
message | String | message |
data | List | data |
data:
Attribute | Type | Description |
---|---|---|
name | String | distributary name |
createTime | String | create time |
clickNum | String | click num |
url | String | url |
note | String | name |
groupId | String | group id |
memberNum | Integer | member num |
member | dataList | member |
member
Attribute | Type | Description |
---|---|---|
disperseFlowGroupId | Long | disperse Flow Group ID |
createTime | String | create time |
useNum | Long | The number of times this group link is diverted in this livecode (because multiple group links can be set in one livecode) |
waUrl | String | WhatsApp 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:
Attribute | Type | Required | Description |
---|---|---|---|
tenantId | long | 是 | tenant id |
userName | String | yes | user name(login account) |
token | String | yes | token |
createTime | String | yes | request time (yyyy-MM-dd HH:mm:ss) |
groupLink | string | yes | group link |
current | Integer | no | current page |
pageSize | Integer | no | page size |
Example request:
{
"tenantId": 123456,
"userName": "yunyingbao",
"token": "48ac86f77f26e4719a62d3b2c569a67b",
"createTime": "2021-03-08 14:25:00",
"groupLink": "https://chat.whatsapp.com/888888"
}
Response:
Attribute | Type | Description |
---|---|---|
code | int | code |
message | String | message |
data | List | data |
data:
Attribute | Type | Description |
---|---|---|
name | String | name |
createTime | String | time |
url | String | url |
waUrl | String | whatsapp group link |
ip | String | ip |
countryCode | String | country code |
countryName | String | country name |
countryEnName | String | country en name |
disperseFlowGroupId | String | id |
disperseFlowCustomerServiceId | String | service 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
}
]
}