NotifyAgent
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rtc:NotifyAgent | none | *App acs:rtc::{#accountId}:app/{#AppId} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 否 | 应用 ID,可通过控制台创建和查询,仅支持传单个 ID。 | aec**** |
ChannelId | string | 否 | 加入的频道,仅支持传单个 ID。 | yourChannelId |
TaskId | string | 否 | 任务 ID。 | yourTaskId |
Message | string | 否 | 播报文本内容 | 您好,现在是2025年4月16日,请问需要什么帮助 |
Priority | integer | 否 | priority 表示播报插入等级: 1——打断当前交互立即播报 2——等待当前交互结束后播报 3——如果当前不在交互则播报 | 1 |
Interruptable | boolean | 否 | 表示播报消息是否允许被打断,如为 false,则播报消息不能被语音打断、按键打断等方式打断 | true |
CustomAttribute | string | 否 | 自定义参数,透传到客户端 | {\"color\":\"blue\"} |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "760bad53276431c499e30dc36f6b26be"
}
错误码
访问错误中心查看更多错误码。