應用管理

應用是一套獨立的 IM 環境：IM 使用者、好友、群組、聊天室、訊息和檔案都屬於某個應用，不同應用之間的資料完全隔離。每個應用有自己的 AppKey、服務端憑據、IP 白名單、執行策略和套餐。建議為測試環境和生產環境分別建立應用。

在選單“工作臺 → 應用管理”中檢視租戶的全部應用，可以按狀態（正常、已停用）篩選。所有成員都能檢視應用，建立、修改、停用和刪除應用需要 owner 或 admin。

註冊時系統已經為新租戶建立了一個應用名為 demo 的應用，見註冊賬號。只是體驗或開發測試時可以直接使用它，正式環境建議另外建立應用。

當前應用

控制檯頂部的應用選擇框決定當前應用，顯示為顯示名稱和 app_name。“概覽”“套餐管理”和“音影片計費”都顯示當前應用的內容；在其中任何一頁切換應用，其他頁面也隨之切換。在應用詳情中切換應用時，直接開啟所選應用的同一個標籤頁。

選擇框不能清空。開啟控制檯時預設選中應用列表中的第一個應用，之後在各頁面之間切換時保持你的選擇。

建立應用

點選控制檯頂部應用選擇框旁的“建立應用”，填寫：

欄位	說明
應用名（app_name）	應用的標識：以小寫字母開頭，由小寫字母、數字和 - 組成，3 到 32 個字元，如 chat-test、chat-prod。在租戶內唯一（註冊時已經用掉了 demo），建立後不能修改，刪除後也不能再次使用
顯示名稱	便於識別的名稱，最多 128 個字元，之後可以修改
描述	可選，最多 512 個字元
客戶端註冊	是否允許使用者在客戶端自己註冊，預設關閉，見下文的客戶端註冊

應用建立在租戶的預設區域。每個租戶最多有 10 個應用（已刪除的不計），需要更多時請先完成企業認證。

新應用自動使用平臺的預設套餐，從建立當天開始計費，見套餐與賬單。

建立成功後，控制檯進入新應用的詳情，並彈出“應用已建立”，顯示應用的 app_key 和第一組服務端憑據：

• app_key：客戶端登入時使用，見下文的 AppKey；
• client_id 和 client_secret：業務服務端用它們換取 App Token。請把 client_secret 儲存到服務端的金鑰管理系統中，然後點選“我已儲存金鑰”。

之後在概覽的“接入憑證”中隨時可以複製 app_key 和 client_id；需要再次檢視 client_secret 時點選“檢視”，重新驗證身份後顯示完整的值。也可以在“服務端金鑰”中輪換出一個新的，見服務端憑據與 IP 白名單。

AppKey

AppKey 由租戶的 org_name 和應用的 app_name 用 # 連線而成，建立後立即可用，不會改變：

1100250925#demo
└── org_name ┘└ app_name

客戶端登入時使用 AppKey；服務端 REST API 的地址中分別使用兩部分，如 https://api.example.com/1100250925/demo/users，見接入概述。應用列表和應用詳情頁的頂部都可以複製 app_key。

客戶端註冊

“客戶端註冊”決定 IM 使用者可以由誰建立：

選項	取值	說明
關閉（預設）	authorized	只能由你的業務服務端呼叫建立使用者介面，或在控制檯中建立 IM 使用者。使用者只能使用你允許的賬號，適合正式環境
開放	open	使用者還可以在客戶端自己註冊賬號，任何拿到 AppKey 的人都能註冊。只建議在測試應用中使用

應用詳情

在應用列表中點選應用名稱進入應用詳情。頂部顯示顯示名稱、app_name、狀態和 app_key，下方有以下標籤頁：

標籤頁	內容
概覽與設定	使用者數和連線統計、應用資訊，修改、停用和刪除應用
IM 使用者、群組、訊息、聊天室	管理應用中的資料，見使用者、群組、聊天室與訊息
音影片	音影片的可用狀態、通話統計和通話列表，結束通話，見音影片
檔案儲存	儲存用量，檢視、下載、刪除和上傳檔案，見檔案儲存
推送	推送憑據、通知模板和推送統計，見推送配置
回撥	回撥地址、同步回撥和事件目錄，見回撥配置
內容安全	內容安全的配置、詞庫、稽核記錄、平臺處置、使用者違規和統計，見內容安全配置
應用策略	本應用的執行策略，見執行策略
套餐與用量	當前的套餐、額度、套餐變更歷史和每日用量，見應用的套餐與用量
服務端金鑰、IP 白名單	見服務端憑據與 IP 白名單

“概覽與設定”中的應用資訊：

專案	說明
顯示名稱、描述	可以修改
app_id	應用 ID，換取 App Token 的響應中的 application 就是它
客戶端註冊	開放或關閉，可以修改
區域	應用的資料所在的區域，建立後不能修改
套餐檔位、每分鐘訊息數上限	平臺為應用設定的保護性配額，只讀，見配額與熔斷。“套餐檔位”與計費的套餐無關
建立時間	應用的建立時間

頂部的使用者數和連線統計見使用者、群組、聊天室與訊息。

修改應用

owner 和 admin 在“概覽與設定”中點選“修改”，可以修改顯示名稱、描述和客戶端註冊。app_name、區域不能修改。

把客戶端註冊由開放改為關閉後，客戶端不能再註冊新使用者，已經註冊的使用者不受影響。

停用與啟用

暫時不想讓應用提供服務時（如測試應用暫不使用、發現憑據洩露），可以停用應用。owner 和 admin 在“概覽與設定”中點選“停用應用”：

• 應用已簽發的 App Token 和 User Token 立即全部失效，線上的客戶端被斷開；
• 服務端用原來的 App Token 呼叫 OpenAPI 返回 401 unauthenticated，重新換取 App Token 返回 403 app_unavailable；客戶端不能登入；
• 應用的資料全部保留。控制檯中照常可以修改應用、管理服務端金鑰、IP 白名單和應用策略；
• 停用期間應用照常計費，見計費規則。

點選“啟用應用”後恢復服務。服務端需要重新換取 App Token；客戶端續期令牌即可繼續使用，不必重新登入，但停用時間超過登入有效期（預設 7 天）的使用者需要重新登入。

刪除應用

owner 和 admin 在“概覽與設定”中點選“刪除應用”，確認後重新驗證身份。

• 應用立即從控制檯中消失，已簽發的全部令牌失效，線上的客戶端被斷開；
• 應用的全部 IM 使用者、好友、群組、訊息和檔案由後臺分批永久刪除；
• 之前簽發的 App Token 呼叫 OpenAPI 返回 401 unauthenticated，details.reason 為 app_deleted，服務端應據此清除儲存的憑據、不再重試；
• 這個 app_name 不能再用於建立新應用，避免仍在使用舊 AppKey 的客戶端連到新應用；
• 刪除當天是應用的最後一個計費日。

刪除不能恢復

刪除後資料無法找回，app_name 也不能再使用。如果只是暫時不用，請停用應用。

配額與熔斷

應用能使用的資源有兩類上限：

• 套餐的額度：註冊使用者數、併發連線數、群總數、每個群的人數、儲存容量、併發通話數、聊天室數等數量上限由應用的套餐決定，在“套餐與用量”中檢視，見額度；
• 保護性配額：平臺為每個應用設定的一組配額，防止異常流量影響服務，如每分鐘的訊息數、每秒的請求數。

控制檯的“概覽與設定”中顯示保護性配額中的兩項，只能檢視，不能修改：

專案	說明
套餐檔位	平臺為應用標記的保護性配額的檔位，預設為 standard。它只是一個標籤，各項配額的數值以平臺的設定為準，與計費的套餐無關
每分鐘訊息數上限	應用每分鐘最多傳送的訊息條數，預設 30000。客戶端和服務端傳送的訊息都計入，服務端批次傳送按接收人數計入。超出時傳送返回 429 rate_limited

儲存容量和聊天室數在保護性配額中也各有一項（儲存預設 1024 GB，聊天室預設 1 萬個），實際取配額與套餐的額度中較小的一個。應用的儲存額度顯示在“檔案儲存”的儲存用量中，用滿後不能再上傳新檔案。

另外，服務端 OpenAPI 和客戶端介面也各有每秒的請求數上限，超出時返回 429 rate_limited。在應用流量異常時，平臺還可能對應用限流、設為只讀（使用者可以登入和檢視，不能傳送訊息和修改資料）或暫停服務。這些限制的具體規則和錯誤碼見限流與應用狀態。需要更多的使用者數、連線數、儲存容量等額度時，請更換套餐；需要提高每分鐘訊息數等保護性配額時，請聯絡我們。

RTC 頻道入口

應用詳情的“RTC 頻道”提供頻道、成員、會話、統計及更正查詢，以及允許角色的處置操作，見RTC 頻道管理。它與“音影片”中的原通話列表分開；開放頻道數和媒體併發額度是不同上限。