ListAIAgentPhoneNumber - 罗列用户电话资源

罗列用户电话资源接口。

接口说明

该接口允许用户根据每页记录数(PageSize)和当前页码(PageNumber)来查询用户电话资源。返回结果包含电话号码和对应状态。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:ListAIAgentPhoneNumbernone
*全部资源
*

请求参数

名称类型必填描述示例值
PageSizelong

分页大小,每页显示条数。默认值为 50,最大值为 100。

50
PageNumberlong

页码。默认值为 1。

1
Numberstring

电话号码,填写 Number 直接查询对应号码。

139xxxxxxxxx
Statusinteger

查询的目标号码的状态。

  • 1: "开通处理中"。

  • 2: "正常"。

  • 3: "注销中"。

  • 4: "已注销"。

2

返回参数

名称类型描述示例值
object

Schema of Response

Dataarray<object>

返回数据数组

Dataobject

返回数据。

PhoneNumberstring

电话号码。

132*****683
Statusinteger

号码状态。

  • 1: "开通处理中"。

  • 2: "正常"。

  • 3: "注销中"。

  • 4: "已注销"。

1
RequestIdstring

请求 ID。

************16-412C-B127-******
TotalNumberinteger

查询到的电话总数。

186
PageNumberinteger

页码

1
PageSizeinteger

每页返回的记录数

10

示例

正常返回示例

JSON格式

{
  "Data": [
    {
      "PhoneNumber": "132*****683",
      "Status": 1
    }
  ],
  "RequestId": "************16-412C-B127-******",
  "TotalNumber": 186,
  "PageNumber": 1,
  "PageSize": 10
}

错误码

访问错误中心查看更多错误码。