# 用户登录相关服务
# 授权登录
开启会话前，先调用相关服务，授权登录后查看会话。
接口描述
- 第三方账号登录
- 用户登录成功之后, 必须调用 获取人工服务状态 接口, 否则人工监管会失效
请求
GET https://apigate.glodon.com/api/front/login
1
请求header参数
| 参数 | 参数类型 | 参数约束 | 是否必传 | 示例值 | 描述 |
|---|---|---|---|---|---|
| session-id | 字符串 | 服务端返回,可从以下api中获取: - 开始新会话 - 会话超时，重启会话 | 否 | C3D205E1B4C72BF451CDC326328786A5 | 索引用户信息的key |
请求param参数
| 参数 | 参数类型 | 参数约束 | 是否必传 | 示例值 | 描述 |
|---|---|---|---|---|---|
| robot | 字符串 | 服务端获取 | 是 | GCCP | 机器人标识: 每次刚打开或者是切换机器人时, 从 获取机器人列表 接口获取 |
| chatid | 字符串 | 服务端获取 | 是 | 74139073-4cfd-449b -9479-7e2fb4895d4d | 会话ID，同一会话ID可能包含多组问答, 从初始会话 开始新会话 api获取 |
| identity | 字符串 | 用户输入 | 否 | 13699123456 | 用户输入的唯一标识(可能是手机号,邮箱,账号) |
| secret | 字符串 | 用户输入 | 否 | wqdqfqegqe== | 用户输入后客户端使用valiCodeKey加密后的密文 |
| accessKey | 字符串 | 客户端生成，32位的UUID | 否 | 0faf2c44-0f25-4d29-8fda-42e9180b9be7 | 客户端生成的随机数，用于加密secret |
| source | 整型 | 1/2/3....../20 | 是 | 1 | 1:广联云用户(identity，secret，accessKey必传) 2:微信 3:支付宝 等等 |
请求成功返回的数据
请求成功返回的字段描述
| 返回字段 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| session-id | 字符串 | C3D205E1B4C72BF451CDC326328786A5 | 服务端索引用户信息的key |
| user | 对象 | 如下 | 包括用户的基本信息，用于前端展示 |
| oAuth2AccessToken | 对象 | 如下 | 包括accessToken的信息，用于单点登陆 |
请求成功正确返回的数据基本示例
{
"code": 200,
"message": "success",
"result": {
"session-id": "5DC2D89A622594886FC383A0CD853F53",
"user": {
"id": 6557192726348111872,
"fullname": "13699127552",
"username": null,
"email": null,
"mobile": "13699127552",
"userId": "6557192726348112377",
"gender": null,
"birthday": null,
"qq": null,
"company": null,
"avatarETag": "07fd96b27f83a70ffbe45b30c277c804",
"displayName": "13699127552",
"strId": "6557192726348112377",
"nickname": null,
"accountName": "13699127552",
"chatid": "7c7c37ef-c22a-4b58-98d8-6317117562f0",
"uid": "DF162FEC3A2DA4B17DBEEB02B4FA7ACC",
"authStatus": 1,
"chatStatus": null
},
"oAuth2AccessToken": {
"access_token": "cn-63a09245-b3f7-40da-9cd0-81e75e1ab1e2",
"token_type": "bearer",
"refresh_token": "cn-214beef5-e889-4db4-b6c9-e64ecbcd57e4",
"expires_in": 151139.0,
"scope": "document_enterprise_files_write document_project_files_write document_incoming_files_read document_project_files_read document_my_files_read paas-workspace document_incoming_files_write account_token_login document_my_files_write document_appdata_read paas-authorizing account_info_write document_enterprise_files_read document_appdata_write account_info_read"
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
请求失败返回的数据
请求失败返回的数据基本示例 查看其它状态码
{
"code": 400,
"message": "Required parameter 'robot' is not present"
}
{
"code": 500,
"message": "java.lang.IndexOutOfBoundsException"
}
{
"code": 401,
"message": "username not exists or password error"
}
{
"code": 402,
"message": "login error"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# 使用ticket进行单点登陆
开启会话前，先调用相关服务，使用ticket进行单点登陆后查看会话。
接口描述
- 使用ticket进行单点登陆
- 用户登录成功之后, 必须调用 获取人工服务状态 接口, 否则人工监管会失效
请求
GET https://apigate.glodon.com/api/front/loginByTicket
1
请求header参数
| 参数 | 参数类型 | 参数约束 | 是否必传 | 示例值 | 描述 |
|---|---|---|---|---|---|
| session-id | 字符串 | 服务端返回,可从以下api中获取: - 开始新会话 - 会话超时，重启会话 | 否 | C3D205E1B4C72BF451CDC326328786A5 | 索引用户信息的key |
请求param参数
| 参数 | 参数类型 | 参数约束 | 是否必传 | 示例值 | 描述 |
|---|---|---|---|---|---|
| ticket | 字符串 | 客户端获取 | 是 | cn-63a09245-b3f7-40da-9cd0-81e75e1ab1e2 | 通过客户端获取的ticket，后台进行认证，实现单点登陆 |
| robot | 字符串 | 服务端获取 | 是 | GCCP | 机器人标识: 每次刚打开或者是切换机器人时, 从 获取机器人列表 接口获取 |
| chatid | 字符串 | 服务端获取 | 是 | 74139073-4cfd-449b -9479-7e2fb4895d4d | 会话ID，同一会话ID可能包含多组问答, 从初始会话 开始新会话 api获取 |
请求成功返回的数据
请求成功返回的字段描述
| 返回字段 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| session-id | 字符串 | C3D205E1B4C72BF451CDC326328786A5 | 服务端索引用户信息的key |
| user | 对象 | 如下 | 包括用户的基本信息，用于前端展示 |
| oAuth2AccessToken | 对象 | 如下 | 包括accessToken的信息，用于单点登陆 |
请求成功正确返回的数据基本示例
{
"code": 200,
"message": "success",
"result": {
"session-id": "5DC2D89A622594886FC383A0CD853F53",
"user": {
"id": 6557192726348111872,
"fullname": "13699127552",
"username": null,
"email": null,
"mobile": "13699127552",
"userId": "6557192726348112377",
"gender": null,
"birthday": null,
"qq": null,
"company": null,
"avatarETag": "07fd96b27f83a70ffbe45b30c277c804",
"displayName": "13699127552",
"strId": "6557192726348112377",
"nickname": null,
"accountName": "13699127552",
"chatid": "7c7c37ef-c22a-4b58-98d8-6317117562f0",
"uid": "DF162FEC3A2DA4B17DBEEB02B4FA7ACC",
"authStatus": 1,
"chatStatus": null
},
"oAuth2AccessToken": {
"access_token": "cn-63a09245-b3f7-40da-9cd0-81e75e1ab1e2",
"token_type": "bearer",
"refresh_token": "cn-214beef5-e889-4db4-b6c9-e64ecbcd57e4",
"expires_in": 151139.0,
"scope": "document_enterprise_files_write document_project_files_write document_incoming_files_read document_project_files_read document_my_files_read paas-workspace document_incoming_files_write account_token_login document_my_files_write document_appdata_read paas-authorizing account_info_write document_enterprise_files_read document_appdata_write account_info_read"
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
请求失败返回的数据
请求失败返回的数据基本示例 查看其它状态码
{
"code": 400,
"message": "Required parameter 'robot' is not present"
}
{
"code": 500,
"message": "java.lang.IndexOutOfBoundsException"
}
{
"code": 402,
"message": "login error"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
# 使用accessToken进行单点登陆
开启会话前，先调用相关服务，使用accessToken进行单点登陆后查看会话。
接口描述
- 使用accessToken进行单点登陆, PC端提供
- 用户登录成功之后, 必须调用 获取人工服务状态 接口, 否则人工监管会失效
请求
GET https://apigate.glodon.com/api/front/loginByAccessToken
1
请求header参数
| 参数 | 参数类型 | 参数约束 | 是否必传 | 示例值 | 描述 |
|---|---|---|---|---|---|
| session-id | 字符串 | 服务端返回,可从以下api中获取: - 开始新会话 - 会话超时，重启会话 | 否 | C3D205E1B4C72BF451CDC326328786A5 | 索引用户信息的key |
请求param参数
| 参数 | 参数类型 | 参数约束 | 是否必传 | 示例值 | 描述 |
|---|---|---|---|---|---|
| accessToken | 字符串 | 客户端获取 | 是 | cn-63a09245-b3f7-40da-9cd0-81e75e1ab1e2 | 通过客户端获取的accessToken，后台进行认证，实现单点登陆 |
| robot | 字符串 | 服务端获取 | 是 | GCCP | 机器人标识: 每次刚打开或者是切换机器人时, 从 获取机器人列表 接口获取 |
| chatid | 字符串 | 服务端获取 | 是 | 74139073-4cfd-449b -9479-7e2fb4895d4d | 会话ID，同一会话ID可能包含多组问答, 从初始会话 开始新会话 api获取 |
请求成功返回的数据
请求成功返回的字段描述
| 返回字段 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| session-id | 字符串 | C3D205E1B4C72BF451CDC326328786A5 | 服务端索引用户信息的key |
| user | 对象 | 如下 | 包括用户的基本信息，用于前端展示 |
| oAuth2AccessToken | 对象 | 如下 | 包括accessToken的信息，用于单点登陆 |
请求成功正确返回的数据基本示例
{
"code": 200,
"message": "success",
"result": {
"session-id": "5DC2D89A622594886FC383A0CD853F53",
"user": {
"id": 6557192726348111872,
"fullname": "13699127552",
"username": null,
"email": null,
"mobile": "13699127552",
"userId": "6557192726348112377",
"gender": null,
"birthday": null,
"qq": null,
"company": null,
"avatarETag": "07fd96b27f83a70ffbe45b30c277c804",
"displayName": "13699127552",
"strId": "6557192726348112377",
"nickname": null,
"accountName": "13699127552",
"chatid": "7c7c37ef-c22a-4b58-98d8-6317117562f0",
"uid": "DF162FEC3A2DA4B17DBEEB02B4FA7ACC",
"authStatus": 1,
"chatStatus": null
},
"oAuth2AccessToken": {
"access_token": "cn-63a09245-b3f7-40da-9cd0-81e75e1ab1e2",
"token_type": "bearer",
"refresh_token": "cn-214beef5-e889-4db4-b6c9-e64ecbcd57e4",
"expires_in": 151139.0,
"scope": "document_enterprise_files_write document_project_files_write document_incoming_files_read document_project_files_read document_my_files_read paas-workspace document_incoming_files_write account_token_login document_my_files_write document_appdata_read paas-authorizing account_info_write document_enterprise_files_read document_appdata_write account_info_read"
}
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
请求失败返回的数据
请求失败返回的数据基本示例 查看其它状态码
{
"code": 400,
"message": "Required parameter 'robot' is not present"
}
{
"code": 500,
"message": "java.lang.IndexOutOfBoundsException"
}
{
"code": 402,
"message": "login error"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
← 机器人配置 获取问题/答案相关服务 →