文档首页> 华为云会议 Meeting> 服务端API参考> 查询企业通讯录> 接口参考> 查询企业外部联系人
更新时间：2023-12-29 GMT+08:00
在线调试
CLI示例
查看PDF

查询企业外部联系人

功能介绍

企业用户（含管理员）通过该接口查询该企业的外部联系人或者个人外部联系人。

调试

您可以在API Explorer中调试该接口。

URI

GET /v1/usg/abs/external-contacts

请求参数

表1 Query参数

参数

是否必选

参数类型

位置

描述

offset

否

Integer

Query

查询偏移量,若超过最大数量，则返回最后一页的数据。 默认值：0。

最小值：0

缺省值：0

limit

否

Integer

Query

查询数量。 默认值：10。

最小值：1

最大值：500

缺省值：10

searchKey

否

String

Query

搜索条件。支持名称、手机、邮箱模糊搜索。

最小长度：0

最大长度：1024

searchScope

否

String

Query

搜索范围。默认值为ALL。

  • PERSONAL - 查询个人外部联系人

  • CORP - 查询企业外部联系人

  • ALL - 查询所有外部联系人

缺省值：ALL
表2 请求Header参数

参数

是否必选

参数类型

位置

描述

X-Access-Token

是

String

Header

Access Token。通过执行App ID鉴权接口返回的accessToken。

X-Request-Id

否

String

Header

请求requestId，用来标识一路请求，用于问题跟踪定位，建议使用UUID，若不携带，则后台自动生成。

Accept-Language

否

String

Header

语言参数，默认为中文zh-CN，英文为en-US。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

offset

Integer

页面起始页，从0开始。

limit

Integer

每页显示的条目数量。 默认值：10。

count

Integer

总数量。

data

Array of ExternalContactDTO objects

分页查询外部联系人信息。
表4 ExternalContactDTO

参数

参数类型

描述

otherNumber

String

其他号码。

说明：

  • 其他号码必须以国家码作为前缀

  • otherNumber填写时，otherNumberCountry也必须填写

  • 如果要清空手机号配置，则otherNumberCountry和otherNumber都要置为""

最小长度：0

最大长度：32

otherNumberCountry

String

手机号所属的国家 。

最小长度：0

最大长度：32

country

String

手机号所属的国家。

缺省值：chinaPR

最大长度：255

phone

String

手机号。

说明：

  • 手机号必须以国家码作为前缀

  • phone填写时，country也必须填写

  • 如果要清空手机号配置，则country和phone都要置为""

最小长度：0

最大长度：32

email

String

邮箱。

最小长度：0

最大长度：255

corpName

String

公司名称。

最小长度：0

最大长度：64

deptName

String

部门。

最小长度：0

最大长度：64

position

String

职务。

最小长度：0

最大长度：64

address

String

个人地址。

最小长度：0

最大长度：1024

remarks

String

备注。

最小长度：0

最大长度：1024

id

String

外部联系人UUID。

name

String

姓名。

customNumber

String

外部联系人自定义号码。

说明：

仅VDC场景下使用。

updateTime

Number

用户信息最后更新时间戳。

type

String

外部联系人类型。

  • PERSONAL：个人外部联系人

  • CORP：企业外部联系人

请求示例

GET https://{endpoint}/v1/usg/abs/external-contacts?offset=0&limit=5&searchScope=CORP

响应示例

状态码： 200

响应成功

{
  "offset" : 0,
  "limit" : 5,
  "count" : 1,
  "data" : [ {
    "otherNumber" : "",
    "otherNumberCountry" : "",
    "country" : "chinaPR",
    "phone" : "+86135xxxx0611",
    "email" : "******",
    "corpName" : null,
    "deptName" : null,
    "position" : null,
    "address" : null,
    "remarks" : null,
    "id" : "af4aaae4b29d45649e3c61f48ee2f64b",
    "name" : "李四",
    "customNumber" : null,
    "type" : "CORP",
    "updateTime" : 1665994358499
  } ]
}

状态码

状态码

描述

200

响应成功

错误码

当您使用华为云会议服务端API时，如果遇到“MMC”或者“USG”开头的错误码，请参考华为云API错误中心。

父主题： 接口参考