首页 云呼叫中心 API参考 API目录 配置 ListConfigItems - 获取配置项列表

ListConfigItems - 获取配置项列表

调用ListConfigItems获取指定实例下的配置信息。

调试

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

调试

授权信息

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

请求参数

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

实例ID。

ccc-test
ObjectIdstring

配置信息所属的对象的ID,可以是阿里云主账号ID、实例ID、技能组ID、坐席ID。

ccc-test
ObjectTypestring

配置信息所属对象的类型。

INSTANCE
枚举值:
- INSTANCE: 实例级别的配置
- USER: 座席自身的配置
- SKILL_GROUP: 技能组级别的配置
- ALIYUN_UID: 主账号级别的配置

返回参数

名称类型描述示例值
object
Codestring

响应码。

OK
HttpStatusCodeinteger

HTTP状态码。

200
Messagestring

响应信息。

RequestIdstring

请求ID。

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

响应参数。

Dataarray

配置项列表。

object

配置项。

ObjectIdstring

配置信息所属的对象的ID。

ccc-test
Valuestring

配置项的值。

100
ObjectTypestring

配置信息所属对象的类型。

INSTANCE
InstanceIdstring

实例ID。

ccc-test
Namestring

配置项名称,配置项名称包含系统定义和客户自定义两种,系统定义包括是否允许坐席挂机、是否自动接听、久振未接时长等,这部分配置项名称是固定的,值可以由客户自定义,除此之外,配置项名称也支持客户自定义,客户可以根据需要添加配置项。

config-item
枚举值:
- AllowAudioDownload: 是否允许坐席下载录音,取值:0(不允许)、1(允许)。
- RecordingStorageSetting: 实例录音存储配置。
- AllowChooseSignedSkillGroup: 坐席上线前是否手动选择签入的技能组,取值:0(自动签入所属的全部技能组)、1(手动选择签入的技能组)。
- AgentRingingTimeoutSeconds: 坐席久振未接超时时长配置,取值范围为5-90,单位秒。
- ShowCalledID: 坐席来电显示,取值:-1(隐藏全部来电号码)、0(隐藏部分来电号码)、1(显示完整来电号码)。
- ShowCalleeID: 坐席外呼显示,取值:-1(隐藏全部外呼号码)、0(隐藏部分外呼号码)、1(显示完整外呼号码)。
- AllowHangup: 坐席呼入挂机方式,取值:0(不允许坐席挂机)、1(允许坐席挂机)。
- AutoAnswerCall: 坐席接听来电方式,取值:-1(手动接听)、n(振铃n秒后接听)。

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "EEEE671A-3E24-4A04-81E6-6C4F5B39DF75",
  "Params": [
    "无"
  ],
  "Data": [
    {
      "ObjectId": "ccc-test",
      "Value": "100",
      "ObjectType": "INSTANCE",
      "InstanceId": "ccc-test",
      "Name": "config-item"
    }
  ]
}

错误码

Http code错误码错误信息描述
400Parameter.EnumerationThe parameter %s must be one of the value of enumeration %s.该参数必须为系统限定的枚举值之一。
400Parameter.BlankThe parameter %s may not be null or blank.该参数不能为null或含有空白符的字符串。
400Parameter.EmptyThe parameter %s may not be null or empty.该参数不能为null值或为空字符串。
400Parameter.NullThe parameter %s may not be null.该参数不能为null值.
403Permission.UnauthorizedYou are not authorized to perform this action. %s privileges are required.您无权执行此操作。 必须具有指定权限。
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。

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

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