首页 云呼叫中心 API参考 API目录 号码 ListPhoneNumbers - 获取号码列表

ListPhoneNumbers - 获取号码列表

调用ListPhoneNumbers获取指定实例下的号码列表。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求参数

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

实例ID。

ccc-test
SearchPatternstring

根据号码进行模糊匹配,非必填,默认为空,为空表示不过滤。

0833
Usagestring

号码的用途,非必填,默认为空,为空表示不过滤。

Bidirection
枚举值:
- Outbound: 呼出
- Inbound: 呼入
- Bidirection: 呼入和呼出
Activeboolean

号码是否可用,非必填,默认为空,为空表示不过滤。

true
PageNumberinteger

分页序号,范围1-100。

1
PageSizeinteger

分页大小,范围1-100。

20

返回参数

名称类型描述示例值
object
HttpStatusCodeinteger

HTTP状态码。

200
RequestIdstring

请求ID。

BA03159C-E808-4FF1-B27E-A61B6E888D7F
Codestring

响应码。

OK
Messagestring

响应信息。

Dataobject

数据。

PageNumberinteger

分页序号,范围1-100

1
PageSizeinteger

分页序号,范围1-100

20
TotalCountinteger

总数。

1
Listarray

号码列表。

object
Activeboolean

号码是否可用。

true
CreateTimestring

号码创建时间,即关联到实例的时间,格式为Unix时间戳,单位毫秒。

1617958538000
UserIdstring

坐席ID,如果此参数不为空,说明该号码是座席专属号码。

agent@ccc-test
Tagsstring

号码业务标签,主要用于给号码打标,做一些扩展业务,普通客户无需关心。

M1
Citystring

号码归属地市。

乐山
InstanceIdstring

实例ID。

ccc-test
Usagestring

号码用途。

Bidirection
枚举值:
- Outbound: 呼出
- Inbound: 呼入
- Bidirection: 呼入和呼出
ContactFlowNamestring

号码关联的IVR联系流名称。

默认联系流
Providerstring

号码供应商名称。

alicom
Numberstring

号码。

08330011****
ContactFlowIdstring

号码关联的IVR联系流ID。

a3fb6c62-9b49-4942-ae5b-cf2abd4123ek
Provincestring

号码归属地省。

四川
SkillGroupsarray

号码关联的技能组列表。

object
DisplayNamestring

技能组展示名。

测试技能组
InstanceIdstring

实例ID。

ccc-test
Namestring

技能组名称。

skillgroup
SkillGroupIdstring

技能组ID。

skillgroup@ccc-test

示例

正常返回示例

JSON格式

{
  "HttpStatusCode": 200,
  "RequestId": "BA03159C-E808-4FF1-B27E-A61B6E888D7F",
  "Code": "OK",
  "Message": "无",
  "Data": {
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 1,
    "List": [
      {
        "Active": true,
        "CreateTime": "1617958538000",
        "UserId": "agent@ccc-test",
        "Tags": "M1",
        "City": "乐山",
        "InstanceId": "ccc-test",
        "Usage": "Bidirection",
        "ContactFlowName": "默认联系流",
        "Provider": "alicom",
        "Number": "08330011****",
        "ContactFlowId": "a3fb6c62-9b49-4942-ae5b-cf2abd4123ek",
        "Province": "四川",
        "SkillGroups": [
          {
            "DisplayName": "测试技能组",
            "InstanceId": "ccc-test",
            "Name": "skillgroup",
            "SkillGroupId": "skillgroup@ccc-test"
          }
        ]
      }
    ]
  }
}

错误码

Http code错误码错误信息描述
400Parameter.EnumerationThe parameter %s must be one of the value of enumeration %s.该参数必须为系统限定的枚举值之一。
400Parameter.MaximumThe parameter %s must be less than or equal to %s.参数必须小于或等于系统规定的最大值。
400Parameter.MinimumThe parameter %s must be greater than or equal to %s.参数必须大于或等于系统规定的最小值。
400Parameter.EmptyThe parameter %s may not be null or empty.该参数不能为null值或为空字符串。
400Parameter.NullThe parameter %s may not be null.该参数不能为null值.
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。

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

阿里云首页 云呼叫中心 相关技术圈