类型脚本的 sendon SDK

* 安装

npm install @alipeople/sendon-sdk-typescript

或与雅恩:

yarn add @alipeople/sendon-sdk-typescript

QQ 快速启动

import { Sendon } from '@alipeople/sendon-sdk-typescript';

// Initialize the SDK
const sendon = new Sendon({
  id: 'your-api-id',
  apikey: 'your-api-key',
  debug: false // Optional: Enable debug mode for detailed logging
});

// Send an SMS message
const result = await sendon.sms.send({
  from: '01012345678',
  to: ['01087654321'],
  message: 'Hello, World!'
});

* 特性

📱 短信服务

完成有企业等级可靠性的短消息/LMS/MMS通讯能力.

• 短信/LMS通讯: 发送短而长的短信
• MMS 支助: 有图像的丰富的媒体信息
• 批量发送: 高效地向多个收件人发送消息
• 计划交付: 为最佳时间安排信件
• 交付报告: 实时状态跟踪和报告
• 图像管理: 上传并管理 MMS 图像

💬 卡考服务

AlimTalk 和 BrandMessage 的综合Kakao Business Message 集成.

• 阿利姆演讲: 基于模板的信息消息
• 白话: 有各种模板的丰富的促销信息
  • 文本、 图像、 宽度、 宽度项目列表和卡卢塞尔种子格式
• 模板管理: 创建、更新和管理信件模板
• 发送配置管理: 处理多发件人配置文件
• 审查系统: 模板审查请求和状态跟踪
• 批量通讯: 高效发送给多个收件人

🎯 区域支助事务处

下一代富通通信服务增强移动信息.

• 丰富的媒体支持: 交互式卡片、旋转木马和按钮
• 标记信件:自定义品牌和样式
• CSV 上传: 通过 CSV 进行批量接收管理
• 高级分析: 详细消息性能跟踪
• 后退选项: 自动回落到短消息/ MMS

🚫 联系人处

邮件控制屏蔽列表管理.

• 块状管理: 从块列表中添加并删除数字
• 多渠道支持: 横跨短消息频道和Kakao频道的区块编号
• 块类型过滤: 不同的屏蔽类别
• 日期范围查询: 按日期范围搜索块列表
• 缓冲支持: 大块列表的有效处理

📤 发件人服务

发件人号码管理和验证.

• 编号: 查看所有已注册的发件人号码
• 缓冲支持: 通过多发件人号码浏览
• 数量: 经核实的发送者号码管理

💳 支付服务

支付历史和交易跟踪.

• 支付历史: 查看详细的支付交易日志
• 日期范围过滤: 按日期范围分列的搜索付款
• 交易细节: 获取特定付款信息
• 缓冲支持:通过付款记录导航

💰 点服务

信息成本计算和点追踪.

• 费用计算: 获取消息发送成本
• 点列表: 查看可用点和余额
• 用法跟踪: 监测点消耗

API 参考

初始化

const sendon = new Sendon({
  id: string,        // Your API ID
  apikey: string,    // Your API Key
  debug?: boolean    // Enable debug logging (optional)
});

短信服务

// Send SMS/LMS/MMS
await sendon.sms.send({
  from: string,
  to: string[],
  message: string,
  subject?: string,  // For LMS/MMS
  images?: File[]    // For MMS
});

// Cancel scheduled message
await sendon.sms.cancel(groupId);

// Get message status
await sendon.sms.find(groupId);

卡考服务

// Send AlimTalk
await sendon.kakao.sendAlimTalk({
  sendProfileId: string,
  templateCode: string,
  messages: MessageData[]
});

// Send BrandMessage
await sendon.kakao.sendBrandMessage({
  sendProfileId: string,
  templateCode: string,
  messages: MessageData[]
});

// Template Management
await sendon.kakao.createTemplate(sendProfileId, templateData);
await sendon.kakao.getTemplates(sendProfileId, query);
await sendon.kakao.updateTemplate(sendProfileId, templateId, templateData);

区域支助事务处

// Send RCS message
await sendon.rcs.send({
  messageType: 'SMS' | 'LMS' | 'MMS' | 'RCS',
  from: string,
  messages: RcsMessageData[]
});

// Get CSV upload URL
await sendon.rcs.createCsvUploadUrl();

联系人服务( 列表)

// Create blocklist entry
await sendon.contacts.createBlocklist({
  phoneNumbers: ['01012345678'],
  blockType: 'SMS',
  senderNumber: '0212345678'
});

// Get blocklist
await sendon.contacts.getBlocklist({
  blockType: ['SMS', 'KAKAO'],
  limit: 100
});

// Delete from blocklist
await sendon.contacts.deleteBlocklist(blocklistId);

支付服务

// Get payment history
await sendon.payment.getPaymentHistories({
  startDate: new Date('2024-01-01'),
  endDate: new Date('2024-12-31'),
  page: 1,
  limit: 20
});

// Get payment detail
await sendon.payment.getPaymentHistoryDetail(historyId);

点服务

// Get message costs
await sendon.point.getCost();

// List available points
await sendon.point.listPoints();

发件人服务

// List registered sender numbers
await sendon.sender.listUserNumbers(page, limit);

• 警卫

• 安全认证: API 密钥认证
• 数据加密: 所有通过 HTTPS 传输的数据
• 限制费率: 内置速率限制处理
• 处理错误: 全面错误管理

绩效

• 最佳击打: 高效的大宗业务
• 连接集合: 可重用 HTTP 连接
• Async/等待支持: 现代同步模式
• 脚本原生类型: 完全类型安全和IntelliSense

发展

这个SDK是用:

• 类型脚本 5.1+ 类型安全
• 阿克索斯语Name hTTP 客户端
• OpenAPI 生成器 aPI 一致性
• 维特 测试

许可证

这个项目根据麻省理工学院的许可证获得许可.

++ 辅助

如需技术支持和查询,请与我们的支助小组联系或访问我们的文件门户.