Groups

Get group

Returns one group in real time. Pass group_id as a query parameter (it can contain @ / : so it is not placed in the path). Returns 404 when the group cannot be found.

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/groups/info

ก่อนเรียกใช้

ใช้ X-Api-Key ของ workspace เจ้าของทรัพยากรบนเซิร์ฟเวอร์ แทนค่าตัวอย่างทั้งหมดก่อนเรียกใช้

ที่มาของพารามิเตอร์

account_id: รับ data.id จากการสร้างหรือค้นหาบัญชี รหัสเป็นของ workspace ที่ระบุด้วย X-Api-Key ดูบัญชี
group_id: กลุ่มที่ต้องการดำเนินการ — id ที่คืนจาก List groups เก็บไว้ใน query string เพราะ id ของผู้ให้บริการอาจมี @ หรือ :

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

ส่วนหัว

X-Api-Key

stringจำเป็น

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

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

account_id

stringจำเป็น

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

พารามิเตอร์ Query

group_id

stringจำเป็น

กลุ่มที่ต้องการดำเนินการ — id ที่คืนจาก List groups เก็บไว้ใน query string เพราะ id ของผู้ให้บริการอาจมี @ หรือ :

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

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

ทำความเข้าใจผลลัพธ์

อ่านฟิลด์ตอบกลับและสถานะ HTTP ตามเอกสาร 204 สำเร็จไม่มีเนื้อหา ใช้ X-Request-Id เพื่อตรวจสอบ ขั้นตอนต่อไปอยู่ในการทำงานที่เกี่ยวข้อง

การตอบกลับ 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "id": "group_example",
    "conversation_id": "group_example",
    "name": "Project team",
    "avatar_url": "",
    "member_count": 5,
    "description": "..."
  }
}

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

id

string

ตัวระบุกลุ่ม สำหรับกลุ่ม ค่า conversation_id จะเท่ากับ id นี้

conversation_id

string

ตัวระบุบทสนทนาของกลุ่ม เท่ากับ id

name

string

ชื่อกลุ่ม

avatar_url

string

URL รูปประจำกลุ่ม หรือสตริงว่างเมื่อไม่มีการตั้งค่า

member_count

integer

จำนวนสมาชิกในกลุ่ม

format: int64

joined_at

string

เวลาที่บัญชีที่เชื่อมต่อเข้าร่วมกลุ่ม เมื่อมีค่า

format: date-time

created_at

string

เวลาสร้างกลุ่มที่ provider รายงาน เมื่อมีค่า

format: date-time

description

string

คำอธิบายกลุ่ม เมื่อมีค่า

permissions

object

Group-wide speaking permissions, returned only when explicitly supplied by the source. Missing means unknown; admins_only=false permits ordinary members to speak, but does not guarantee this account can send.

admins_only

boolean

true means only administrators may speak; false is an explicit state, not an omitted or default value.

extra

object

ฟิลด์กลุ่มเพิ่มเติมเฉพาะ provider ข้อมูลกลุ่ม WhatsApp อาจมีการจัดประเภทกลุ่มประกาศ โดยขึ้นอยู่กับข้อมูลที่พร้อมใช้งานในการค้นหาครั้งนี้

is_announcement_group

boolean

มีเฉพาะกลุ่ม WhatsApp ค่า true หมายถึงยืนยันว่าเป็นกลุ่มประกาศของชุมชน ส่วน false หมายถึงข้อมูลครั้งนี้ยืนยันว่าไม่ตรงตามเงื่อนไขของกลุ่มประกาศ หากไม่มีฟิลด์นี้หมายถึงไม่ทราบ และจะไม่คืน null การจัดประเภทนี้ไม่ได้ระบุว่าบัญชีปัจจุบันมีสิทธิ์ส่งข้อความ เป็นอิสระจาก permissions.admins_only

การตอบกลับ

200

200 OK

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

400

Bad Request

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

401

Unauthorized

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

404

Not Found

ไม่พบทรัพยากรของ provider ที่ร้องขอ

409

Conflict

การดำเนินการขัดแย้งกับบัญชีของผู้ให้บริการหรือทรัพยากรที่มีอยู่

500

Internal Server Error

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

501

Not Implemented

provider ที่เลือกยังไม่รองรับการดำเนินการนี้

502

Bad Gateway

อะแดปเตอร์หรือ upstream provider ไม่สามารถทำรายการให้เสร็จได้

เมื่อคำขอล้มเหลว

ตรวจ HTTP และ error.code/numeric_code เก็บ request_id แล้วแก้พารามิเตอร์ ยืนยันตัวตนต่อ หรือตรวจ runtime ตามสาเหตุ ตรวจผลครั้งก่อนก่อนส่งหรือเขียนซ้ำ อ้างอิงรหัสข้อผิดพลาด

invalid_request · 10000 · 400: ตรวจฟิลด์บังคับ รูปแบบ และเงื่อนไขช่องทาง แล้วแก้คำขอ
invalid_api_key · 11001 · 401: ตรวจ X-Api-Key และว่า workspace ยังใช้งานอยู่