文档首页/ 云客服/ API参考/ 呼叫中心配置类/ 座席管理/ 查询所有座席的软电话信息 (包含业务账号) (queryAgentInfo)
更新时间：2023-09-27 GMT+08:00
查看PDF
分享

查询所有座席的软电话信息 (包含业务账号) (queryAgentInfo)

场景描述

查询座席信息。

接口方法

GET

接口URI

https://域名/apiaccess/CC-Mangemant/v1/queryAgentInfo，例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

X-APP-Key

string

False

app标识。

2

Authorization

string

True

鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）

响应说明

  • 响应状态码: 200
表2 响应体参数

序号

名称

参数类型

是否必选

说明

1.1

sipServicePort

string

False

软电话注册端口，1~65535

长度限制:string(5)

1.2

sipServiceIp

string

False

软电话注册地址，IPV4格式

长度限制:string(50)

1.3

agents

array[object]

False

座席集合

1.3.1

workNo

integer

True

座席工号，范围从101到59999

1.3.2

sipAccount

string

False

SIP软电话号码

长度限制:string(24)

1.3.3

sipPwd

string

False

SIP软电话加密前密码

长度限制:string(24)

1.3.4

accountCode

string

False

关联的Service Cloud登录账号

长度限制:string(100)
  • 响应状态码: 400

    错误的请求：请检查请求路径及参数。

  • 响应状态码: 401

    未授权：1.请确认是否购买了相关服务。2.请联系客服人员检查您账号的当前状态。

  • 响应状态码: 404

    请求的内容未找到：请检查请求的路径。

  • 响应状态码: 500

    业务失败：请依次确认您请求中各参数的取值。

错误码

无。

报文样例

请求头: 
{
	"x-app-key": "f******************************f"
	"Authorization": "Bearer 0******************************8"
}
{
	"connection": "keep-alive"
	"content-type": "application/json;charset=UTF-8"
}

响应头:

响应参数:

{
    "sipServiceIp": "10.10.96.98",
    "sipServicePort": 5060,
    "agents": [
        {
            "workNo": 1522,
            "accountCode": "aaaa",
            "sipAccount": "88881619",
            "sipPwd": "***"
        },
        {
            "workNo": 1523,
            "sipAccount": "88881620",
            "sipPwd": "***"
        }
    ]
}
父主题： 座席管理