ค้นหา Recipient

GEThttps://api.omise.co/recipients/search

ค้นหา Recipient ตามเกณฑ์ต่างๆ รวมถึงชื่อ อีเมล ประเภท รายละเอียดบัญชีธนาคาร และ metadata Search API ให้ความสามารถในการค้นหาข้อความเต็มรูปแบบที่มีประสิทธิภาพสำหรับ Recipient ทั้งหมด

---

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

แนะนำ - 2 ฟิลด์พารามิเตอร์ที่แนะนำ

▼

`query`STRING(optional)

สตริงคำค้นหา ค้นหาในชื่อ Recipient อีเมล คำอธิบาย รายละเอียดบัญชีธนาคาร และ metadata รองรับหลายคำ (AND logic) และการจับคู่บางส่วน

Example:"john doe"

`filters`OBJECT(optional)

เกณฑ์การกรองเพื่อจำกัดผลการค้นหา ตัวกรองทั่วไปรวมถึงประเภท สถานะใช้งาน สถานะการยืนยัน และช่วงวันที่สร้าง

Example:{"type":"individual","verified":true,"active":true}

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

▼

---

การตอบกลับ

200

ค้นหาสำเร็จ

การค้นหาเสร็จสมบูรณ์ ส่งกลับออบเจกต์ผลการค้นหาพร้อม Recipient ที่ตรงกันในอาร์เรย์ data

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

• data - อาร์เรย์ของออบเจกต์ Recipient ที่ตรงกับเกณฑ์การค้นหา
• total - จำนวนผลลัพธ์ทั้งหมดที่ตรงกับการค้นหา
• total_pages - จำนวนหน้าที่พร้อมใช้งาน
• page - หมายเลขหน้าปัจจุบัน
• per_page - จำนวนผลลัพธ์ต่อหน้า
• order - ลำดับการเรียงที่ใช้ (chronological หรือ reverse_chronological)

400

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

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

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

• หมายเลขหน้าไม่ถูกต้อง (ต่ำกว่า 1)
• ค่า per_page ไม่ถูกต้อง (มากกว่า 100 หรือต่ำกว่า 1)
• รูปแบบออบเจกต์ filters ไม่ถูกต้อง
• ชื่อฟิลด์ตัวกรองไม่ถูกต้อง

401

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

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

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

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

404

ไม่พบ

ไม่พบ endpoint การค้นหาหรือไม่พร้อมใช้งาน

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

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

5xx

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

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

วิธีจัดการ:

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

---

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

cURL

curl https://api.omise.co/recipients/search \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -G \
  -d "query=john doe" \
  -d "filters[type]=individual" \
  -d "filters[verified]=true"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = Omise::Recipient.search({
  query: 'john doe',
  filters: {
    type: 'individual',
    verified: true
  }
})

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

results = omise.Recipient.search(
    query='john doe',
    filters={
        'type': 'individual',
        'verified': True
    }
)

Node.js

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

const results = await omise.recipients.search({
  query: 'john doe',
  filters: {
    type: 'individual',
    verified: true
  }
});

PHP

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

$results = OmiseRecipient::search([
    'query' => 'john doe',
    'filters' => [
        'type' => 'individual',
        'verified' => true
    ]
]);

Java

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

Map<String, Object> filters = new HashMap<>();
filters.put("type", "individual");
filters.put("verified", true);

SearchResult<Recipient> results = client.recipients()
    .search()
    .query("john doe")
    .filters(filters)
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var results = await client.Recipients.Search(new SearchRequest
{
    Query = "john doe",
    Filters = new Dictionary<string, object>
    {
        { "type", "individual" },
        { "verified", true }
    }
});

Go

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

results, _ := client.Recipients().Search(&operations.SearchRecipients{
    Query: "john doe",
    Filters: map[string]interface{}{
        "type":     "individual",
        "verified": true,
    },
})

---

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

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

รหัส	คำอธิบาย	การแก้ไข
bad_request	พารามิเตอร์หายไปหรือไม่ถูกต้อง	ตรวจสอบว่าพารามิเตอร์ถูกต้อง
authentication_failure	API key ไม่ถูกต้อง	ตรวจสอบว่า secret key ถูกต้อง

ตัวเลือกตัวกรองการค้นหา

ตัวกรอง	ประเภท	คำอธิบาย
type	string	ประเภท Recipient (individual, corporation)
verified	boolean	Recipient ได้รับการยืนยันหรือไม่ (true/false)
active	boolean	Recipient เปิดใช้งานอยู่หรือไม่ (true/false)
bank_account_brand	string	รหัสธนาคาร (bbl, kbank, scb เป็นต้น)
created	object	ตัวกรองช่วงวันที่ (เช่น {gte: '2025-01-01', lte: '2025-01-31'})

---

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

▼

ลองใช้งาน

แนะนำ - 2 ฟิลด์

▼

เพิ่มเติม - 3 ฟิลด์

▼

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