获取IM群成员列表。
接口说明
通过 API 获取 IM 群成员列表功能属于 Meta 内测功能，请联系您的商务经理申请加白。
-
在调用此接口之前，请确保您创建成功的 IM 群已添加 IM 群邀请链接且已有成员通过链接进入 IM 群。
-
若您没有已创建成功的 IM 群，可通过 AddChatGroup 、 AddChatGroupInviteLink 接口创建并添加 IM 群邀请链接。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| BusinessNumber |
string |
是 |
商家号码。可通过 ListChatGroup 接口查看商家号码。 |
8613800*** |
| ChannelType |
string |
否 |
类型。取值：
说明
暂仅支持 WhatsApp 通道类型消息。 |
|
| GroupId |
string |
是 |
群组 ID。可通过 ListChatGroup 接口查看群组 ID。 |
EA939**** |
| CustSpaceId |
string |
是 |
ISV 子客户的 SpaceId/实例 ID。即通道 ID，在通道管理界面查看。 |
cams-k*** |
| Page |
object |
否 |
分页信息。 |
|
| Size |
integer |
否 |
每页显示数量。 |
20 |
| Index |
integer |
否 |
页数。 |
1 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| AccessDeniedDetail |
string |
访问被拒绝详细信息。 |
None |
| Message |
string |
错误提示信息。 |
无 |
| RequestId |
string |
请求 ID。 |
90E63D28-E31D-1EB2-8939-A94866411B2O |
| Data |
object |
返回数据。 |
|
| Total |
integer |
总记录条数。 |
8 |
| List |
array<object> |
群组成员列表。 |
|
|
object |
群组成员信息。 |
||
| ParticipantNumber |
string |
群组成员。 |
861382*** |
| Code |
string |
请求状态码。取值：
|
OK |
| Success |
boolean |
是否调用成功。取值：
|
true |
示例
正常返回示例
JSON格式
{
"AccessDeniedDetail": "None",
"Message": "无",
"RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
"Data": {
"Total": 8,
"List": [
{
"ParticipantNumber": "861382***"
}
]
},
"Code": "OK",
"Success": true
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。