NumFlow API เอกสารฉบับเต็ม

สร้างขั้นตอนยืนยัน SMS อัตโนมัติด้วย API key ระดับบัญชี การกันยอด คำสั่งซื้อแบบ idempotent และรูปแบบ error ที่ชัดเจน

การยืนยันและขอบเขตการเข้าถึง

ทุกคำขอ API ต้องมี NumFlow API key ที่สร้างจากบัญชีปัจจุบัน ระบบจะใช้ยอดคงเหลือ สิทธิ์ rate limit และการควบคุมความเสี่ยงของบัญชีนั้น:X-API-Key + HMAC-SHA256 signature headers

นักพัฒนาเรียกใช้เฉพาะ NumFlow API เท่านั้น API key ยอดคงเหลือ คำสั่งซื้อ และประวัติกระเป๋าแยกตามบัญชี โดยไม่เปิดเผยข้อมูลสำคัญหรือข้อมูลของบัญชีอื่น

รูปแบบการคิดเงิน: หลังจัดสรรหมายเลข ระบบจะกันยอดตามราคาที่แสดงและตัดยอดเมื่อได้รับรหัส SMS แรก หากไม่มีรหัสและการยกเลิกหรือหมดเวลาสำเร็จ ระบบจะปล่อยยอดที่กันไว้ จำนวนเงินใน request body ไม่ถูกใช้เป็นยอดตัดเงินจริง

ขั้นตอนที่แนะนำ

1. ตรวจยอดและยืนยันว่ายอดคงเหลือที่ใช้ได้เพียงพอ

2. ใช้ Idempotency-Key ที่ไม่ซ้ำสำหรับแต่ละคำสั่งซื้อ และใช้ค่าเดิมเมื่อ retry จากปัญหาเครือข่าย

3. ตรวจผล SMS ทุก 3–5 วินาที และใช้ expires_at จากคำสั่งซื้อเป็นช่วงเวลารับรหัส

4. เมื่อได้รหัส คำสั่งซื้อจะสำเร็จและตัดยอดอัตโนมัติ ภายในช่วงเวลาที่มีผลให้ตรวจคำสั่งซื้อเดิม และยกเลิกเฉพาะเมื่อสถานะอนุญาต

รหัสข้อผิดพลาด

Error response ใช้รูปแบบ JSON เดียวกัน: { success: false, error: { code, message } }

API_UNAUTHENTICATEDไม่มี API key, key ไม่ถูกต้อง หรือถูกยกเลิก
API_SIGNATURE_REQUIREDข้อมูล request หรือ path parameter ไม่ถูกต้อง
API_SIGNATURE_INVALIDยอดคงเหลือที่ใช้ได้ไม่เพียงพอ
API_REPLAY_DETECTEDมีคำขอมากเกินไป โปรดลองใหม่ภายหลัง
IDEMPOTENCY_KEY_REQUIREDไม่มีหมายเลขพร้อมใช้สำหรับประเทศ บริการ หรือสายที่เลือก
IDEMPOTENCY_KEY_REUSEDรหัสประเทศไม่ถูกต้อง
IDEMPOTENCY_RECOVERY_REQUIREDรหัสสายหรือเครือข่ายไม่ถูกต้อง
VALIDATION_ERRORรหัสบริการไม่ถูกต้อง
INSUFFICIENT_WALLET_BALANCEไม่พบคำสั่งซื้อหรือไม่ได้เป็นของบัญชี API key นี้
RATE_LIMITEDยังไม่สามารถปิดคำสั่งซื้อก่อนรับรหัส SMS
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

สร้างบัญชี เติมยอดด้วย recharge code และสร้าง API key จากศูนย์บัญชี แต่ละบัญชีมีการคิดเงิน rate limit และประวัติคำสั่งซื้อแยกกัน

เปิดศูนย์บัญชี