查询联系人组
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /contactGroups HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| pageSize |
integer |
否 |
每页大小。默认 100 |
20 |
| pageNumber |
integer |
否 |
页面。默认为 1 |
1 |
| contactGroupIds |
array |
否 |
联系组 ID。 |
|
|
string |
否 |
联系组 ID。 |
test |
|
| name |
string |
否 |
联系人名称 |
test |
| workspace |
string |
否 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
响应内容结构 |
||
| contactGroups |
array<object> |
联系组。 |
|
|
object |
联系组。 |
||
| contactGroupId |
string |
联系组唯一标识。 |
test |
| contactIds |
array |
联系人 ID。 |
|
|
string |
联系人 ID。 |
[\"演示会议\"] |
|
| name |
string |
联系人名称。 |
test |
| workspace |
string |
||
| pageNumber |
integer |
页面。默认为 1 |
1 |
| pageSize |
integer |
每页大小。默认 100 |
10 |
| requestId |
string |
请求的唯一标识 ID |
8FDE2569-626B-5176-9844-28877A***** |
| total |
integer |
总条数。 |
15 |
示例
正常返回示例
JSON格式
{
"contactGroups": [
{
"contactGroupId": "test",
"contactIds": [
"[\\\"演示会议\\\"]"
],
"name": "test",
"workspace": ""
}
],
"pageNumber": 1,
"pageSize": 10,
"requestId": "8FDE2569-626B-5176-9844-28877A*****",
"total": 15
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParameter | %s is missing or invalid. | 参数%s缺失或不合法。 |
| 500 | InternalUnknownError | The request processing has failed due to some unknown error. | 服务运行错误。 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。