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

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

使用限制

调用一次接口最多可查询100个联系人。

请求说明

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

调试

请求参数

Query

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

Body

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

返回参数

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

ContactsVO

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

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022092215001701017423503808******",
        "Action": "ListContactsByIds",
        "Version": "2018-01-01",
        "Service": "Volc_Observe",
        "Region": ""
    },
    "Result": {
        "Data": [
            {
                "Id": "145262463627244****",
                "Name": "name1",
                "Phone": "",
                "Email": "name1.account@xxx.com"
            }
        ]
    }
}

错误码

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