NumFlow API 完整文档

使用账户级 API Key、余额冻结、幂等下单和统一错误响应,构建自动化短信验证码流程。

认证与访问边界

每个 API 请求都必须携带当前账户生成的 NumFlow API Key。系统会应用该账户的余额、权限、限流和风险控制:X-API-Key + HMAC-SHA256 signature headers

开发者只调用 NumFlow API。每个账户独立拥有 API Key、余额、订单和钱包记录,敏感平台凭证及其他账户数据不会暴露。

计费规则:号码分配后先冻结平台价格,收到第一条短信验证码后才完成扣款;未收到验证码且取消或超时处理成功时释放冻结金额。请求体中提交的金额不会作为扣款依据。

推荐接入流程

1. 先查询余额,确认可用余额足够。

2. 每次业务下单使用唯一的 Idempotency-Key,网络重试时复用同一个值。

3. 每 3–5 秒查询一次短信结果,并以订单返回的 expires_at 作为接收窗口。

4. 收到验证码后订单自动完成并扣款;有效期内可继续查询同一订单。没有验证码时,只在订单状态允许后取消。

错误代码

错误响应使用统一 JSON 结构: { success: false, error: { code, message } }

API_UNAUTHENTICATEDAPI Key 缺失、无效或已撤销。
API_SIGNATURE_REQUIRED请求体或路径参数无效。
API_SIGNATURE_INVALID账户可用余额不足。
API_REPLAY_DETECTED请求过多,请稍后重试。
IDEMPOTENCY_KEY_REQUIRED当前国家、服务或线路没有可用号码。
IDEMPOTENCY_KEY_REUSED国家代码无效。
IDEMPOTENCY_RECOVERY_REQUIRED线路/运营商代码无效。
VALIDATION_ERROR服务代码无效。
INSUFFICIENT_WALLET_BALANCE订单不存在或不属于当前 API Key 账户。
RATE_LIMITED收到短信验证码前不能完成订单。
NO_FREE_PHONES订单已收到验证码或已进入终态,不能取消。
BAD_COUNTRY当前环境尚未配置号码服务。
BAD_OPERATOR号码服务暂时不可用,请稍后重试。
NO_PRODUCT号码下单暂时不可用,持续出现时请联系支持。
ORDER_NOT_FOUND请求未能完成,请刷新订单状态后重试。
SMS_CODE_REQUIRED
ORDER_NOT_CANCELABLE
ORDER_STATE_CONFLICT
ORDER_BILLING_CONFLICT
NUMBER_SERVICE_NOT_CONFIGURED
NUMBER_SERVICE_UNAVAILABLE
NUMBER_SERVICE_TEMPORARILY_UNAVAILABLE
BUSINESS_ERROR

开始使用 NumFlow API

创建账户、兑换充值码增加余额,并在账户中心生成 API Key。每个账户拥有独立计费、限流和订单记录。

打开账户中心