全部產品
Search

搜尋本產品

    ApsaraVideo Live：SendLiveMessageUser - 發送訊息給指定使用者

    文件中心

    ApsaraVideo Live：SendLiveMessageUser - 發送訊息給指定使用者

    更新時間：Dec 13, 2025

    發送訊息給指定使用者，使用者身份由ReceiverId標識。

    介面說明

    本介面的單使用者 QPS 限制為 50 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。

    調試

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

    調試

    授權資訊

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

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    live:SendLiveMessageUser

    create

    *Rtc

    acs:live::{#accountId}:rtc/{#AppId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    AppId

    string

    是

    發送訊息的互動訊息應用 ID。

    demo
    ReceiverId

    string

    是

    接收訊息的使用者識別碼，由大小寫字母、數字組成，長度不超過 64 位元組。

    說明

    請確保接收訊息的使用者的狀態為線上！可以通過調用 CheckLiveMessageUsersOnline 來查詢該使用者狀態。

    uid2
    SenderId

    string

    是

    發送訊息的使用者識別碼，由大小寫字母、數字組成，長度不超過 64 位元組。

    uid1
    SenderInfo

    string

    否

    發送訊息使用者的擴充資訊，長度不超過 512 位元組。

    uid1meta1
    Body

    string

    否

    訊息體，長度不超過 15KB。

    hello, user
    MsgType

    integer

    否

    訊息類型。

    2
    MsgTid

    string

    否

    訊息唯一標識，可作為刪除訊息的依據。由大小寫字母、數字組成，長度不超過 64 位元組。

    169830****
    DataCenter

    string

    否

    資料中心，需要與 CreateLiveMessageApp 中的資料中心一致，當前支援上海（取值為 cn-shanghai)、新加坡（取值為 ap-southeast-1）。

    cn-shanghai
    HighReliability

    boolean

    否

    設定該條訊息是否為高可靠訊息。高可靠訊息確保接收方已收到該條訊息並響應才會返回成功，如果接收方在 3s 內未響應會返回傳送失敗。

    • true：表示高可靠訊息。

    • false（預設）：表示非高可靠訊息。

    說明

    用戶端 SDK v1.5.1 及以上版本才支援此參數，發訊息給老版本用戶端時不等待 ACK 直接返回成功。

    false
    Storage

    boolean

    否

    設定儲存該訊息。

    • true：表示儲存該訊息。

    • false（預設），表示不需要儲存。

    false

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回參數。

    RequestId

    string

    請求 ID。

    6CFDE7AB-571A-14EA-B072-989FF753****
    MsgTid

    string

    訊息唯一標識，可作為刪除訊息的依據。由大小寫字母、數字組成，長度不超過 64 位元組。

    169830****

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "6CFDE7AB-571A-14EA-B072-989FF753****",
  "MsgTid": "169830****"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InputInvalid %s. 輸入參數不合法
    500 ServerError %s. 未知錯誤，請稍後重試或提交工單諮詢。
    403 NoAuth %s. 沒有許可權
    404 ResourceNotExist %s. 請求資源不存在，請檢查後重新嘗試
    408 UserNotAck %s. 發高可靠訊息給使用者 ，使用者未響應

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

    變更歷史

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