最近更新时间:2024.04.24 11:09:34
首次发布时间:2021.11.10 18:21:35
调用ListContacts接口获取联系人列表,支持搜索联系人名称的关键字进行模糊查询。
POST https://open.volcengineapi.com?Action=ListContacts&Version=2018-01-01
ServiceName : Volc_Observe Region : cn-beijing AccessKey : xxx SecretKey : xxx
名称 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Name | String | 否 |
| 联系人名称的关键字,支持模糊查询。 |
Phone | String | 否 |
| 联系人电话的关键字,支持模糊查询。 |
String | 否 |
| 联系人邮箱的关键字,支持模糊查询。 | |
PageNumber | Integer | 否 |
| 列表的页码,取值>0,默认值为1。要查询的列表范围为: |
PageSize | Integer | 否 |
| 分页查询时每页的行数,默认值为10。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Array | - | 符合条件的联系人的详细信息。具体请参见Data数据结构。 |
PageNumber | Integer |
| 当前页码。 |
PageSize | Integer |
| 当前分页的行数。 |
TotalCount | Integer |
| 符合条件的联系组总数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String |
| 联系人ID。 |
Name | String |
| 联系人名称。 |
Phone | String |
| 联系人手机号码。 |
String |
| 联系人邮箱地址。 | |
ContactGroups | Array | - | 联系人关联的联系组的信息。具体请参见 ContactGroups数据结构。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
AccountId | String |
| 创建本联系组的账号ID。 |
Id | String |
| 联系组的ID。 |
Name | String |
| 联系组名称。 |
Description | String |
| 联系组的描述。 |
CreatedAt | String |
| 联系组的创建时间。 |
UpdateAt | String |
| 联系组的更新时间。 |
POST https://open.volcengineapi.com?Action=ListContacts&Version=2018-01-01 ServiceName=Volc_Observe Region=cn-beijing AccessKey=xxx SecretKey=xxx { "PageSize":10, "PageNumber":1, "Name":"name1", "Phone":"133****4345", "Email":"jackemail@xxx.com" }
{ "ResponseMetadata": { "RequestId": "2022092215001701017423503808******", "Action": "ListContacts", "Version": "2018-01-01", "Service": "Volc_Observe", "Region": "" }, "Result": { "Data": [ { "Id": "145262463627244****", "Name": "name1", "Phone": "", "Email": "name1.account@xxx.com", "ContactGroups": [ { "Id": "145080093687100****", "Name": "默认告警联系组", "AccountId": "100000****", "Description": "", "CreatedAt": "2021-10-20T20:27:53+08:00", "UpdatedAt": "2021-10-20T20:27:53+08:00", } ] } ], "PageNumber": 1, "PageSize": 10, "TotalCount": 3 } }