面向开发者和批量业务系统。每个开发者账户使用自己的余额和 API Key 调用接码能力。
所有 API 请求需在 Header 中携带当前注册用户生成的 NumFlow API Key。API 会使用该用户自己的账户余额,并按该用户的权限、限流和风控规则执行:Authorization: Bearer nf_live_xxx
开发者只需要调用 NumFlow 平台 API。每个账户拥有自己的 API Key、余额、订单和流水;不会接触平台敏感凭证或其他账户数据。
计费规则:获取号码后先冻结平台售价,收到验证码后才正式扣款;未收到验证码时取消或超时处理成功,冻结金额会退回可用余额。请求体里的金额会被忽略。
推荐调用流程
1. 查询余额,确认账户可用余额充足。
2. 调用获取号码接口,并为每次业务请求传入唯一 Idempotency-Key。
3. 每 3-5 秒查询一次短信结果,接收窗口以获取号码接口返回的 expires_at 为准。
4. 查询到验证码后订单自动完成并扣款;有效期内可继续查询同一订单获取后续验证码,长时间未收到验证码时调用 cancel 释放冻结金额。
所有错误响应均为统一 JSON:{ success: false, error: { code, message } }
API_UNAUTHENTICATEDAPI Key 无效、缺失或已撤销。VALIDATION_ERROR请求参数格式不正确。INSUFFICIENT_WALLET_BALANCE账户余额不足,需先充值。RATE_LIMITED请求过于频繁,请稍后重试。NO_FREE_PHONES当前国家、服务或线路暂时无可用号码。BAD_COUNTRY国家代码无效。BAD_OPERATOR线路代码无效。NO_PRODUCT服务代码无效。ORDER_NOT_FOUND订单不存在,或不属于当前 API Key 所属账户。SMS_CODE_REQUIRED未收到验证码前不能完成订单。ORDER_NOT_CANCELABLE订单已收到验证码或已完成,不能取消。NUMBER_SERVICE_NOT_CONFIGURED号码服务尚未配置。NUMBER_SERVICE_UNAVAILABLE号码服务暂不可用,请稍后重试。PROVIDER_BALANCE_LOW号码服务暂不可用,请联系管理员。BUSINESS_ERROR请求无法完成,请刷新订单状态后重试。