調用CreateLiveMessageGroup建立互動訊息群組。
介面說明
調用本介面前,您必須已經調用 CreateLiveMessageApp 建立互動訊息應用。
單個互動訊息應用下最多可建立 5000 個互動訊息群組。
QPS 限制
本介面的單使用者 QPS 限制為 50 次/秒。超過限制,API 呼叫會被限流,這可能會影響您的業務,請合理調用。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
live:CreateLiveMessageGroup |
create |
*Rtc
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| AppId |
string |
是 |
應用 ID。 |
demo |
| GroupId |
string |
是 |
要建立的群組 ID,業務應保證群組 ID 唯一,由大小寫字母、數字組成,長度不超過 64 位元組。 |
grouptest |
| GroupName |
string |
否 |
群組名,長度不超過 128 位元組。 |
mytestgroup |
| GroupInfo |
string |
否 |
群組擴充資訊,長度不超過 32KB。 |
testgroupinfo |
| Administrators |
array |
否 |
管理使用者 ID 列表。 |
|
|
string |
否 |
管理使用者 ID,由大小寫字母、數字組成,長度不超過 64 位元組。多個用半形逗號(,)隔開,最多不超過 3 個。 |
uid1 |
|
| CreatorId |
string |
否 |
群組建立者 ID,由大小寫字母、數字組成,長度不超過 64 位元組。 |
uid1 |
| DataCenter |
string |
否 |
資料中心,需要與 CreateLiveMessageApp 中的資料中心一致, 當前支援上海(取值為 cn-shanghai)、新加坡(取值為 ap-southeast-1)。 |
cn-shanghai |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回參數。 |
||
| RequestId |
string |
請求 ID。 |
A8C7B033-B339-1A58-B0E0-7B9197BA**** |
| GroupId |
string |
建立的群組 ID。 |
grouptest |
| AlreadyExists |
boolean |
是否已經存在。 |
true |
| AlreadyDelete |
boolean |
是否已刪除。如果已存在,且被刪除了,那麼群組 ID 是處於不可用狀態,建議重新建立。 |
true |
樣本
正常返回樣本
JSON格式
{
"RequestId": "A8C7B033-B339-1A58-B0E0-7B9197BA****",
"GroupId": "grouptest",
"AlreadyExists": true,
"AlreadyDelete": true
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | InputInvalid | %s. | 輸入參數不合法 |
| 400 | ErrorTooManyGroups | %s. | 每個AppId,最多同時允許建立5000個群組 |
| 500 | ServerError | %s. | 未知錯誤,請稍後重試或提交工單諮詢。 |
| 403 | NoAuth | %s. | 沒有許可權 |
| 404 | ResourceNotExist | %s. | 請求資源不存在,請檢查後重新嘗試 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。