You need to enable JavaScript to run this app.
导航
ListContactGroupByIds
最近更新时间:2024.09.20 11:34:24首次发布时间:2021.11.10 18:21:34

查询指定联系组的详细信息。

使用限制

调用一次接口最多支持查询100个联系组。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com?Action=ListContactGroupByIds&Version=2018-01-01
ServiceName : Volc_Observe
Region : cn-beijing 
AccessKey : xxx
SecretKey : xxx

调试

请求参数

Query

参数类型是否必选示例值描述
ActionStringListContactGroupByIds接口名称。当前 API 的名称为 ListContactGroupByIds
VersionString2018-01-01接口版本。当前 API 的版本为 2018-01-01

Body

参数类型是否必选示例值描述
IdsArray of String["145258255725730****","145258255725730****"]联系组ID。

返回参数

参数类型示例值描述
DataArray of ContactGroupVO-符合条件的联系组的详细信息。

ContactGroupVO

参数类型示例值描述
IdString145080093687100****联系组的ID。
NameString默认告警联系组联系组名称。
ContactsArray of ContactsVO-联系组中的联系信息。
AccountIdString100000****创建本联系组的账号ID。
CreatedAtString2021-10-20T20:27:53+08:00联系组的创建时间。
UpdatedAtString2021-10-20T20:27:53+08:00联系组的更新时间。
DescriptionStringThis is a group.联系组的描述。

ContactsVO

参数类型示例值描述
IdString145262463627244****联系人ID。
NameStringname1联系人名称。
EmailString1234567****联系人邮箱地址。
PhoneString1234567****联系人手机号码。

请求示例

POST https://open.volcengineapi.com?Action=ListContactGroupByIds&Version=2018-01-01
ServiceName: Volc_Observe
Region: cn-beijing
AccessKey: xxx
SecretKey: xxx
{
    "Ids":[
        "145258255725730****",
        "145258255725730****"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022092215001701017423503808******",
        "Action": "ListContactGroupByIds",
        "Version": "2018-01-01",
        "Service": "Volc_Observe",
        "Region": ""
    },
    "Result": {
        "Data": [
            {
                "Id": "145258255725730****",
                "Name": "group1",
                "AccountId": "100000****",
                "Description": "",
                "CreatedAt": "2021-10-20T20:28:22+08:00",
                "UpdatedAt": "2021-10-20T20:28:22+08:00",
                "Contacts": [
                    {
                        "Id": "145080104031932****",
                        "Name": "name1",
                        "Phone": "1234567****",
                        "Email": "name1.account@xxx.com"
                    },
                    {
                        "Id": "145247681036000****",
                        "Name": "name2",
                        "Phone": "1234567****",
                        "Email": "name2.account@xxx.com"
                    }
                ]
            }
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请参见错误码