首页 云联络中心 开发参考 API参考 API目录 号码 ListPhoneNumbersOfSkillGroup - 获取技能组的号码列表

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

更新时间: 2024-03-01 17:54:26

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

接口说明

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

调试

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

授权信息

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

请求参数

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

实例 ID。

ccc-test
SkillGroupIdstring

技能组 ID。

skillgroup@ccc-test
PageNumberinteger

分页序号,范围 1-100。

1
PageSizeinteger

分页大小,范围 1-100。

10
IsMemberboolean

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

true
SearchPatternstring

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

0833
Activeboolean

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

true

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
Messagestring

响应信息。

RequestIdstring

请求 ID。

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

数据。

PageNumberinteger

分页序号,范围 1-100。

1
PageSizeinteger

分页大小,范围 1-100。

10
TotalCountinteger

总数。

1
Listobject []

号码列表。

Activeboolean

号码是否可用。

true
Numberstring

号码。

08330011****
Citystring

号码归属地市。

乐山
InstanceIdstring

实例 ID。

ccc-test
Usagestring

号码用途。

枚举值:
  • Outbound呼出
  • Inbound呼入
  • Bidirection呼入和呼出
Bidirection
ContactFlowIdstring

号码关联的 IVR 联系流 ID。

a3fb6c62-9b49-4942-ae5b-cf2abd4123ek
Provincestring

号码归属地省。

四川

示例

正常返回示例

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错误码错误信息描述
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.指定的呼叫中心实例不存在。
404NotExists.SkillGroupIdThe skill group ID %s does not exist in instance %s.呼叫中心实例中不存在指定的技能组ID。

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

变更历史

变更时间变更内容概要操作
暂无变更历史
阿里云首页 云联络中心 相关技术圈