แสดงรายการ Schedule ทั้งหมด

GEThttps://api.omise.co/schedules

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

---

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

▼

---

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

ไม่จำเป็น - 3 รายการพารามิเตอร์การแบ่งหน้า

▼

`limit`INTEGER(optional)

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

Example:20

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

Default:20

`offset`INTEGER(optional)

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

Example:0

Default:0

`order`STRING(optional)

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

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

ไม่จำเป็น - 2 รายการพารามิเตอร์การกรอง

▼

---

การตอบกลับ

200

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

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

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

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

ฟิลด์ออบเจ็กต์ Schedule:

• status - active, expired, suspended, deleted, paused
• period - day, week, หรือ month
• every - ตัวคูณความถี่สำหรับช่วงเวลา
• next_occurrences_on - อาร์เรย์ของวันที่ occurrence ที่กำลังจะมาถึงสูงสุด 30 รายการ
• chargeหรือtransfer - พารามิเตอร์การดำเนินการ

400

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

การตรวจสอบคำขอล้มเหลว โปรดตรวจสอบข้อความแสดงข้อผิดพลาดสำหรับรายละเอียด

สาเหตุทั่วไป:

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

401

ไม่ได้รับการยืนยันตัวตน

การยืนยันตัวตนล้มเหลว คีย์ API ไม่ถูกต้องหรือขาดหายไป

สาเหตุทั่วไป:

• ขาดหัวข้อ Authorization
• คีย์ลับไม่ถูกต้อง
• ใช้คีย์สาธารณะแทนคีย์ลับ
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

---

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

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 ไม่ถูกต้อง	ตรวจสอบว่าคีย์ลับของคุณถูกต้อง
bad_request	พารามิเตอร์ไม่ถูกต้อง	ตรวจสอบรูปแบบวันที่และค่าพารามิเตอร์
invalid_date_format	วันที่ไม่ได้อยู่ในรูปแบบ ISO 8601	ใช้รูปแบบ: YYYY-MM-DDTHH:MM:SSZ

ค่าสถานะ Schedule

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

---

ทดลองใช้งาน