获取IM群列表。
接口说明
-
在调用此接口前，请确保您已有创建成功的 IM 群。
-
若您没有已创建成功的 IM 群，暂仅支持通过 AddChatGroup 接口创建 IM 群。
-
此接口的非必填参数为 IM 群列表的筛选条件，若不填写，则查询全部 IM 群列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| BusinessNumber |
string |
是 |
商家号码。 |
8613800*** |
| ChannelType |
string |
否 |
类型。取值：
说明
暂仅支持 WhatsApp 通道类型的消息。 |
|
| CustSpaceId |
string |
是 |
ISV 子客户的 SpaceId/实例 ID。即通道 ID，在通道管理界面查看。 |
cams-x*** |
| GroupStatus |
string |
否 |
群组状态。取值：
|
ACTIVE |
| Subject |
string |
否 |
群组标题。 |
test |
| Page |
object |
是 |
分页信息。 |
|
| Size |
integer |
是 |
每页显示数量。 |
20 |
| Index |
integer |
是 |
页数。 |
1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| AccessDeniedDetail |
string |
访问被拒绝详细信息。 |
None |
| Message |
string |
提示信息，当返回异常时有值。 |
None |
| RequestId |
string |
请求 ID。 |
90E63D28-E31D-1EB2-8939-A94866411B2O |
| Data |
object |
返回数据。 |
|
| Total |
integer |
总记录条数。 |
51 |
| List |
array<object> |
群组列表。 |
|
|
object |
群组对象。 |
||
| Description |
string |
描述。 |
test |
| BusinessNumber |
string |
商家号码。 |
8613800** |
| InviteLink |
string |
邀请链接。 |
https://chat.whatsapp.com/*** |
| GroupStatus |
string |
群组状态。 |
ACTIVE |
| ProfilePictureFile |
string |
群组头像。 |
https://*********/png.jpg |
| Subject |
string |
群组标题。 |
This is a test subject |
| GroupId |
string |
群组 ID。 |
EA30d*** |
| Code |
string |
请求状态码。取值：
|
OK |
| Success |
boolean |
是否调用成功。取值：
|
true |
示例
正常返回示例
JSON格式
{
"AccessDeniedDetail": "None",
"Message": "None",
"RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
"Data": {
"Total": 51,
"List": [
{
"Description": "test",
"BusinessNumber": "8613800**",
"InviteLink": "https://chat.whatsapp.com/***",
"GroupStatus": "ACTIVE",
"ProfilePictureFile": "https://*********/png.jpg",
"Subject": "This is a test subject",
"GroupId": "EA30d***"
}
]
},
"Code": "OK",
"Success": true
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。