ดึงข้อมูลตารางเวลา

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

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

---

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

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

▼

`id`STRING(required)

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

Example:"schd_test_5xuy4w91xqz7d1w9u0t"

---

การตอบกลับ

200

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

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

ออบเจกต์ตารางเวลาประกอบด้วย:

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

401

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

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

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

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

404

ไม่พบ

ไม่พบตารางเวลาหรือไม่มีอยู่

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

• รหัสตารางเวลาไม่ถูกต้อง
• รหัสตารางเวลาจากบัญชีอื่น
• ใช้ key โหมดทดสอบและโหมด live ปนกัน
• ตารางเวลาถูกลบไปแล้ว

5xx

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

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

วิธีจัดการ:

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

---

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

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	ไม่พบตารางเวลา	ตรวจสอบรหัสตารางเวลาและให้แน่ใจว่าใช้โหมดที่ถูกต้อง (test/live)

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

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

---

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

▼

ทดลองใช้งาน

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

▼

id(จำเป็น)

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