หยุดกำหนดการชั่วคราวแบบกลุ่ม

PATCHhttps://api.omise.co/schedules/bulk_pause

หยุดกำหนดการเรียกเก็บเงินที่ใช้งานอยู่หนึ่งรายการหรือหลายรายการชั่วคราวในคำขอเดียว กำหนดการที่หยุดชั่วคราวจะไม่ทำงานจนกว่าจะเปิดใช้งานต่อ ฟังก์ชันนี้มีประโยชน์สำหรับการหยุดการเรียกเก็บเงินแบบเป็นงวดชั่วคราวในระหว่างการโต้แย้งของลูกค้า การระงับบัญชี หรือการหยุดตามฤดูกาล

---

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

▼

---

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

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

▼

`schedule_ids`ARRAY(required)

อาร์เรย์ของ Schedule IDs ที่จะหยุดชั่วคราว แต่ละ ID ต้องเริ่มต้นด้วย schd_ สูงสุด 100 IDs ต่อคำขอ

Example:"[\"schd_test_5xuy4w91xqz7d1w9u0t\", \"schd_test_5xuy4w91xqz7d1w9u0s\"]"

Constraints:สูงสุด 100 IDs ต่อคำขอ, กำหนดการทั้งหมดต้องอยู่ในสถานะ "active"

---

การตอบกลับ

200

หยุดกำหนดการชั่วคราวสำเร็จ

ส่งคืนสรุปการดำเนินการหยุดชั่วคราวแบบกลุ่มพร้อมรายละเอียดของแต่ละกำหนดการ

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

• object - เป็น "bulk_operation" เสมอ
• operation - "pause"
• total_count - จำนวน Schedule IDs ทั้งหมดที่ระบุ
• successful_count - จำนวนกำหนดการที่หยุดชั่วคราวสำเร็จ
• failed_count - จำนวนกำหนดการที่หยุดชั่วคราวล้มเหลว
• results - อาร์เรย์ของออบเจกต์ผลลัพธ์สำหรับแต่ละกำหนดการ

ออบเจกต์ผลลัพธ์แต่ละรายการประกอบด้วย:

• schedule_id - Schedule ID
• status - "success" หรือ "failed"
• schedule - ออบเจกต์กำหนดการที่อัปเดต (หากสำเร็จ)
• error_code - รหัสข้อผิดพลาด (หากล้มเหลว)
• error_message - คำอธิบายข้อผิดพลาด (หากล้มเหลว)

400

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

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

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

• พารามิเตอร์ schedule_ids หายไป
• schedule_ids ไม่ใช่อาร์เรย์
• อาร์เรย์ schedule_ids ว่างเปล่า
• ระบุ Schedule IDs มากกว่า 100 รายการ
• รูปแบบ Schedule ID ไม่ถูกต้อง

401

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

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

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

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

404

ไม่พบ

ไม่พบ endpoint หรือฟีเจอร์ไม่ได้เปิดใช้งาน

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

• ฟีเจอร์การดำเนินการแบบกลุ่มไม่ได้เปิดใช้งานสำหรับบัญชี
• URL ของ API endpoint ไม่ถูกต้อง

5xx

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

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

วิธีจัดการ:

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

---

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

cURL

# หยุดกำหนดการหลายรายการชั่วคราว
curl https://api.omise.co/schedules/bulk_pause \
  -X PATCH \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -H "Content-Type: application/json" \
  -d '{
    "schedule_ids": [
      "schd_test_5xuy4w91xqz7d1w9u0t",
      "schd_test_5xuy4w91xqz7d1w9u0s",
      "schd_test_5xuy4w91xqz7d1w9u0r"
    ]
  }'

Ruby

require 'omise'
require 'net/http'
require 'uri'
require 'json'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedule_ids = [
  'schd_test_5xuy4w91xqz7d1w9u0t',
  'schd_test_5xuy4w91xqz7d1w9u0s',
  'schd_test_5xuy4w91xqz7d1w9u0r'
]

uri = URI('https://api.omise.co/schedules/bulk_pause')
request = Net::HTTP::Patch.new(uri)
request.basic_auth(Omise.api_key, '')
request['Content-Type'] = 'application/json'
request.body = { schedule_ids: schedule_ids }.to_json

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

result = JSON.parse(response.body)
puts "Paused: #{result['successful_count']} / #{result['total_count']}"

Python

import omise
import requests

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

schedule_ids = [
    'schd_test_5xuy4w91xqz7d1w9u0t',
    'schd_test_5xuy4w91xqz7d1w9u0s',
    'schd_test_5xuy4w91xqz7d1w9u0r'
]

response = requests.patch(
    'https://api.omise.co/schedules/bulk_pause',
    auth=(omise.api_secret, ''),
    json={'schedule_ids': schedule_ids}
)

result = response.json()
print(f"Paused: {result['successful_count']} / {result['total_count']}")

# ตรวจสอบความล้มเหลว
for item in result['results']:
    if item['status'] == 'failed':
        print(f"Failed: {item['schedule_id']} - {item['error_message']}")

Node.js

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

const scheduleIds = [
  'schd_test_5xuy4w91xqz7d1w9u0t',
  'schd_test_5xuy4w91xqz7d1w9u0s',
  'schd_test_5xuy4w91xqz7d1w9u0r'
];

const response = await axios.patch(
  'https://api.omise.co/schedules/bulk_pause',
  { schedule_ids: scheduleIds },
  {
    auth: {
      username: 'skey_test_5xuy4w91xqz7d1w9u0t',
      password: ''
    }
  }
);

console.log(`Paused: ${response.data.successful_count} / ${response.data.total_count}`);

// ตรวจสอบความล้มเหลว
response.data.results.forEach(item => {
  if (item.status === 'failed') {
    console.log(`Failed: ${item.schedule_id} - ${item.error_message}`);
  }
});

PHP

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

$schedule_ids = [
    'schd_test_5xuy4w91xqz7d1w9u0t',
    'schd_test_5xuy4w91xqz7d1w9u0s',
    'schd_test_5xuy4w91xqz7d1w9u0r'
];

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.omise.co/schedules/bulk_pause',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    CURLOPT_USERPWD => OMISE_SECRET_KEY . ':',
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['schedule_ids' => $schedule_ids])
]);

$response = curl_exec($curl);
curl_close($curl);

$result = json_decode($response, true);
echo "Paused: {$result['successful_count']} / {$result['total_count']}\n";

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.util.Base64;

HttpClient client = HttpClient.newHttpClient();

String auth = Base64.getEncoder().encodeToString("skey_test_5xuy4w91xqz7d1w9u0t:".getBytes());

String jsonBody = """
    {
        "schedule_ids": [
            "schd_test_5xuy4w91xqz7d1w9u0t",
            "schd_test_5xuy4w91xqz7d1w9u0s",
            "schd_test_5xuy4w91xqz7d1w9u0r"
        ]
    }
    """;

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.omise.co/schedules/bulk_pause"))
    .header("Authorization", "Basic " + auth)
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString(jsonBody))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C#

using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Text.Json;

var client = new HttpClient();

var credentials = Convert.ToBase64String(
    Encoding.ASCII.GetBytes("skey_test_5xuy4w91xqz7d1w9u0t:")
);
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Basic", credentials);

var scheduleIds = new[] {
    "schd_test_5xuy4w91xqz7d1w9u0t",
    "schd_test_5xuy4w91xqz7d1w9u0s",
    "schd_test_5xuy4w91xqz7d1w9u0r"
};

var content = new StringContent(
    JsonSerializer.Serialize(new { schedule_ids = scheduleIds }),
    Encoding.UTF8,
    "application/json"
);

var request = new HttpRequestMessage(new HttpMethod("PATCH"),
    "https://api.omise.co/schedules/bulk_pause")
{
    Content = content
};

var response = await client.SendAsync(request);
var result = await response.Content.ReadAsStringAsync();

Console.WriteLine(result);

Go

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "net/http"
)

func main() {
    scheduleIds := []string{
        "schd_test_5xuy4w91xqz7d1w9u0t",
        "schd_test_5xuy4w91xqz7d1w9u0s",
        "schd_test_5xuy4w91xqz7d1w9u0r",
    }

    body, _ := json.Marshal(map[string][]string{
        "schedule_ids": scheduleIds,
    })

    req, _ := http.NewRequest("PATCH",
        "https://api.omise.co/schedules/bulk_pause",
        bytes.NewBuffer(body))
    req.SetBasicAuth("skey_test_5xuy4w91xqz7d1w9u0t", "")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, _ := client.Do(req)
    defer resp.Body.Close()

    var result map[string]interface{}
    json.NewDecoder(resp.Body).Decode(&result)

    fmt.Printf("Paused: %.0f / %.0f\n",
        result["successful_count"], result["total_count"])
}

---

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

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

รหัส	คำอธิบาย	การแก้ไข
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ของคุณถูกต้อง
invalid_schedule_ids	schedule_ids ไม่ถูกต้องหรือหายไป	ระบุอาร์เรย์ที่ถูกต้องของ Schedule IDs
too_many_ids	ระบุมากกว่า 100 IDs	แบ่งเป็นหลายคำขอ

รหัสข้อผิดพลาดต่อกำหนดการ

รหัส	คำอธิบาย	การแก้ไข
schedule_not_found	ไม่มี Schedule ID	ตรวจสอบว่า Schedule ID ถูกต้อง
schedule_not_active	กำหนดการไม่อยู่ในสถานะ active	เฉพาะกำหนดการที่ active เท่านั้นที่หยุดชั่วคราวได้
schedule_already_paused	กำหนดการหยุดชั่วคราวอยู่แล้ว	ไม่ต้องดำเนินการ
schedule_deleted	กำหนดการถูกลบแล้ว	ไม่สามารถหยุดกำหนดการที่ถูกลบชั่วคราวได้

สถานะกำหนดการหลังหยุดชั่วคราว

ฟิลด์	ค่า
status	suspended
active	false

---

ลองใช้งาน

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

▼

schedule_ids(จำเป็น)

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