發(fā)送消息到群組。
接口說明
調(diào)用本接口前,您必須已經(jīng)調(diào)用 CreateLiveMessageGroup 創(chuàng)建互動(dòng)消息群組。發(fā)送消息到群組,目標(biāo)群組需要是激活狀態(tài),即當(dāng)前群組中有用戶已加入,才能正常往群組發(fā)送消息。如果遇到發(fā)送消息失敗,請(qǐng)先確認(rèn)當(dāng)前群組中是否有用戶。
QPS 限制
本接口的單用戶 QPS 限制為 50 次/秒。超過限制,API 調(diào)用會(huì)被限流,這可能會(huì)影響您的業(yè)務(wù),請(qǐng)合理調(diào)用。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
live:SendLiveMessageGroup | none | *Rtc acs:live::{#accountId}:rtc/{#AppId} |
| 無 |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | 接收消息的互動(dòng)消息應(yīng)用 ID。 | demo |
GroupId | string | 是 | 接收消息的 GroupID。 | grouptest |
SenderId | string | 是 | 發(fā)送消息的用戶 ID,由大小寫字母、數(shù)字組成,長(zhǎng)度不超過 64 字節(jié)。 | uid1 |
SenderMetaInfo | string | 否 | 發(fā)送消息用戶的擴(kuò)展信息,長(zhǎng)度不超過 512 字節(jié)。 | uid1meta1 |
Body | string | 否 | 消息體,長(zhǎng)度不超過 15KB。 | hello,group |
MsgType | long | 否 | 消息類型。 | 1 |
MsgTid | string | 否 | 消息唯一標(biāo)識(shí),可作為刪除消息的依據(jù)。由大小寫字母、數(shù)字組成,長(zhǎng)度不超過 64 字節(jié)。 | 169830**** |
StaticsIncrease | long | 否 | 該消息對(duì)于該類消息數(shù)量的統(tǒng)計(jì)增長(zhǎng)值貢獻(xiàn),默認(rèn)值為 1。 | 1 |
Weight | long | 否 | 消息權(quán)重,默認(rèn)值為 1。對(duì)于高優(yōu)消息,可設(shè)置權(quán)重為 1000000。 | 1 |
NoStorage | boolean | 否 | 設(shè)置不存儲(chǔ)該消息。默認(rèn)為 false,表示存儲(chǔ)(當(dāng)前時(shí)效 30 天),可以通過獲取查詢?nèi)航M消息查到該消息。如果您的業(yè)務(wù)不需要存儲(chǔ)該消息,請(qǐng)?jiān)O(shè)置為 true。 | false |
NoCache | boolean | 否 | 設(shè)置不緩存該消息到最近消息列表中。默認(rèn)為 false,表示緩存到群組最近消息列表中。 | false |
DataCenter | string | 否 | 數(shù)據(jù)中心,需要與 CreateLiveMessageApp 中的數(shù)據(jù)中心一致,當(dāng)前支持上海(取值為 cn-shanghai)、新加坡(取值為 ap-southeast-1)。 | cn-shanghai |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"RequestId": "E4C1245F-597B-1BD1-B9BB-9D220E99****"
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | InputInvalid | %s. | 輸入?yún)?shù)不合法 |
403 | NoAuth | %s. | 沒有權(quán)限 |
404 | ResourceNotExist | %s. | 請(qǐng)求資源不存在,請(qǐng)檢查后重新嘗試 |
500 | ServerError | %s. | 未知錯(cuò)誤,請(qǐng)稍后重試或提交工單咨詢。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-01-09 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2023-12-13 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |