文档首页/ 云客服/ API参考/ 接口鉴权方式/ C5 智能辅助类接口鉴权方式
更新时间:2024-09-24 GMT+08:00
分享

C5 智能辅助类接口鉴权方式

场景描述

提供登录鉴权接口,接口调用需要携带系统管理员工号或是VDN管理员工号,以及密码。修改系统配置,以系统管理员工号登录;修改VDN的配置,以VDN的配置管理员的工号登录。在登录验证成功后,在响应消息头中携带Guid=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1;在后续的配置接口调用时,都携必须带该Guid的头域。

接口方法

该接口仅支持POST方法,不支持PUT、GET和DELETE等方法。

接口URI

https://ip:port/agentgateway/resource/config/login

其中,ip为CC-Gateway服务器地址,port为CC-Gateway服务器的HTTPS端口号。

日志中的方法名

auth

请求说明

  • 消息头
    表1 消息头参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    Content-Type

    string

    True

    消息主体编码方式,缺省值:application/json; charset=UTF-8

  • 消息体
    表2 消息体参数说明

    序号

    名称

    参数类型

    是否必选

    说明

    1

    agentId

    number

    True

    1.配置管理员登录时为座席工号。

    取值的类型为整数,取值范围为1~59999。

    2.VDN账号登录时为(VDN编号 + 100000)组成的数字

    2

    password

    string

    True

    1.配置管理员登录时为工号对应的密码

    2.VDN账号登录时为VDN对接密码

响应说明

表3 消息体参数说明

序号

名称

参数类型

说明

1

message

string

响应消息描述

2

retcode

string

错误码。取值如下:

3

result

object

结果内容对象。该对象参数说明请参见表4

表4 result参数说明

序号

名称

参数类型

说明

3.1

guid

string

每个配置用户登录后获得唯一的Guid标识

报文样例

  • 消息头
    Content-Type:application/json; charset=UTF-8
  • 请求参数
    {
        "agentId": 101,
        "password": "******"
    }
  • 响应参数
    {
        "result": {
            "guid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.AgentGateway1"
        },
        "message": "success",
        "retcode": "0"
    }

相关文档