核心用法
Yuboto Omni API 技能专为开发与 Yuboto 短信/即时通讯平台集成的开发者设计,覆盖消息发送(SMS/Viber)、送达回执(DLR)查询、联系人/黑名单管理、成本估算及账户余额等全链路 API 操作。
工作流程:
1. 定位端点:通过 references/api_quick_reference.md 或 scripts/find_endpoints.py 快速检索
2. 验证契约:以 references/swagger_v1.json 为最终依据,核对参数、请求体与响应结构
3. 生成代码:包含认证头、重试机制、错误映射及最小可运行示例
4. CLI 辅助:内置 balance、send-sms、dlr、send-csv 等命令加速测试
显著优点:
- 源优先级清晰:明确 Swagger > PDF 的冲突解决策略,避免文档不一致导致的集成错误
- 安全默认:强制环境变量存储 API 密钥(
OCTAPUSH_API_KEY),禁止硬编码 - 生产级代码模板:自动包含重试、超时、错误处理,降低运维风险
- 多语言中立:示例代码默认语言无关,支持希腊语/英语按需切换
潜在局限:
- 依赖用户自行维护
references/下的 Swagger 与文档副本同步 - 高级 Viber 功能需手动核对 Swagger,自动化程度有限
- CLI 工具需 Python 环境,无原生 Node/Go 等语言绑定
- 状态追踪数据(
poll-pending、history)存于本地,分布式部署需额外持久化
适合人群:
- 需集成 Yuboto 消息服务的后端开发者
- 运维团队排查 DLR 异常或成本异常
- 批量发送场景需 CSV 导入的工作流设计者
常规风险:
- API 密钥泄露:务必使用环境变量,避免
--api-key入 shell 历史 - 敏感数据残留:本地日志含手机号、消息预览,发布前需脱敏或外置存储
- 发件人合规:仅使用平台审核通过的 Sender ID,否则消息被拒