← เอกสารอ้างอิง API
ผู้ให้บริการGET

รายชื่อภูมิภาคของผู้ให้บริการ

คืนภูมิภาคที่ผู้ให้บริการได้ rollout ไปแล้ว supported บอกว่าผู้ให้บริการให้บริการในภูมิภาคนั้นหรือไม่ ส่วน allocatable บอกว่าปัจจุบันสามารถผูกบัญชีใหม่ในภูมิภาคนั้นได้หรือไม่

https://api.unifyport.ai/v1/providers/{provider}/regions

ส่วนหัว

X-Api-Key
stringจำเป็น

API key ของพื้นที่ทำงาน ระบบจะระบุพื้นที่ทำงานจากส่วนหัวนี้

พารามิเตอร์ใน path

provider
stringจำเป็น

ตัวระบุที่ใช้ใน route ของ providers

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp_protocol, x, x_client, twitter_client

เนื้อหาของคำขอ

จุดเชื่อมต่อนี้ไม่ต้องใช้เนื้อหา JSON

เนื้อหาการตอบกลับ

provider
string

provider ที่กำลังคืนข้อมูลความพร้อมใช้งานรายภูมิภาค

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp_protocol

regions[]
object[]

รายการภูมิภาค แต่ละรายการมีค่า supported และ allocatable

region
string

ตัวระบุภูมิภาคที่ติดตั้ง provider

supported
boolean

provider ทำงานในภูมิภาคนี้หรือไม่

allocatable
boolean

ขณะนี้สามารถจัดสรรบัญชีใหม่ในภูมิภาคนี้ได้หรือไม่

การตอบกลับ

200
200 OK

คำขอสำเร็จ ดูตัวอย่างเนื้อหาตอบกลับด้านบน

400
Bad Request

เนื้อหาของคำขอ path หรือพารามิเตอร์ไม่ถูกต้อง

401
Unauthorized

ส่วนหัว X-Api-Key หายไปหรือไม่ถูกต้อง

500
Internal Server Error

บริการพบข้อผิดพลาดที่ไม่คาดคิด

คำขอ

curl -X GET https://api.unifyport.ai/v1/providers/{provider}/regions \
  -H "X-Api-Key: <YOUR_API_KEY>"

การตอบกลับ

{
  "data": {
    "provider": "telegram",
    "regions": [
      {
        "region": "global",
        "supported": true,
        "allocatable": true
      }
    ]
  }
}