用于生成智能小Q嵌入Ticket。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| CopilotId | string | 是 | 开通嵌入的智能小 Q 模块 ID。 | ccd3428c-dd23-460c-a608-26bae29dffee |
| TicketNum | integer | 否 | ticket 的票据数量取值范围：
每次使用票据访问后，Ticket 的票据数量减 1。 | 1 |
| UserId | string | 否 | Quick BI 的 UserId。
注意 注意：userId 和 accountName 只填一个即可，不填时默认绑定报表的 owner，访问报表时将以该用户身份访问。 | 9c-asdawf-casxcasd-asdasd |
| AccountName | string | 否 | 用户的账号名称。 注意 注意：userId 和 accountName 只填一个即可，不填时默认绑定报表的 owner，访问报表时将以该用户身份访问。 | 测试用户 |
| AccountType | integer | 否 | 用户的账号类型:
注意 注意：accountName 不为空，则 accountType 不能为空。 | 1 |
| ExpireTime | integer | 否 | 过期时间。
| 200 |
返回参数
示例
正常返回示例
JSON格式
{
"RequestId": "D787E1A3-A93C-424A-B626-C2B05DF8D885",
"Result": "f5eeb52e-d9c2-4a8b-80e3-47ab55c2****",
"Success": true
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | Internal.System.Error | An internal system error occurred. | 系统内部异常。 |
| 400 | Instance.Expired | Your instance has expired. | 您的购买实例已经过期。 |
| 400 | Instance.Not.Exist | The specified instance does not exist. | 暂未匹配到您的购买实例。 |
| 400 | Invalid.Organization | The specified organizational unit does not exist. | 该组织不存在。 |
| 400 | User.Not.In.Organization | The specified user is not in the organizational unit. | 该用户不在组织中。 |
| 400 | Invalid.Parameter | An error occurred while verifying parameters. | 参数验证失败。 |
| 400 | Invalid.Parameter.Error | The parameter is invalid:%s. | 无效参数%s。 |
| 400 | Invalid.Param.Error | The parameter is invalid. | 无效参数。 |
| 400 | Invalid.User.Admin | You are not an administrator of this organization. | 没有权限，您不是组织管理员。 |
| 400 | System.Param.Empty | You must specify the %s parameter. | 参数%s不能为空。 |
| 400 | Access.Forbidden | Your instance version or access key is not allowed to call the API operation, only professional version supports calling. | 您的实例版本或者 AccessKey不允许调用该 API，仅专业版支持调用。 |
| 400 | UserInfo.Error | The personal information is invalid. | 个人信息不合法。 |
| 400 | ApiUser.Not.Exists | The specified user does not exist. | 用户不存在。 |
| 400 | User.Not.WorkspaceAdmin | Only administrators of the group workspace can perform this operation. | 没有权限，您不是该群空间的管理员。 |
| 400 | Application.Object.NotExist | The object you are operating does not exist or has been deleted. | 操作组件不存在或已被删除。 |
| 400 | Not.ApiCall.AuthUser | You are not an administrator or API call auth user of this organization. | 非组织管理员或API调用授权用户。 |
| 500 | Authorize3rdTicket.Num.HasNoLeft | There is no ticket number left, please generate new ticket. | 当前票据已消费完毕，请重新生成。 |
| 500 | CopilotEmbed.Config.NotFind | Can not find copilot embed config with this copilot ID. | 找不到此嵌入配置 |
访问错误中心查看更多错误码。