用于聊天窗用戶免登時,獲取Token,通過該Token可將用戶的企業身份帶入。
接口說明
由于安全問題,生成的 Token 僅第一次使用有效(過期時間內),如同一個用戶多瀏覽器登錄,需要多次調用。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Nick | string | 是 | 用戶昵稱,長度不得超過 128 個字符 | 張三 |
ForeignId | string | 是 | 用戶在企業內部的用戶 id,長度不得超過 128 個字符 | 8882022040000000171 |
Telephone | string | 否 | 用戶手機號碼,長度不得超過 30 個字符 | 1381111**** |
string | 否 | 用戶郵箱,長度不得超過 128 個字符 | a***bcx@gmail.com | |
ExtraInfo | string | 否 | 用戶需要帶入到機器人的額外參數。使用 JSON String 格式。如果要使用訪客名片,請按照以下格式帶入:{ "customerNameCard": [ { "key": "姓名", "value": "張三" }, { "key": "等級", "value": "v2" }, { "key": "聯系方式", "value": "123" } ] } 說明
訪客名片信息會展示在人工工作臺上
| { "xx": 123, "yy": 22332, "customerNameCard": [ { "key": "姓名", "value": "張三" }, { "key": "等級", "value": "v2" }, { "key": "聯系方式", "value": "123" } ] } |
ExpireTime | integer | 是 | Token 有效時間,單位秒,最大不得超過 3600 秒 | 1000 |
AgentKey | string | 否 | 業務空間 key,不設置則訪問默認業務空間,key 值在主賬號業務管理頁面獲取 | ac627989eb4f8a98ed05fd098bbae5_p_beebot_public |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "E6988CE6-41CF-1103-9BEC-2B20D26C0B51",
"Success": true,
"Code": "200",
"Message": "Parameter.Invalid",
"Data": "DDEXEDAFWAGASDFWAEFFAWEFAWFWEAFWAFWAEF"
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-08-07 | API 內部配置變更,不影響調用 | 查看變更詳情 |
2022-07-12 | 新增 OpenAPI | 查看變更詳情 |