文档首页/ 云客服/ API参考/ 质检/监控/统计类/ 监控/统计/ 配置数据查询类接口/ 依据租间ID查询所有座席信息
更新时间：2024-09-24 GMT+08:00
查看PDF
分享

依据租间ID查询所有座席信息

场景描述

根据租间ID查询该租户下所有座席信息。

接口方法

设置成“POST”。该接口仅支持POST方法，不支持PUT、GET和DELETE等方法。

请求URL

https://ip:port/rest/cmsapp/v1/openapi/tenant/querytenantdetail

其中，公有云环境请联系管理员获取，ip为CC-CMS服务器地址，port为CC-CMS服务器的HTTPS端口号。

非公有云环境如果配置了NSLB服务，ip请填写NSLB的服务器地址，port为CC-CMS服务在NSLB映射的HTTPS端口号。

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

String

True

固定填 application/json; charset=UTF-8。

2

Authorization

String

True

生成方式参见C2 监控/系统外呼/话单/知识库类接口鉴权方式。
表2 消息体参数说明

参数名

数据类型

是否必选

说明

tenantId

string

True

租间ID。

ccId

int

False

呼叫中心编号

  • 集成环境，默认值为系统管理员登录AICC系统后，通过“配置中心 > 系统管理 > CMS系统配置”查看的呼叫中心编号。若该配置为空，取值数据库t_cms_sysparam表中的sys_key="default_cc_id",sys_type="cms_system_config"对应的数据。
  • 独立部署环境，默认值为系统管理员登录AICC系统后，通过“配置中心 > 系统管理 > 参数配置”查看“默认呼叫中心标识”的值。

limit

int

False

表示每页的查询数量。

取值范围：1～10000，默认值为10000。

说明：
  • 分页效果只针对响应参数中的“agents”参数生效，其他参数不生效。
  • 当前分页效果只支持集成环境。

offset

int

False

offset用于确定查询的起始页。

offset取值公式为：offset=limit*(page-1)，取值范围：>=0，默认值为0。

page为需要查询的起始页。

说明：
  • 分页效果只针对响应参数中的“agents”参数生效，其他参数不生效。
  • 当前分页效果只支持集成环境。

响应消息

表3 响应消息参数体说明

参数名

数据类型

说明

resultCode

string

查询结果。取值如下：

  • "0100000"：成功
  • 其他：失败

失败的原因说明请参见错误码参考。

resultDesc

object

查询成功后，返回结果信息的对象。

该数组中对象的参数说明请参见表4。
表4 resultDesc对象参数说明

参数名

数据类型

说明

ccId

int

呼叫中心编号。

tenantId

string

租间ID。

tenantSpaceName

string

租间名称

vdnId

int

虚拟呼叫中心编号

accessCodes

array

接入号列表。

该数组中对象的参数说明请参见“表4 accessCodes 对象参数说明”。

agents

array

座席列表。参见“表5 agents对象参数说明”
表5 accessCodes 对象参数说明

参数名

数据类型

说明

accessCode

string

接入号。

isDefault

boolean

默认接入码标识，true:默认接入码，false或者空:非默认接入码。
表6 agents对象参数说明

参数名

数据类型

说明

workNo

int

座席工号。

sipAccount

string

软电话号码。

accountCode

string

座席账号。

agentType

int

座席类别。

4：音频座席；5：多媒体座席；11：视频座席。只在集成部署时返回此字段。

样例报文

  • 请求头： 
    Content-Type: application/json;charset=UTF-8
Authorization: ******************
  • 请求参数： 
    {
  "ccId": 1,
  "tenantId": "202306131208",
  "limit": 10000,
  "offset": 0
}
  • 响应参数： 
    {
    "resultCode": "0100000",
    "resultDesc": {
            "ccId": 3,
            "vdnId": 47,
            "tenantId": "202008142460",
            "accessCodes": [
                {
                    "accessCode": "202008191",
                    "isDefault": true
                }
            ],
            "tenantSpaceName": "fjw081401",
            "agents": [{
                "workNo": 111, 
                "sipAccount": "88880001",
                "accountCode": "123",
                "agentType": 4
            }]
        }
}

相关文档