文档

GenerateUserAccessToken - 获取用户登录Token

用于聊天窗用户免登时,获取Token。通过Token可将用户的企业身份带入机器人。同时支持访客名片的自定义信息的带入。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
Nickstring

用户昵称

张三
ForeignIdstring

用户在企业内部的用户 id

8882022040000000171
Telephonestring

用户手机号码

1381111****
Emailstring

用户邮箱

a***bcx@gmail.com
ExtraInfostring

用户需要带入到机器人的额外参数。使用 JSON String 格式。如果要使用访客名片,请按照以下格式带入:{ "customerNameCard": [ { "key": "姓名", "value": "张三" }, { "key": "等级", "value": "v2" }, { "key": "联系方式", "value": "123" } ] }

说明 访客名片信息会展示在人工工作台上
{ "xx": 123, "yy": 22332, "customerNameCard": [ { "key": "姓名", "value": "张三" }, { "key": "等级", "value": "v2" }, { "key": "联系方式", "value": "123" } ] }
ExpireTimeinteger

Token 有效时间,单位秒。最大不得超过 3600s

1000
AgentKeystring

业务空间 key,不设置则访问默认业务空间,key 值在主账号业务管理页面获取

ac627989eb4f8a98ed05fd098bbae5_p_beebot_public

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

E6988CE6-41CF-1103-9BEC-2B20D26C0B51
Successboolean

是否成功

true
Codestring

返回编码

200
Messagestring

异常信息

Parameter.Invalid
Datastring

Token 值

DDEXEDAFWAGASDFWAEFFAWEFAWFWEAFWAFWAEF

示例

正常返回示例

JSON格式

{
  "RequestId": "E6988CE6-41CF-1103-9BEC-2B20D26C0B51",
  "Success": true,
  "Code": "200",
  "Message": "Parameter.Invalid",
  "Data": "DDEXEDAFWAGASDFWAEFFAWEFAWFWEAFWAFWAEF"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-07-12新增 OpenAPI看变更集
  • 本页导读 (0)