跳到主要内容

应用与回调配置

控制台客户端配置 · 返回值与共享类型

应用按当前登录账号隔离。创建应用返回的 appSecret 只在创建响应中提供。updateConfig 整体覆盖 config;修改部分配置时先读取当前对象并合并需要修改的字段。

updateWebhook 接受 webhookUrl、subscribedEvents、rotateSecret。配置非空 URL 时至少订阅一个事件。传入空字符串会清空回调地址并删除签名密钥。签名密钥仅在设置或轮换时通过 webhookSecret 返回。回调事件与验签见服务端回调。

apps.list​

应用列表。

GET /v1/apps

鉴权:租户 Bearer Token。

语言调用
Node.jsc.apps.list()
Pythonc.apps.list()
Javac.apps.list()
Goc.Apps.List(ctx, &result)
PHP$c->apps->list()

无请求字段。

返回:AppRecord[]。嵌套字段见共享类型。

apps.get​

应用详情。

GET /v1/apps/detail

鉴权:租户 Bearer Token。

语言调用
Node.jsc.apps.get(input)
Pythonc.apps.get(**input)
Javac.apps.get(input)
Goc.Apps.Get(ctx, input, &result)
PHP$c->apps->get($input)

输入:AppIdInput。 字段放在 URL 查询参数中。

字段必填类型说明
appId是string目标应用 ID

返回:AppRecord。嵌套字段见共享类型。

apps.create​

创建应用。

POST /v1/apps

鉴权:租户 Bearer Token。

语言调用
Node.jsc.apps.create(input)
Pythonc.apps.create(**input)
Javac.apps.create(input)
Goc.Apps.Create(ctx, input, &result)
PHP$c->apps->create($input)

输入:CreateAppPayload。 字段放在 JSON Body 中。

字段必填类型说明
name是string应用或课堂名称
environment否AppEnvironment | undefined应用环境
config否Record<string, unknown> | undefined完整应用配置对象,覆盖保存

返回:AppRecord。嵌套字段见共享类型。

apps.updateConfig​

覆盖应用配置。

PATCH /v1/apps/config

鉴权:租户 Bearer Token。

语言调用
Node.jsc.apps.updateConfig(input)
Pythonc.apps.update_config(**input)
Javac.apps.updateConfig(input)
Goc.Apps.UpdateConfig(ctx, input, &result)
PHP$c->apps->updateConfig($input)

输入:UpdateAppConfigInput。 字段放在 JSON Body 中。

字段必填类型说明
config是Record<string, unknown>完整应用配置对象,覆盖保存
appId是string目标应用 ID

返回:AppRecord。嵌套字段见共享类型。

apps.updateWebhook​

设置回调及签名密钥。

PATCH /v1/apps/webhook

鉴权:租户 Bearer Token。

语言调用
Node.jsc.apps.updateWebhook(input)
Pythonc.apps.update_webhook(**input)
Javac.apps.updateWebhook(input)
Goc.Apps.UpdateWebhook(ctx, input, &result)
PHP$c->apps->updateWebhook($input)

输入:UpdateWebhookInput。 字段放在 JSON Body 中。

字段必填类型说明
webhookUrl是string回调 URL;空字符串删除回调及签名密钥
subscribedEvents否string[] | undefined订阅事件类型列表
rotateSecret否boolean | undefined轮换回调签名密钥
appId是string目标应用 ID

返回:UpdateWebhookResult。嵌套字段见共享类型。