CreateLiveMessageApp - 创建互动消息应用_视频直播(LIVE)-阿里云帮助中心

接口说明

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

QPS 限制

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

live:CreateLiveMessageApp

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
AppName	string	否	应用名，长度 2~16 个字符。	testApp
AuditType	integer	否	安全审核方式，取值： 0：默认值，不开启安全审核。 1：内置安全审核。 2：自定义安全审核。	2
AuditUrl	string	否	如果是自定义安全审核（AuditType=2），则需要提供安全审核的地址。安全审核地址以 http://或 https://开头，不包含私有 IP，不允许带端口号。自定义安全审核内容格式见下文。	http://demo.aliyundoc.com/exampleaudit
EventCallbackUrl	string	否	客户端登录、登出、加入、离开群组等事件回调地址，若为空则不开启事件回调。触发回调接口见客户端接入。事件回调地址以 http://或 https://开头，不包含私有 IP，不允许带端口号。事件回调格式和回调鉴权逻辑见下文。	http://demo.aliyundoc.com/examplecallback
DataCenter	string	否	数据中心，枚举值： cn-shanghai：默认值，上海。 ap-southeast-1：新加坡。说明调用直播互动其他接口时，需要与当前创建直播互动应用的数据中心一致。	cn-shanghai
MsgLifeCycle	integer	否	App 内群组消息的存储时效档位，取值： 0：默认值，存储 30 天。 1：存储 90 天。 2：存储 180 天。	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"。事件回调示例如下：

{
  "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。

返回参数

名称	类型	描述	示例值
	object	返回参数。
RequestId	string	请求 ID。	65EEDBEB-43FE-1E15-976F-3DDD753A****
AppId	string	应用 ID，用于后续加入群等流程。	demo
AppKey	string	AppKey，用于生成与该 AppId 相关的各种操作鉴权。	**********************************
AppSign	string	应用签名，互动消息服务 SDK 需要该信息。	**************************************************************************
DataCenter	string	数据中心。	cn-shanghai

示例

正常返回示例

JSON格式

{
  "RequestId": "65EEDBEB-43FE-1E15-976F-3DDD753A****",
  "AppId": "demo",
  "AppKey": "**********************************",
  "AppSign": "**************************************************************************",
  "DataCenter": "cn-shanghai"
}

错误码

HTTP status code	错误码	错误信息	描述
400	InputInvalid	%s.	输入参数不合法
400	ErrorInvalidAppName	%s.	AppName无效，请检查后重新尝试。
400	ErrorTooManyApps	%s.	每个账号下，最多同时允许创建300个App
400	ErrorInvalidEventCallbackUrl	%s.	EventCallbackUrl无效，请检查后重新尝试。
400	ErrorInvalidAuditUrl	%s.	AuditUrl无效，请检查后重新尝试。
500	ServerError	%s.	未知错误，请稍后重试或提交工单咨询。
403	NoAuth	%s.	没有权限
404	ResourceNotExist	%s.	请求资源不存在，请检查后重新尝试

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。