用于生成智能小Q嵌入Ticket。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
當(dāng)前API暫無(wú)授權(quán)信息透出。
請(qǐng)求參數(shù)
名稱(chēng) | 類(lèi)型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CopilotId | string | 是 | 開(kāi)通嵌入的智能小 Q 模塊 ID。 | ccd3428c-dd23-460c-a608-26bae29dffee |
TicketNum | integer | 否 | ticket 的票據(jù)數(shù)量取值范圍:
每次使用票據(jù)訪問(wèn)后,Ticket 的票據(jù)數(shù)量減 1。 | 1 |
UserId | string | 否 | Quick BI 的 UserId。
注意 注意:userId 和 accountName 只填一個(gè)即可,不填時(shí)默認(rèn)綁定報(bào)表的 owner,訪問(wèn)報(bào)表時(shí)將以該用戶(hù)身份訪問(wèn)。 | 9c-asdawf-casxcasd-asdasd |
AccountName | string | 否 | 用戶(hù)的賬號(hào)名稱(chēng)。 注意 注意:userId 和 accountName 只填一個(gè)即可,不填時(shí)默認(rèn)綁定報(bào)表的 owner,訪問(wèn)報(bào)表時(shí)將以該用戶(hù)身份訪問(wèn)。 | 測(cè)試用戶(hù) |
AccountType | integer | 否 | 用戶(hù)的賬號(hào)類(lèi)型:
注意 注意:accountName 不為空,則 accountType 不能為空。 | 1 |
ExpireTime | integer | 否 | 過(guò)期時(shí)間。
| 200 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
"Result": "f5eeb52e-d9c2-4a8b-80e3-47ab55c2****",
"Success": true
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | Internal.System.Error | An internal system error occurred. | 系統(tǒng)內(nèi)部異常。 |
500 | Authorize3rdTicket.Num.HasNoLeft | There is no ticket number left, please generate new ticket. | 當(dāng)前票據(jù)已消費(fèi)完畢,請(qǐng)重新生成。 |
500 | Invalid.Param.Error | The parameter is invalid. | 無(wú)效參數(shù)。 |
500 | CopilotEmbed.Config.NotFind | Can not find copilot embed config with this copilot ID. | 找不到此嵌入配置 |
訪問(wèn)錯(cuò)誤中心查看更多錯(cuò)誤碼。