發送訊息到群組。
介面說明
呼叫本介面前,您必須已經呼叫 CreateLiveMessageGroup 建立互動訊息群組。發送訊息到群組,目標群組需要是啟用狀態,即目前群組中有使用者已加入,才能正常往群組發送訊息。不支援離線訊息,如果遇到發送訊息失敗,請先確認目前群組中是否有使用者。若需離線發送,建議將先訊息存於本地,待使用者上線後重新發送。
QPS 限制
本介面的單一使用者 QPS 限制為 50 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理呼叫。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:SendLiveMessageGroup |
none |
*Rtc
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| AppId |
string |
是 |
接收訊息的互動訊息應用 ID。 |
demo |
| GroupId |
string |
是 |
接收訊息的 GroupId。 說明
請確保傳入的 GroupId 是存在的!否則會返回 ResourceNotExist 錯誤。 |
grouptest |
| SenderId |
string |
是 |
發送訊息的使用者 ID,由大小寫字母、數字組成,長度不超過 64 位元組。 |
uid1 |
| SenderMetaInfo |
string |
否 |
發送訊息使用者的擴充資訊,長度不超過 512 位元組。 |
uid1meta1 |
| Body |
string |
否 |
訊息內容,長度不超過 15KB。 |
hello,group |
| MsgType |
integer |
否 |
訊息類型,單一群組內發送訊息的總類型數不超過 30 種。 |
1 |
| MsgTid |
string |
否 |
訊息唯一識別碼,可作為刪除訊息的依據。由大小寫字母、數字組成,長度不超過 64 位元組。 |
169830**** |
| StaticsIncrease |
integer |
否 |
該訊息對於該類訊息數量的統計增長值貢獻,預設值為 1。 |
1 |
| Weight |
integer |
否 |
訊息權重,預設值為 1。
|
1 |
| NoStorage |
boolean |
否 |
設定不儲存該訊息。預設為 false,表示儲存(目前時效 30 天),可以透過取得查詢群組訊息查到該訊息。如果您的業務不需要儲存該訊息,請設定為 true。 |
false |
| NoCache |
boolean |
否 |
設定不快取該訊息到最近訊息列表中。預設為 false,表示快取到群組最近訊息列表中。 |
false |
| DataCenter |
string |
否 |
資料中心,需要與 CreateLiveMessageApp 中的資料中心一致,目前支援上海(取值為 cn-shanghai)、新加坡(取值為 ap-southeast-1)。 |
cn-shanghai |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回參數。 |
||
| RequestId |
string |
請求 ID。 |
E4C1245F-597B-1BD1-B9BB-9D220E99**** |
| MsgTid |
string |
訊息唯一識別碼,可作為刪除訊息的依據。由大小寫字母、數字組成,長度不超過 64 位元組。 |
169830**** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "E4C1245F-597B-1BD1-B9BB-9D220E99****",
"MsgTid": "169830****"
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InputInvalid | %s. | |
| 400 | ErrorTooManyMsgTypes | %s. | |
| 500 | ServerError | %s. | |
| 403 | NoAuth | %s. | |
| 404 | ResourceNotExist | %s. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。