Skip to content

SDK 基本初始化

如果想使用Autoxing 机器人 SDK,需先初始化,SDK 初始化完成后才可以正常使用。

以下为 SDK 初始化代码示例:

TypeScript
import { AXRobot, AppMode } from "@autoxing/robot-js-sdk";

// 创建 AXRobot 实例
const axRobot = new AXRobot("<appId>", "<appSecret>", AppMode.WAN_APP, "<serverUrl>", "<websocketUrl>");

// 初始化 AXRobot 实例
const successed = await axRobot.init();
if (successed) {
  // 初始化成功
} else {
  // 初始化失败
}

参数解析

名称 数据类型 说明
appId string 应用 ID,可向相关运营人员申请提供
appSecret string 数据请求密钥,可向相关运营人员申请提供
AppMode string 应用模式
serverUrl string 可选
如果不填,服务默认使用国服接入点
serverUrl:
国服接入点:"https://api.autoxing.com/"
海外接入点:"https://apiglobal.autoxing.com/"
websocketUrl string 可选
如果不填,服务默认使用国服接入点
websocketUrl:
国服接入点:"wss://service.autoxing.com/"
海外接入点:"wss://serviceglobal.autoxing.com/"

示例