CreateLiveMessageApp - ApsaraVideo Live

介面說明

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

QPS 限制

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

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

live:CreateLiveMessageApp

create

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
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.
400	ErrorTooManyApps	%s.
400	ErrorInvalidEventCallbackUrl	%s.
400	ErrorInvalidAuditUrl	%s.
500	ServerError	%s.
403	NoAuth	%s.
404	ResourceNotExist	%s.

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。