ReAI 内部接口 sdk

使用方法

安装

npm i @re-ai/inner-tool-sdk

import { ReAITool, SMSPlatforms } from '@re-ai/inner-tool-sdk'

// 发送短信
ReAITool.sms().smsCodeSend({
    platform: SMSPlatforms.ALI,
    mobile: "xxxxxxxx"
})

// 验证短信
ReAITool.sms().smsCodeVerify({
    mobile: "xxxxxxxx",
    code: "xxxxxxxx"
})

支付接口

方法

create(data: PayOrderCreateData): Promise<RPCClientResponseResult<PayOrderInfo>>

创建新的支付订单。

• 参数:
  • data (PayOrderCreateData): 包含订单创建数据的对象。
    • orderNo (string): 唯一订单号。
    • amount (number): 订单总金额。
    • desc (string): 订单描述。
    • ip (string): 发起订单的IP地址。
    • type (PayType): 支付类型（wxpay 微信支付或 alipay 支付宝支付）。
    • platform ("pc" | "h5" | "jsapi"): 发起订单的平台。
    • returnUrl (string?): 支付成功后重定向的URL。
    • notifyUrl (string?): 接收支付通知的URL。

get(orderNo: string): Promise<RPCClientResponseResult<PayOrderInfo>>

获取现有订单的详细信息。

• 参数:
  • orderNo (string): 订单的唯一标识符。

短信接口

方法

smsCodeSend(data: SMSSendArgs): Promise<RPCClientResponseResult<SMSSendRes>>

发送短信验证码。

• 参数:
  • data (SMSSendArgs): 包含发送短信数据的对象。
    • mobile (string): 将发送短信的手机号码。
    • platform (SMSPlatforms): 将使用的短信平台（ali 阿里云或 tx 腾讯云）。

smsCodeVerify(data: SMSVerifyArgs): Promise<RPCClientResponseResult<undefined>>

验证用户接收到的短信验证码。

• 参数:
  • data (SMSVerifyArgs): 包含验证数据的对象。
    • mobile (string): 与短信验证码相关联的手机号码。
    • code (string): 要验证的验证码。

枚举和类型

PayType

定义支付系统的类型。

• wxpay: 微信支付
• alipay: 支付宝支付

SMSPlatforms

定义发送短信的平台。

• ali: 阿里云
• tx: 腾讯云