ตรวจสอบยอดคงเหลือ

หากคุณต้องการดูยอดคงเหลือที่ใช้ได้ของบัญชี EngageLab SMS แบบเรียลไทม์ คุณสามารถเรียกใช้อินเทอร์เฟซนี้ได้ อินเทอร์เฟซจะส่งกลับยอดคงเหลือทั่วไป ยอดคงเหลือแบบแถม และยอดคงเหลือรวมของบัญชีคุณ

URL สำหรับเรียกใช้

GET https://smsapi.engagelab.com/v1/balance

การยืนยันตัวตนในการเรียกใช้

โปรดดู การยืนยันตัวตนในการเรียกใช้ เพื่อเรียนรู้วิธียืนยันตัวตน API

ตัวอย่างคำขอ

ส่วนหัวของคำขอ

GET /v1/balance HTTP/1.1 Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

              
              GET /v1/balance  HTTP/1.1
Authorization: Basic amlndWFuZ2RldjpkZXZfc2VjcmV0

โค้ดนี้โชว์เป็นหน้าต่างลอย

เนื้อหาคำขอ

ไม่มี

พารามิเตอร์ของคำขอ

ไม่มี

พารามิเตอร์ที่ส่งกลับ

การตอบกลับเมื่อสำเร็จ

รหัสสถานะ HTTP เป็น 200 เนื้อหาการตอบกลับมีฟิลด์ดังนี้:

ฟิลด์	ประเภท	ตัวเลือก	คำอธิบาย
balance10000	Integer	จำเป็น	ยอดคงเหลือทั่วไป เป็นค่าจำนวนเต็มหลังคูณด้วย 10000
gift_balance10000	Integer	จำเป็น	ยอดคงเหลือแบบแถม เป็นค่าจำนวนเต็มหลังคูณด้วย 10000
balance	Number	จำเป็น	ยอดคงเหลือทั่วไป เป็นทศนิยม
gift_balance	Number	จำเป็น	ยอดคงเหลือแบบแถม เป็นทศนิยม
total_balance10000	Integer	จำเป็น	ยอดคงเหลือรวม เท่ากับผลรวมของยอดคงเหลือทั่วไปและยอดคงเหลือแบบแถม เป็นค่าจำนวนเต็มหลังคูณด้วย 10000
total_balance	Number	จำเป็น	ยอดคงเหลือรวม เท่ากับผลรวมของยอดคงเหลือทั่วไปและยอดคงเหลือแบบแถม เป็นทศนิยม

{ "balance10000": 123456, "gift_balance10000": 20000, "balance": 12.3456, "gift_balance": 2, "total_balance10000": 143456, "total_balance": 14.3456 }

              
              {
    "balance10000": 123456,
    "gift_balance10000": 20000,
    "balance": 12.3456,
    "gift_balance": 2,
    "total_balance10000": 143456,
    "total_balance": 14.3456
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

คำแนะนำสำหรับนักพัฒนา ขอแนะนำให้ผู้เรียกใช้ใช้ฟิลด์ balance10000、gift_balance10000 และ total_balance10000 ในการจัดรูปแบบยอดคงเหลือด้วยตนเองเป็นลำดับแรก เพื่อหลีกเลี่ยงปัญหาความแม่นยำของทศนิยม

การตอบกลับเมื่อล้มเหลว

รหัสสถานะ HTTP เป็น 4xx หรือ 5xx เนื้อหาการตอบกลับมีฟิลด์ดังนี้:

ฟิลด์	ประเภท	ตัวเลือก	คำอธิบาย
code	Integer	จำเป็น	รหัสข้อผิดพลาด ดูรายละเอียดที่คำอธิบายรหัสข้อผิดพลาด
message	String	จำเป็น	รายละเอียดข้อผิดพลาด

{ "code": 2001, "message": "invalid token" }

              
              {
    "code": 2001,
    "message": "invalid token"
}

โค้ดนี้โชว์เป็นหน้าต่างลอย

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

รหัสข้อผิดพลาด	http code	คำอธิบาย
1000	500	ข้อผิดพลาดภายใน โปรดลองใหม่ภายหลัง
2001	401	การยืนยันตัวตนล้มเหลว ไม่ได้แนบ token ที่ถูกต้อง หรือไม่มีร้านค้าที่ตรงกับ token
2002	401	การยืนยันตัวตนล้มเหลว token หมดอายุหรือถูกปิดใช้งานแล้ว
2002	403	ร้านค้าถูกลบแล้ว