ListPhoneNumbersOfSkillGroup - 获取技能组的号码列表

更新时间:
复制为 MD 格式

调用ListPhoneNumbersOfSkillGroup获取指定实例下指定技能组关联的号码列表,也可以通过该接口反查未关联但可关联到该技能组的号码。

接口说明

注意:如果号码已作为个人外呼号码使用,则不会出现在可添加到技能组的号码列表中。

调试

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

调试

授权信息

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

请求参数

名称

类型

必填

描述

示例值

InstanceId

string

实例 ID。

ccc-test

SkillGroupId

string

技能组 ID。

skillgroup@ccc-test

PageNumber

integer

分页序号,范围 1-100。

1

PageSize

integer

分页大小,范围 1-100。

10

IsMember

boolean

是否关联技能组,若为 true,则查询 SkillgroupId 关联的号码列表,若为 false,则查询 SkillgroupId 可关联但未关联的号码列表。通常和 AddNumbersToSkillGroup 接口一起使用。

true

SearchPattern

string

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

0833

Active

boolean

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

true

返回参数

名称

类型

描述

示例值

object

Code

string

响应码。

OK

HttpStatusCode

integer

HTTP 状态码。

200

Message

string

响应信息。

RequestId

string

请求 ID。

EEEE671A-3E24-4A04-81E6-6C4F5B39DF75

Data

object

数据。

PageNumber

integer

分页序号,范围 1-100。

1

PageSize

integer

分页大小,范围 1-100。

10

TotalCount

integer

总数。

1

List

array<object>

号码列表。

object

Active

boolean

号码是否可用。

true

Number

string

号码。

08330011****

City

string

号码归属地市。

乐山

InstanceId

string

实例 ID。

ccc-test

Usage

string

号码用途。

枚举值:

  • Outbound :

    呼出

  • Inbound :

    呼入

  • Bidirection :

    呼入和呼出

Bidirection

ContactFlowId

string

号码关联的 IVR 联系流 ID。

a3fb6c62-9b49-4942-ae5b-cf2abd4123ek

Province

string

号码归属地省。

四川

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "List": [
      {
        "Active": true,
        "Number": "08330011****",
        "City": "乐山",
        "InstanceId": "ccc-test",
        "Usage": "Bidirection",
        "ContactFlowId": "a3fb6c62-9b49-4942-ae5b-cf2abd4123ek",
        "Province": "四川"
      }
    ]
  }
}

错误码

HTTP status code

错误码

错误信息

描述

400 Parameter.Maximum The parameter %s must be less than or equal to %s. 参数必须小于或等于系统规定的最大值。
400 Parameter.Minimum The parameter %s must be greater than or equal to %s. 参数必须大于或等于系统规定的最小值。
400 Parameter.Empty The parameter %s may not be null or empty. 该参数不能为null值或为空字符串。
400 Parameter.Null The parameter %s may not be null. 该参数不能为null值.
404 NotExists.InstanceId The specified instance %s does not exist. 指定的呼叫中心实例不存在。
404 NotExists.SkillGroupId The skill group ID %s does not exist in instance %s. 云联络中心实例中不存在指定的技能组ID。

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

变更历史

更多信息,参考变更详情