智能会议纪要 API 参考

更新时间

查看云市场的智能会议纪要 API 参考,了解关键概念、参数说明、使用限制和接入注意事项。

智能会议纪要服务提供以下 RESTful API:

MethodPath描述
POST/0/gateway_group/gateway/start_sync以同步模式开启会议纪要服务,即等到会议结束再返回会议纪要。
POST/0/gateway_group/gateway/start以异步模式开启会议纪要服务,即立马返回会议纪要。
POST/0/gateway_group/gateway/stop停止会议纪要服务。
表格内容超出当前宽度,可横向滚动查看更多列。

同步模式开启会议纪要服务

该 API 适用于在 Serverless 平台(例如阿里云函数计算)部署服务的场景。调用该 API 发送请求后,智能会议纪要服务将在会议结束后进行响应。

调用该 API 开启会议纪要服务后,你需要通过以下方式通知智能会议纪要服务会议已结束:

  • 方式一:调用停止会议纪要服务 API。会议纪要的结果将发送到指定的 Webhook URL。
  • 方式二:在请求中设置最大空闲时间 maxIdleTime。如果频道内空闲(无任何人加入)时间超过你设置的最大空闲时间,会议会自动停止,会议纪要结果将发送到指定的 Webhook URL。

接口原型

  • 请求方法:POST
  • 请求 Path:/0/gateway_group/gateway/start_sync

路径参数

hostname:部署会议纪要服务的域名。

请求 Body

参数必填/可选类型描述
agoraRtcConfig.channelName必填String声网 RTC 频道名。
agoraRtcConfig.token可选String用于加入 RTC 频道的 Token。
agoraRtcConfig.uid可选String用户 ID,用于标识加入频道拉流的机器人。
agoraRtcConfig.encryption可选Object如果 RTC 频道设置了加密,该参数必须设置。该参数包含 mode、secret、salt 字段,分别对应 recordingConfig 的 decryptionMode、secret、salt 字段。
agoraRtmConfig.appId必填String用于声网 RTM 的 App ID。详见 RTM 2.x API。
agoraRtmConfig.uid必填String用于登录 RTM 系统的用户 ID。详见 RTM 2.x API。
agoraRtmConfig.token必填String用于登录 RTM 系统的 Token。详见 RTM 2.x API。
ossConfig.endpoint必填String你的第三方云存储地址,用于存储会议纪要结果。
ossConfig.accessKeyId必填String第三方云存储的 access key。
ossConfig.accessKeySecret必填String第三方云存储的 secret key。
ossConfig.bucketName必填String第三方云存储的 bucket。
ossConfig.objectName必填String第三方云存储的 Object name。
callbackUrl必填String用于接收会议纪要的 Webhook URL。
taskId必填String此次请求的 ID,需要确保唯一性。
maxIdleTime可选Int最大空闲时间(默认 30 s)。
gptConfig.model可选String大模型名称。
gptConfig.temperature可选Float大模型的 temperature 设置。
gptConfig.maxTokens可选Float大模型处理的最大 token 数。
表格内容超出当前宽度,可横向滚动查看更多列。

示例

Shell
curl --location 'https://{hostname}/0/gateway_group/gateway/start_sync' \
--header 'X-Fc-Invocation-Type: Async' \
--header 'Content-Type: application/json' \
--data '{
    "agoraRtcConfig": {
        "channelName": "smt_meeting",
        "token": "",
        "uid": "",
        "encryption": {
            "mode": 0,
            "secret": "",
            "salt": ""
        }
    },
    "agoraRtmConfig": {
        "appId": "4c24xxxxxxxxxxxxxxxxxxxxxxx0026",
        "uid": "smt_meeting_service",
        "token": "xxx"
    },
    "ossConfig": {
        "endpoint": "oss-cn-shanghai.aliyuncs.com",
        "accessKeyId": "xxx",
        "accessKeySecret": "xxx",
        "bucketName": "rte-platform",
        "objectName": "rte_app/smart_meeting_minutes/test_dir/test.txt"
    },
    "callbackUrl": "https://webhook.site/70d83d2c-a260-4866-938b-db275cf53c2f",
    "taskId": "aab",
    "maxIdleTime": 100
}'

异步模式开启会议纪要服务

该 API 适用于不需要在 Serverless 平台上部署服务的场景,即可以向同一应用程序实例发送开始和停止请求。调用该 API 发送请求后,智能会议纪要服务会立即响应。

调用该 API 开启会议纪要服务后,你需要调用停止会议纪要服务 API停止会议,会议纪要的结果将发送到指定的 Webhook URL。

接口原型

  • 请求方法:POST
  • 请求 Path:/0/gateway_group/gateway/start

路径参数

hostname:部署会议纪要服务的域名。

请求 Body

参数必填/可选类型描述
agoraRtcConfig.channelName必填String声网 RTC 频道名。
agoraRtcConfig.token可选String用于加入 RTC 频道的 Token。
agoraRtcConfig.uid可选String用户 ID,用于标识加入频道拉流的机器人。
agoraRtcConfig.encryption可选Object如果 RTC 频道设置了加密,该参数必须设置。该参数包含 mode、secret、salt 字段,分别对应 recordingConfig 的 decryptionMode、secret、salt 字段。
ossConfig.endpoint必填String你的第三方云存储地址,用于存储会议纪要结果。
ossConfig.accessKeyId必填String第三方云存储的 access key。
ossConfig.accessKeySecret必填String第三方云存储的 secret key。
ossConfig.bucketName必填String第三方云存储的 bucket。
ossConfig.objectName必填String第三方云存储的 Object name。
callbackUrl必填String用于接收会议纪要的 Webhook URL。
taskId必填String此次请求的 ID,需要确保唯一性。
maxIdleTime可选Int最大空闲时间(默认 30 s)。
gptConfig.model可选String大模型名称。
gptConfig.temperature可选Float大模型的 temperature 设置。
gptConfig.maxTokens可选Float大模型处理的最大 token 数。
表格内容超出当前宽度,可横向滚动查看更多列。

示例

Shell
curl --location 'https://{hostname}/0/gateway_group/gateway/start' \
--header 'Content-Type: application/json' \
--data '{
    "agoraRtcConfig": {
        "channelName": "smt_meeting",
        "token": "",
        "uid": "",
        "encryption": {
            "mode": 0,
            "secret": "",
            "salt": ""
        }
    },
    "ossConfig": {
        "endpoint": "oss-cn-shanghai.aliyuncs.com",
        "accessKeyId": "xxx",
        "accessKeySecret": "xxx",
        "bucketName": "rte-platform",
        "objectName": "rte_app/smart_meeting_minutes/test_dir/test.txt"
    },
    "callbackUrl": "https://webhook.site/70d83d2c-a260-4866-938b-db275cf53c2f",
    "taskId": "aab",
    "maxIdleTime": 100
}'

停止会议纪要服务

接口原型

  • 请求方法:POST
  • 请求 Path:/0/gateway_group/gateway/stop

同步模式停止服务

同步模式下,因为不能向正在运行的应用程序实例发送停止请求,你可以部署另一个函数来向消息中间件发送停止请求。正在运行的应用程序实例将接收消息并停止会议纪要服务。以使用声网 RTM 系统作为消息中间件为例,你可以通过以下方式发送停止请求。

请求 Body

参数必填/可选类型描述
agoraRtmConfig.appId必填String用于声网 RTM 的 App ID。
agoraRtmConfig.uid必填String用于登录 RTM 系统的用户 ID。
agoraRtmConfig.token必填String用于登录 RTM 系统的 Token。
taskId必填String开启服务请求中填入的 taskId。
表格内容超出当前宽度,可横向滚动查看更多列。

示例

Shell
curl --location 'https://smart-mtes-stop-rte-test-pmkrogjnwb.ap-southeast-1.fcapp.run/0/gateway_group/gateway/stop' \
--header 'Content-Type: application/json' \
--data '{
    "taskId": "aab",
    "agoraRtmConfig": {
        "uid": "smt_meeting_service_zzz",
        "token": "xxx",
        "appId": "4c24xxxxxxxxxxxxxxxxxxxxxxxx0026"
    }
}'

异步模式停止服务

异步模式下,你可以向正在运行的应用程序实例发送停止请求。智能会议纪要服务停止后,会将会议纪要的结果发送到指定的 Webhook URL。

路径参数

hostname:部署会议纪要服务的域名。

请求 Body

参数必填/可选类型描述
taskId必填String开启服务请求中填入的 taskId。
表格内容超出当前宽度,可横向滚动查看更多列。

示例

Shell
curl --location 'https://{hostname}/0/gateway_group/gateway/stop' \
--header 'Content-Type: application/json' \
--data '{
    "taskId": "aab"
}'

响应状态码

如果返回的 HTTP 状态码为 200,表示请求成功。 如果返回的 HTTP 状态码为 500,表示请求失败,请参考包体里的错误原因进行排查。

这个页面有帮助吗?