รายการตารางเวลาทั้งหมด

GEThttps://api.omise.co/schedules

แสดงรายการตารางเวลาทั้งหมดในบัญชีของคุณ ตารางเวลาช่วยให้การเรียกเก็บเงินแบบเป็นงวดๆ การโอนเงิน และการดำเนินการอัตโนมัติเป็นไปได้ ใช้ endpoint นี้เพื่อดูการสมัครสมาชิกที่ใช้งานอยู่ ติดตามการดำเนินการตามตารางเวลา และติดตามสถานะการชำระเงินแบบเป็นงวดๆ

---

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

ไม่บังคับ - 3 ฟิลด์พารามิเตอร์การแบ่งหน้า

▼

`limit`INTEGER(optional)

จำนวนตารางเวลาที่จะส่งคืนต่อหน้า

Example:20

Constraints:ค่าต่ำสุด: 1, ค่าสูงสุด: 100, ค่าเริ่มต้น: 20

Default:20

`offset`INTEGER(optional)

จำนวนตารางเวลาที่จะข้ามสำหรับการแบ่งหน้า ใช้ร่วมกับ limit เพื่อแบ่งหน้าผ่านชุดผลลัพธ์ขนาดใหญ่

Example:0

Default:0

`order`STRING(optional)

ลำดับการเรียงของผลลัพธ์

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

ไม่บังคับ - 2 ฟิลด์พารามิเตอร์การกรอง

▼

---

การตอบกลับ

200

ดึงข้อมูลสำเร็จ

ส่งคืนรายการออบเจกต์ตารางเวลาแบบแบ่งหน้า แต่ละตารางเวลาประกอบด้วยความถี่ สถานะ และรายละเอียดการดำเนินการ

การตอบกลับประกอบด้วย:

• data - อาร์เรย์ของออบเจกต์ตารางเวลา
• limit - จำนวนผลลัพธ์ต่อหน้า
• offset - จำนวนผลลัพธ์ที่ข้าม
• total - จำนวนตารางเวลาทั้งหมด
• order - ลำดับการเรียงที่ใช้

ฟิลด์ออบเจกต์ตารางเวลา:

• id - รหัสตารางเวลา (schd_*)
• livemode - โหมด Live หรือ test
• location - เส้นทาง API ไปยังออบเจกต์
• status - active, expiring, expired, deleted, paused, suspended
• active - ตารางเวลากำลังทำงานอยู่หรือไม่
• period - day, week หรือ month
• every - ตัวคูณความถี่สำหรับ period
• on - การตั้งค่าระยะเวลา
• in_words - คำอธิบายที่อ่านง่าย
• start_on - วันที่เริ่มต้นตารางเวลา
• end_on - วันที่สิ้นสุดตารางเวลา
• next_occurrences_on - อาร์เรย์ของวันที่ occurrence ที่จะมาถึงสูงสุด 30 รายการ
• occurrences - รายการออบเจกต์ occurrence
• charge หรือ transfer - พารามิเตอร์การดำเนินการ
• created_at - เวลาที่สร้างตารางเวลา (ISO 8601)

400

คำขอไม่ถูกต้อง

การตรวจสอบคำขอล้มเหลว ตรวจสอบข้อความข้อผิดพลาดเพื่อดูรายละเอียด

สาเหตุที่พบบ่อย:

• รูปแบบวันที่ไม่ถูกต้อง (ต้องเป็น ISO 8601)
• Limit เกินค่าสูงสุด (100)
• พารามิเตอร์ order ไม่ถูกต้อง

401

ไม่ได้รับอนุญาต

การยืนยันตัวตนล้มเหลว API key ไม่ถูกต้องหรือไม่มี

สาเหตุที่พบบ่อย:

• ไม่มี Authorization header
• Secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

5xx

ข้อผิดพลาดของเซิร์ฟเวอร์

เกิดข้อผิดพลาดฝั่งเซิร์ฟเวอร์ ข้อผิดพลาดเหล่านี้พบได้น้อยแต่ควรจัดการอย่างเหมาะสม

วิธีจัดการ:

• ส่งคำขอใหม่ด้วย exponential backoff
• ตรวจสอบ status.omise.co สำหรับเหตุการณ์ที่เกี่ยวกับบริการ
• ดู การจัดการข้อผิดพลาด สำหรับคำแนะนำโดยละเอียด

---

ตัวอย่างโค้ด

cURL

curl https://api.omise.co/schedules \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d limit=20 \
  -d offset=0

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedules = Omise::Schedule.list({
  limit: 20,
  offset: 0
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedules = omise.Schedule.list(
    limit=20,
    offset=0
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const schedules = await omise.schedules.list({
  limit: 20,
  offset: 0
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$schedules = OmiseSchedule::retrieve(array(
    'limit' => 20,
    'offset' => 0
));

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

ScopedList<Schedule> schedules = client.schedules().list()
    .limit(20)
    .offset(0)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var schedules = await client.Schedules.GetList(new ListRequest
{
    Limit = 20,
    Offset = 0
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

schedules, _ := client.ListSchedules(&operations.ListSchedules{
    List: operations.List{
        Limit:  20,
        Offset: 0,
    },
})

---

รหัสข้อผิดพลาดและผลลัพธ์

รหัสข้อผิดพลาดที่พบบ่อย

รหัส	คำอธิบาย	วิธีแก้ไข
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ของคุณถูกต้อง
bad_request	พารามิเตอร์ไม่ถูกต้อง	ตรวจสอบรูปแบบวันที่และค่าพารามิเตอร์
invalid_date_format	วันที่ไม่อยู่ในรูปแบบ ISO 8601	ใช้รูปแบบ: YYYY-MM-DDTHH:MM:SSZ

ค่าสถานะตารางเวลา

สถานะ	คำอธิบาย
active	ตารางเวลาทำงานปกติ
expired	ตารางเวลาผ่านวันที่สิ้นสุดแล้ว
suspended	ตารางเวลาถูกหยุดชั่วคราว (ล้มเหลว บัตรหมดอายุ)
deleted	ตารางเวลาถูกยกเลิก
paused	ตารางเวลาถูกหยุดชั่วคราวด้วยตนเอง

---

🔑ข้อมูลยืนยันตัวตน API

▼

ทดลองใช้งาน

IP ของคุณ: ...กำลังโหลด...