CreateLiveMessageApp_视频直播_API文档-阿里云OpenAPI开发者门户

接口说明

调用互动消息其他接口时，需要与当前创建互动消息应用的数据中心一致。
单个阿里云账号下最多可创建 300 个互动消息应用。

QPS 限制

本接口的单用户 QPS 限制为 50 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

流控信息

请求速率为50/1(s)。

授权信息

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

live:CreateLiveMessageApp	Create	全部资源 *	无	无

请求参数

字段名称	字段详情
AppNamestring	应用名，长度 2~16 个字符。示例值:testApp参考取值来源: GetMessageApp ListMessageApp QueryMessageApp CreateMessageApp
AuditTypeinteger<int32>	安全审核方式，取值：展开详情示例值:2枚举值:012
AuditUrlstring	如果是自定义安全审核（AuditType=2），则需要提供安全审核的地址。安全审核地址以 http://或 https://开头，不包含私有 IP，不允许带端口号。自定义安全审核内容格式见下文。示例值:http://demo.aliyundoc.com/exampleaudit
EventCallbackUrlstring	客户端登录、登出、加入、离开群组等事件回调地址，若为空则不开启事件回调。触发回调接口见客户端接入。事件回调地址以 http://或 https://开头，不包含私有 IP，不允许带端口号。事件回调格式和回调鉴权逻辑见下文。示例值:http://demo.aliyundoc.com/examplecallback参考取值来源: ModifyLiveMessageAppCallback
DataCenterstring	数据中心，枚举值：展开详情示例值:cn-shanghai
MsgLifeCycleinteger<int32>	App 内群组消息的存储时效档位，取值：展开详情示例值:1

请求说明

自定义安全审核内容说明：

请求协议：HTTP
请求 Method：POST
请求示例：

{
  "content": "testaudit"
}

响应示例：

{
  "pass": true,
  "reason":"****"    |pass 为 true 表示通过，否则不通过。reason 为不通过的原因
}

说明 HTTP status code 为 200 表示成功；非 200 时，认为服务不可用，降级为不再对该消息进行审核。

事件回调

http/https post， body 为以下标例格式内容的"json utf-8 string bytes"。事件回调示例如下：

{
  "transactionid":"A8C7B033-B339-1A58-B0E0-7B9197BA****",
  "appid":"demo",
  "eves":[{
  "uid":"uid1",
  "sid":"sessionid",
  "events":[{
     "e": 3, |事件类型，枚举。1：登录，2：登出，3：joingroup，4：leavegroup，5：客户端断网重连了
     "r": 1, |登出原因，其他事件无该属性，枚举。1：正常调用，3：超时离开，4：在其他端登录
     "g": "testgroup", |群组 ID，入离群有该值；登录、登出等事件回调无该属性
     "gs":["testgroupid"] | 群组 ID 列表，客户端断网重连时，客户端加入的群组信息，其他事件无该属性
  }]
  }]
}

说明 HTTP status code 为 200 表示成功；其他表示失败，会重试发送。

回调鉴权说明

服务发起请求时在 HTTP(S)请求头中包含 Ali-Live-Timestamp 和 Ali-Live-Signature 字段，供回调消息接收服务端进行签名认证。Ali-Live-Signature 值计算方式为：Ali-Live-Signature=sha256(CONTENT)。其中，CONTENT=回调域名+Ali-Live-Timestamp 取值+鉴权 Key；回调域名指配置回调 URL 的域名，鉴权 Key 指用户创建 AppId 时生成的 AppKey。

返回参数

字段名称	字段详情
RequestIdstring	请求 ID。示例值:65EEDBEB-43FE-1E15-976F-3DDD753A****
AppIdstring	应用 ID，用于后续加入群等流程。示例值:demo
AppKeystring	AppKey，用于生成与该 AppId 相关的各种操作鉴权。示例值:**********************************
AppSignstring	应用签名，互动消息服务 SDK 需要该信息。示例值:**************************************************************************
DataCenterstring	数据中心。示例值:cn-shanghai

返回示例

错误码

没有我想要的错误码, 点击反馈

全局错误码

HTTP 状态码	错误码	错误信息	操作

400	InputInvalid	%s.	诊断
400	ErrorInvalidAppName	%s.	诊断
400	ErrorTooManyApps	%s.	诊断
400	ErrorInvalidEventCallbackUrl	%s.	诊断
400	ErrorInvalidAuditUrl	%s.	诊断
403	NoAuth	%s.	诊断
404	ResourceNotExist	%s.	诊断
500	ServerError	%s.	诊断

变更历史

	变更时间	变更内容概要	操作
	2025-02-26	删除请求参数StreamSupport
	2025-01-22	新增请求参数StreamSupport
	2024-03-13	新增请求参数MsgLifeCycle
	2024-01-31	变更错误码400 变更返回参数