調用CreateLiveMessageApp創建互動消息應用。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
live:CreateLiveMessageApp | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppName | string | 否 | 應用名,長度 2~16 個字符。 | testApp |
AuditType | integer | 否 | 安全審核方式,取值:
| 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 |
MsgLifeCycle | integer | 否 | App 內群組消息的存儲時效檔位,取值:
| 1 |
自定義安全審核內容說明:
- 請求協議:HTTP
- 請求 Method:POST
- 請求示例:
{
"content": "testaudit"
}
- 響應示例:
{
"pass": true,
"reason":"****" |pass 為 true 表示通過,否則不通過。reason 為不通過的原因
}
事件回調
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(S)請求頭中包含 Ali-Live-Timestamp 和 Ali-Live-Signature 字段,供回調消息接收服務端進行簽名認證。Ali-Live-Signature 值計算方式為:Ali-Live-Signature=sha256(CONTENT)。其中,CONTENT=回調域名+Ali-Live-Timestamp 取值+鑒權 Key;回調域名指配置回調 URL 的域名,鑒權 Key 指用戶創建 AppId 時生成的 AppKey。
返回參數
示例
正常返回示例
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無效,請檢查后重新嘗試。 |
403 | NoAuth | %s. | 沒有權限 |
404 | ResourceNotExist | %s. | 請求資源不存在,請檢查后重新嘗試 |
500 | ServerError | %s. | 未知錯誤,請稍后重試或提交工單咨詢。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-03-13 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2024-01-31 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |