导航|地址|刷新
H5&小程序 SDK API文档-个推文档中心
图
图
图



文档中心开发者中心

，欢迎您！

您的优惠服务将于到期。





基本资料



安全设置



应用管理




退出登录
登录/注册SDK下载个推学堂请选择产品
消息推送

用户运营

OneID服务

AI应用工坊

统计分析

用户分析

标签管理

模型管理

短信服务

数字人外呼

一键认证

合规检测

点击提升







体验更多产品服务


欢迎登录开发者中心

立即登录

本月不再提醒





使用手册

客户端
Android
集成文档

API文档


iOS
集成文档

API文档


H5&小程序
集成文档

API文档



常见问题

SDK更新日志




当前位置：个推AI应用工坊 > 客户端 > H5&小程序 > API文档



H5&小程序 SDK API文档


H5&小程序 SDK API文档

1 初始化启动接口

接口描述:

启动 SDK

接口定义:
functioninit(obj: { appId: string, onSuccess: (res: any) => void, onFailure: (res: any) => void }): void;
接口说明:

参数参数说明
appId应用标识 APPID
userId开发者用户体系下的userId
onSuccess初始化成功回调
onFailure初始化失败回调


接口示例:
import AISDK from'./lib/aisdk-${platform}.js'import GTC from'./lib/gtc-${platform}.js' App({ globalData: {}, onLaunch: function () { AISDK.init({ appId: DEFAULT_APP_ID, userId: "", onSuccess: function (res) { const text = '初始化成功：' + stringify(res) console.log(text) }, onFailure: function (err) { /* onFailure中的错误码说明： -10002：相同 `userId` 重复初始化 ， 避免对同一 `userId` 重复调用 `AISDK.init` -30001：网络错误 -50001：userid 不合法， 要求userid长度<100 */const text = '初始化失败：' + stringify(err) console.error(text) } }) console.log(AISDK.getVersion()) }, });
2 请求智能体

接口描述:

获取智能体 url，展示智能体web。需要先初始化完成后，才能调用请求智能体API。

接口定义:
functionloadAgent(obj: { agentId: string, show: boolean, onSuccess: (res: any) => void, onFailure: (res: any) => void }): void;
接口说明:

参数参数说明
agentId智能体ID
show是否展示网页。在H5平台下，show=true时会在当前页面创建iframe并展示智能体页面。在小程序平台下，不支持show=true，开发者需要自行创建webview加载url
onSuccess加载智能体成功回调
onFailure加载智能体失败回调


接口示例:
var agentId = "xxx" AISDK.loadAgent({ agentId, show: true, onSuccess: function (url) { const text = 'loadAgent 成功：' + urlconsole.log(text) }, onFailure: function (err) { const text = 'loadAgent 失败：' + stringify(err) console.error(text) } }) /* onFailure中的错误码说明： -30001：网络错误 -40001：频率超限，1s1次 -40002：重复请求 -40003：未注册成功 -40004：agentid 不合法 -40005：平台不支持show -40006：show参数不合法，show必须是bool值 */
API说明文件

AISDK.d.ts⽂件如下
declarenamespace AISDK { /** * 获取当前SDK版本 * @returns {string} 当前SDK版本 */functiongetVersion(): string; exportfunctioninit(obj: { /** * 个推官网生成的appid */ appId: string, /** * 开发者用户体系下的userId */ userId: string, /** * 初始化成功回调 * @param res 初始化成功返回的数据 */ onSuccess: (res: any) => void, /** * 初始化失败回调 * @param res 初始化失败返回的数据 */ onFailure: (res: any) => void }): void; /** * 请求智能体 * @param */exportfunctionloadAgent(obj: { agentId: string, show: boolean, onSuccess: (res: any) => void, onFailure: (res: any) => void }): void; }



以上文档对您是否有帮助？
有帮助没帮助



您的改进建议

是否遇到以下问题

问题类型


1、内容与功能不一致；

2、文章描述不清晰；

3、图片和视频难理解；

4、对产品功能不满意；

5、不是我想要的内容；

6、其他:


问题类型不能为空



反馈建议



联系方式



取 消提 交





反馈成功

非常感谢您的反馈，我们会继续努力做到更好！
确定






在这篇文章中：1 初始化启动接口2 请求智能体API说明文件







文档中心搜索

搜 索















------
导航页 打开网址