ดึงข้อมูล Schedule

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

ดึงรายละเอียดของ Schedule เฉพาะ รวมถึงสถานะ ความถี่ วันที่ดำเนินการครั้งต่อไป และประวัติ occurrence ใช้ endpoint นี้เพื่อตรวจสอบสถานะการสมัครสมาชิก ดูประวัติการชำระเงิน และติดตามการเรียกเก็บเงินที่กำลังจะมาถึง

---

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

▼

---

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

จำเป็น - 1 รายการพารามิเตอร์พาธ

▼

`id`STRING(required)

Schedule ID ที่ต้องการดึงข้อมูล Schedule ID เริ่มต้นด้วย schd_ และตามด้วย test_ สำหรับโหมดทดสอบ

Example:"schd_test_5xuy4w91xqz7d1w9u0t"

---

การตอบกลับ

200

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

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

ออบเจ็กต์ Schedule ประกอบด้วย:

• id - ตัวระบุ Schedule (schd_*)
• status - active, expired, suspended, deleted หรือ paused
• every - ตัวคูณความถี่ (1, 2, 3 ฯลฯ)
• period - หน่วยเวลา (day, week, month)
• on - การตั้งค่าเวลาเฉพาะ (days_of_month, weekday_of_month)
• next_occurrences_on - อาร์เรย์ของวันที่ดำเนินการในอนาคต
• charge หรือ transfer - พารามิเตอร์การดำเนินการ
• start_date และ end_date - ระยะเวลาของ Schedule

401

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

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

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

• ขาดหัวข้อ Authorization
• secret key ไม่ถูกต้อง
• ใช้ public key แทน secret key
• รูปแบบ HTTP Basic Auth ไม่ถูกต้อง

404

ไม่พบ

ไม่พบ Schedule หรือไม่มีอยู่

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

• Schedule ID ไม่ถูกต้อง
• Schedule ID จากบัญชีอื่น
• ใช้คีย์โหมดทดสอบและโหมดจริงปะปนกัน
• Schedule ถูกลบไปแล้ว

---

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

cURL

curl https://api.omise.co/schedules/schd_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedule = Omise::Schedule.retrieve('schd_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedule = omise.Schedule.retrieve('schd_test_5xuy4w91xqz7d1w9u0t')

Node.js

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

const schedule = await omise.schedules.retrieve('schd_test_5xuy4w91xqz7d1w9u0t');

PHP

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

$schedule = OmiseSchedule::retrieve('schd_test_5xuy4w91xqz7d1w9u0t');

Java

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

Schedule schedule = client.schedules().get("schd_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var schedule = await client.Schedules.Get("schd_test_5xuy4w91xqz7d1w9u0t");

Go

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

schedule, _ := client.GetSchedule("schd_test_5xuy4w91xqz7d1w9u0t")

---

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

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

รหัส	คำอธิบาย	วิธีแก้ไข
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ของคุณถูกต้อง
not_found	ไม่พบ Schedule	ตรวจสอบ Schedule ID และตรวจสอบว่าอยู่ในโหมดที่ถูกต้อง (ทดสอบ/จริง)

ค่าสถานะของ Schedule

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

---

ลองใช้งาน

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

▼

id(จำเป็น)