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

使用说明

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

QPS限制

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

调试

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

请求参数

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

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

请求协议：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：客户端断网重连了
     "reason": 1, |原因，枚举。1：正常调用，2：超时离开，3：在其他端登录
     "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。

返回数据

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

示例

请求示例

http(s)://live.aliyuncs.com?Action=CreateLiveMessageApp
&AppName=testApp
&AuditType=2
&AuditUrl=http://demo.aliyundoc.com/exampleaudit
&EventCallbackUrl=http://demo.aliyundoc.com/examplecallback
&DataCenter=cn-shanghai
&MsgLifeCycle=1
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateLiveMessageAppResponse>
    <RequestId>65EEDBEB-43FE-1E15-976F-3DDD753A****</RequestId>
    <AppId>demo</AppId>
    <AppKey>**********************************</AppKey>
    <AppSign>**************************************************************************</AppSign>
</CreateLiveMessageAppResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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

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