You need to enable JavaScript to run this app.
导航

ListContactsByIds

最近更新时间2023.03.31 16:12:21

首次发布时间2021.11.10 18:21:34

调用ListContactsByIds接口查询指定联系人的详细信息。

Request URL

POST https://open.volcengineapi.com?Action=ListContactsByIds&Version=2018-01-01
ServiceName : Volc_Observe
Region : cn-beijing 
AccessKey : xxx
SecretKey : xxx

请求参数

名称

类型

是否必填

示例值

描述

Ids

Array

["145258255725730****", "145258255725730****"]

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

PageNumber

Integer

20

分页查询时每页的行数,取值:> 0 ,默认值为1。

PageSize

Integer

1

列表的页码,默认值为 10。要查询的列表范围为:
实际起始位置 = PageNumber * PageSize
实际终止位置 = PageNumber * (PageSize + 1)

返回数据

参数

类型

示例值

描述

Data

Array

-

符合条件的联系人的详细信息。具体请参见Data数据结构

PageNumber

Integer

1

当前页码。

PageSize

Integer

10

当前分页的行数。

TotalCount

Integer

4

符合条件的联系组总数。

Data数据结构

参数

类型

示例值

描述

Id

String

145262463627244****

联系人ID。

Name

String

name1

联系人名称。

Phone

String

1234567****

联系人手机号码。

Email

String

name1.account@xxx.com

联系人邮箱地址。

请求示例

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"
            }
        ],
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 3
    }
}