鍵.png)
使用這些基本 REST API 最佳實(shí)踐構(gòu)建出色的 API
2.手機(jī)號注冊以后會需要填寫郵箱,根據(jù)填寫的郵箱去郵箱中驗(yàn)證。
3.郵箱驗(yàn)證完成以后就可以正常使用平臺提供的功能。可以在控制臺中查看到應(yīng)用的詳細(xì)信息。
4.點(diǎn)擊對應(yīng)的應(yīng)用中操作欄中的管理按鈕,可以查看到詳細(xì)信息,例如Client ID、ClientSecret等。
在獲取API密鑰后,進(jìn)行可用性測試是確保其正常工作的重要步驟。以下是web端使用按需導(dǎo)入 SDK進(jìn)行測試的一個(gè)案例
首先,通過 npm、yarn 或者其他包管理工具進(jìn)行安裝 SDK。
# npm
npm install easemob-websdk
?
# yarn
yarn add easemob-websdk
根據(jù)項(xiàng)目需求引入相應(yīng)的功能模塊。例如,引入用戶關(guān)系模塊:
import MiniCore from "easemob-websdk/miniCore/miniCore";
import * as contactPlugin from "easemob-websdk/contact/contact";
將引入的功能模塊注冊到 miniCore 中:
const miniCore = new MiniCore({
?appKey: "your appKey",
});
?
// "contact" 為固定值
miniCore.usePlugin(contactPlugin, "contact");
注冊所需模塊后,即可在項(xiàng)目中使用這些模塊提供的功能:
// 獲取聯(lián)系人列表
miniCore.contact.getContacts();
在使用 easemob 開放平臺 API搭建應(yīng)用時(shí),除了獲取和測試API密鑰外,還需考慮以下因素:
提示
SDK 提供了靈活的模塊化設(shè)計(jì),允許開發(fā)者根據(jù)需求引入功能模塊,并將其注冊到 miniCore 中使用。
miniCore 是一個(gè)基座,支持登錄登出和發(fā)送消息等基礎(chǔ)功能open in new window,而且包含消息對象。因此,若只使用收發(fā)消息功能,則只需引入 miniCore。若使用其他功能,miniCore 支持使用插件的方式引入其他功能模塊。按需引入模塊的方式實(shí)現(xiàn)了不同模塊的靈活組合,從而避免不必要的代碼加載,減小了應(yīng)用程序的體積。
功能 | 導(dǎo)入文件 | 使用方式 |
---|---|---|
聯(lián)系人和消息管理 | import * as contactPlugin from “easemob-websdk/contact/contact”; | miniCore.usePlugin(contactPlugin, “contact”); |
群組 | import * as groupPlugin from “easemob-websdk/group/group”; | miniCore.usePlugin(groupPlugin, “group”); |
聊天室 | import * as chatroomPlugin from “easemob-websdk/chatroom/chatroom”; | miniCore.usePlugin(chatroomPlugin, “chatroom”); |
子區(qū) | import * as threadPlugin from “easemob-websdk/thread/thread”; | miniCore.usePlugin(threadPlugin, “thread”); |
翻譯 | import * as translationPlugin from “easemob-websdk/translation/translation”; | miniCore.usePlugin(translationPlugin, “translation”); |
在線狀態(tài)訂閱 | import * as presencePlugin from “easemob-websdk/presence/presence”; | miniCore.usePlugin(presencePlugin, “presence”); |
會話免打擾 | import * as silentPlugin from “easemob-websdk/silent/silent”; | miniCore.usePlugin(silentPlugin, “silent”); |
錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述和可能原因 |
---|---|---|
0 | REQUEST_SUCCESS | 提示操作成功,沒有錯(cuò)誤。 |
-1 | REQUEST_TIMEOUT | 請求服務(wù)超時(shí)。 |
-2 | REQUEST_UNKNOWN | 默認(rèn)未區(qū)分類型的錯(cuò)誤。 |
-3 | REQUEST_PARAMETER_ERROR | 參數(shù)錯(cuò)誤。 |
-4 | REQUEST_ABORT | 取消請求。 |
1 | WEBIM_CONNCTION_OPEN_ERROR | 登錄失?。韩@取 token 接口請求失敗或 Token 無效。 |
2 | WEBIM_CONNCTION_AUTH_ERROR | 登錄鑒權(quán)失敗。 |
12 | WEBIM_CONNCTION_GETROSTER_ERROR | 獲取 Chat token 失?。和ㄟ^ Agora token 置換 Chat token 失敗。 |
16 | WEBIM_CONNCTION_DISCONNECTED | WebSocket 斷開連接:由于斷網(wǎng)等原因 WebSocket 已經(jīng)斷開。 |
17 | WEBIM_CONNCTION_AJAX_ERROR | 服務(wù)請求的通用錯(cuò)誤:請求服務(wù)器未成功時(shí)的默認(rèn)錯(cuò)誤。 |
27 | WEBIM_CONNCTION_APPKEY_NOT_ASSIGN_ERROR | 未設(shè)置 App Key:設(shè)置的 App Key 錯(cuò)誤,登錄時(shí)會報(bào)此錯(cuò)誤。 |
28 | WEBIM_CONNCTION_TOKEN_NOT_ASSIGN_ERROR | 未傳 token:調(diào)用 API 時(shí)沒有攜帶 token,一般沒登錄時(shí)調(diào)用 API 會提示這個(gè)錯(cuò)誤。 |
31 | WEBIM_CONNCTION_CALLBACK_INNER_ERROR | 消息發(fā)送回調(diào)函數(shù)內(nèi)部錯(cuò)誤:在接收消息的回調(diào)及后續(xù)處理的函數(shù)中有錯(cuò)誤。 |
32 | WEBIM_CONNCTION_CLIENT_OFFLINE | 當(dāng)前用戶未登錄。 |
39 | WEBIM_CONNECTION_CLOSED | 退出或未登錄:未登錄或掉線后發(fā)送消息。 |
40 | WEBIM_CONNECTION_ERROR | 用戶鑒權(quán)失敗。 |
50 | MAX_LIMIT | 達(dá)到上限,例如 Reaction 數(shù)量已達(dá)到限制、翻譯用量達(dá)到上限、應(yīng)用的日活躍用戶數(shù)(DAU)超限、在線用戶數(shù)量超限和月活躍用戶數(shù)(MAU)。 |
51 | MESSAGE_NOT_FOUND | 沒查到消息,如:沒有查詢到要舉報(bào)的消息。 |
52 | NO_PERMISSION | 用戶對當(dāng)前操作沒有權(quán)限。 |
53 | OPERATION_UNSUPPORTED | 不支持的操作。 |
101 | WEBIM_UPLOADFILE_ERROR | 上傳文件失?。喝缥募^大等。 |
在申請和使用easemob 開放平臺API密鑰過程中,你可能會遇到以下常見問題:
群組操作失敗,提示權(quán)限不足,如何解決?
請確認(rèn)您在群組中的角色是否具有相應(yīng)的操作權(quán)限,例如創(chuàng)建者、管理員或普通成員的權(quán)限級別可能不同。您可以在官方文檔中查找關(guān)于群組權(quán)限的詳細(xì)說明。
如何處理用戶被踢下線的情況?
當(dāng)同一用戶在其他設(shè)備登錄,或用戶密碼被修改時(shí),可能會導(dǎo)致當(dāng)前設(shè)備的用戶被踢下線。請確保未在其他設(shè)備上重復(fù)登錄,或在密碼修改后重新登錄。
為什么用戶登錄時(shí)提示鑒權(quán)失???
這可能是由于 App Key 設(shè)置錯(cuò)誤、用戶憑證無效或網(wǎng)絡(luò)問題導(dǎo)致的。請確保在初始化 SDK 時(shí)使用了正確的 App Key,并驗(yàn)證用戶的用戶名和密碼是否正確。
在獲得 easemob 開放平臺API密鑰之后,即可開啟對接,本文整理了多篇使用 easemob 開放平臺 案例,幫助讀者更有效地使用
發(fā)送和接收消息、管理本地會話、管理用戶屬性、管理用戶關(guān)系、創(chuàng)建和管理群組及監(jiān)聽群組事件
問題1: 什么是冪簡集成平臺?
冪簡集成是蜜堂有信在2023年打造的一款SAAS產(chǎn)品,建設(shè)著國內(nèi)最全的API平臺,為開發(fā)者提供全面、高效、易用的API集成管理方案,一站搜索、試用、集成國內(nèi)和國外API。讓用戶在AI時(shí)代全方位接入互聯(lián)網(wǎng),用API連接一切服務(wù)和算力,實(shí)現(xiàn)價(jià)值倍增。
問題2:如何找到 easemob 開放平臺 API
冪簡API平臺可以通過以下兩種方式找到所需API:通過關(guān)鍵詞搜索API(例如,輸入’ easemob 開放平臺 API‘這類品類詞,更容易找到結(jié)果)、或者從API hub分類頁進(jìn)入尋找。
問題3: easemob 開放平臺 API的替代品有哪些?
市場上存在免費(fèi)、付費(fèi)兩種替代者
例如
更多競品可以在 easemob 開放平臺 找到。
本文介紹了獲取 easemob 開放平臺 API密鑰的步驟,從賬號注冊到獲取到appKey等關(guān)鍵信息,同時(shí)提供了通過按需導(dǎo)入 SDK 進(jìn)行可用性測試的具體案例,并探討了在集成過程中需要注意的事項(xiàng)。還針對申請和使用API密鑰時(shí)的常見問題提供了解決方案,并總結(jié)了 API 的實(shí)際應(yīng)用場景及相關(guān)進(jìn)階使用方法,為開發(fā)者有效利用easemob開放平臺提供了全面的指導(dǎo)。