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

*全部資源。

*

無

請求參數

名稱	類型	必填	描述	樣本值
AppName	string	否	應用程式名稱，長度 2~16 個字元。	testApp
AuditType	integer	否	安全審核方式，取值： 0：預設值，不啟用安全審核。 1：內建安全審核。 2：自訂安全審核。枚舉值： 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.	請求資源不存在，請檢查後重新嘗試。

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

變更歷史

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