文档首页/ 云客服/ API参考/ 网页客户端接入/ 第三方请求鉴权 (applyToken)
更新时间:2024-08-02 GMT+08:00

第三方请求鉴权 (applyToken)

场景描述

第三方请求,生成客户端访问Token

接口方法

POST

接口URI

https://域名/apiaccess/ccmessaging/applyToken,例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

x-app-key

string

True

appKey字段,用户标识,在ApiFabric工具上配置

2

Authorization

string

True

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

表2 请求体参数

序号

名称

参数类型

是否必选

说明

1

reqBody

applyTokenReqBody

True

请求体

表3 applyTokenReqBody参数结构

序号

名称

参数类型

是否必选

说明

1.1

userId

string

True

用户标识

由企业自行定义,取值范围:1到24位字符串。

1.2

userName

string

True

用户名称

由企业自行定义。用于名称展示。

1.3

channelId

string

True

渠道标识

请设置为您在AICC的“服务渠道配置 >渠道配置” 下配置的渠道的“配置ID”。

1.4

locale

string

True

语言信息

请使用不带国家编码的语言,例如使用zh表示 中文,en表示英语等。请参见ISO 639语言编码获取详细信息。

响应说明

  • 响应状态码: 200
    表4 applyTokenRspBody参数结构

    序号

    名称

    参数类型

    是否必选

    说明

    1.1

    token

    string

    True

    生成的token,后续发起其他请求时,需在Header中将该值赋给ccmessaging-token。

    说明:

    • 该Token有1小时有效期,如果系统返回鉴权失败(401)时,需要重新使用applyToken获取新Token。
    • 在会话期间内,Token失效,AICC会自动在当次请求时返回新Token,企业需要自行在Header中更新ccmessaging-token的取值。

    1.2

    resultCode

    string

    True

    结果码

    • 0:成功
    • 1:失败

    1.3

    resultDesc

    string

    False

    结果描述

    当前暂时没有返回。

  • 响应状态码: 400

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

  • 响应状态码: 401

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

  • 响应状态码: 404

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

  • 响应状态码: 500

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

错误码

无。

报文样例

  • 场景描述:样例报文

    请求参数:

    {
    	"userId": "XXXXXXXXX",
    	"userName": "XXXXXXXX",
    	"channelId": "XXXXXXXXXXXX",
    	"locale": "zh"
    }

    响应参数:

    {
        "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    }