แสดงรายการตารางเวลา Recipient

GEThttps://api.omise.co/recipients/:id/schedules

แสดงรายการตารางเวลาทั้งหมดที่เกี่ยวข้องกับ Recipient เฉพาะ ใช้ endpoint นี้เพื่อดูการโอนเงินแบบซ้ำและตารางการชำระเงินอัตโนมัติที่กำหนดค่าสำหรับ Recipient

---

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

จำเป็น - 1 ฟิลด์พารามิเตอร์ที่จำเป็น

▼

`id`STRING(required)

Recipient ID (เช่น recp_test_...) ระบุใน URL path

Example:"recp_test_5xuy4w91xqz7d1w9u0t"

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

▼

`limit`INTEGER(optional)

จำนวนตารางเวลาที่จะส่งกลับต่อหน้า

Example:20

Constraints:ต่ำสุด: 1, สูงสุด: 100

Default:20

`offset`INTEGER(optional)

จำนวนตารางเวลาที่จะข้ามสำหรับการแบ่งหน้า

Example:0

Default:0

`order`STRING(optional)

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

Example:"chronological"

Values:chronological, reverse_chronological

Default:"chronological"

`from`STRING(optional)

วันที่/เวลา UTC ที่เร็วที่สุดในรูปแบบ ISO 8601 ส่งกลับตารางเวลาที่สร้างตั้งแต่วันที่นี้

Example:"2025-01-01T00:00:00Z"

`to`STRING(optional)

วันที่/เวลา UTC ที่ล่าสุดในรูปแบบ ISO 8601 ส่งกลับตารางเวลาที่สร้างก่อนวันที่นี้

Example:"2025-12-31T23:59:59Z"

---

การตอบกลับ

200

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

ส่งกลับรายการออบเจกต์ตารางเวลาแบบแบ่งหน้าที่เกี่ยวข้องกับ Recipient แต่ละตารางเวลามีความถี่ สถานะ และรายละเอียดการโอนเงิน

การตอบกลับรวมถึง:

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

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

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

400

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

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

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

• รูปแบบวันที่ไม่ถูกต้องสำหรับ from หรือ to
• ค่า order ไม่ถูกต้อง
• offset หรือ limit เป็นลบ
• limit เกินค่าสูงสุด (100)

401

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

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

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

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

404

ไม่พบ

ไม่พบ Recipient

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

• Recipient ID ไม่ถูกต้อง
• Recipient ไม่ได้อยู่ในบัญชีของคุณ
• Recipient ถูกลบแล้ว
• ใช้ ID โหมดทดสอบและโหมดไลฟ์ปนกัน

5xx

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

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

วิธีจัดการ:

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

---

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

cURL

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

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = Omise::Recipient.retrieve('recp_test_5xuy4w91xqz7d1w9u0t')
schedules = recipient.schedules(limit: 20, offset: 0)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

recipient = omise.Recipient.retrieve('recp_test_5xuy4w91xqz7d1w9u0t')
schedules = recipient.schedules(limit=20, offset=0)

Node.js

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

const schedules = await omise.recipients.listSchedules(
  'recp_test_5xuy4w91xqz7d1w9u0t',
  { limit: 20, offset: 0 }
);

PHP

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

$recipient = OmiseRecipient::retrieve('recp_test_5xuy4w91xqz7d1w9u0t');
$schedules = $recipient->schedules([
    'limit' => 20,
    'offset' => 0
]);

Java

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

ScopedList<Schedule> schedules = client.recipients()
    .get("recp_test_5xuy4w91xqz7d1w9u0t")
    .schedules()
    .list(new ScopedList.Options()
        .limit(20)
        .offset(0));

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var schedules = await client.Recipients.ListSchedules(
    "recp_test_5xuy4w91xqz7d1w9u0t",
    new ListOptions
    {
        Limit = 20,
        Offset = 0
    }
);

Go

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

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

---

การแบ่งหน้า

ใช้พารามิเตอร์ limit และ offset เพื่อแบ่งหน้าผลลัพธ์:

# หน้าแรก (0-19)
curl https://api.omise.co/recipients/recp_test_5xuy4w91xqz7d1w9u0t/schedules?limit=20&offset=0 \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

# หน้าที่สอง (20-39)
curl https://api.omise.co/recipients/recp_test_5xuy4w91xqz7d1w9u0t/schedules?limit=20&offset=20 \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

---

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

รหัสข้อผิดพลาดทั่วไป

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

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

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

---

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

▼

ลองใช้งาน

จำเป็น - 1 ฟิลด์

▼

id(จำเป็น)

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