文档首页/ 云客服/ API参考/ 呼叫中心配置类/ 座席管理/ 根据登录账号查询座席信息 (queryAgentInfoByAccount)
更新时间:2023-09-27 GMT+08:00

根据登录账号查询座席信息 (queryAgentInfoByAccount)

场景描述

根据登录账号查询座席信息。

接口方法

POST

接口URI

https://域名/apiaccess/rest/CC-Management/v1/queryAgentInfoByAccount,例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

X-APP-Key

string

False

appKey字段,用户标识

2

Authorization

string

True

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

表2 请求体参数

序号

名称

参数类型

是否必选

说明

1.1

accountCode

string(64)

True

登录账号,最长64个字符串

1.2

password

string(64)

False

鉴权用户密码,最长64个字符串

1.3

username

string(64)

False

鉴权用户名,最长64个字符串

响应说明

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

序号

名称

参数类型

是否必选

说明

1.1

returnCode

string

True

返回码 0:成功 1:失败

1.2

description

string

True

描述

1.3

data

object

False

返回数据,失败时参数workNo返回空字符串

1.3.1

workNo

integer

False

座席工号

1.3.2

agentType

integer

False

座席类型

1.3.3

agentStatus

string

False

座席状态,默认可用为0

  • 响应状态码: 400

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

  • 响应状态码: 401

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

  • 响应状态码: 403

    鉴权失败

  • 响应状态码: 404

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

  • 响应状态码: 500

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

错误码

无。

报文样例

  • 请求头:
    x-app-Key:f**********************************e  
    Authorization:Bearer a******************************2

    请求参数:

    {
    	"accountCode": "Agents"
    }

    响应参数:

    {
    	"returnCode": "0",
    	"data": {
    		"workNo": 7094,
    		"agentType": 5,
    		"agentStatus": "0"
    	},
    	"description": "query success"
    }
  • 场景描述:用户名密码登录

    请求头:

    Content-Type:application/json

    请求参数:

    {
    	"accountCode": "Agents",
    	"username": "itau_group",
    	"password": "****************"
    }

    响应参数:

    {
    	"returnCode": "0",
    	"data": {
    		"workNo": 7094,
    		"agentType": 5,
    		"agentStatus": "0"
    	},
    	"description": "query success"
    }