เรียกดูหมายเลขโทรศัพท์

เรียกดูหมายเลขโทรศัพท์ที่ธุรกิจได้ลงทะเบียนไว้สำหรับบัญชี WhatsApp Business ของตนโดยใช้ API การจัดการ WhatsApp Business

ก่อนเริ่มต้น

คุณจำเป็นต้องมีสิ่งต่อไปนี้

• ID บัญชี WhatsApp Business สำหรับหมายเลขโทรศัพท์ของธุรกิจที่คุณต้องการจะเรียกดู
• โทเค็นการเข้าถึงผู้ใช้ระบบที่ลิงก์กับบัญชี WhatsApp Business ของคุณ
• สิทธิ์การอนุญาต whatsapp_business_management

ข้อจำกัด

• API นี้ทำได้เพียงเรียกดูหมายเลขโทรศัพท์ที่ลงทะเบียนไว้แล้ว คุณจึงไม่สามารถใช้ API นี้เพื่อเพิ่ม อัพเดต หรือลบหมายเลขโทรศัพท์ได้

เรียกดูหมายเลขโทรศัพท์ทั้งหมด

หากต้องการเรียกดูรายการหมายเลขโทรศัพท์ทั้งหมดที่เชื่อมโยงกับบัญชี WhatsApp Business ให้ส่งคำขอ GET ไปยังตำแหน่งข้อมูลบัญชี WhatsApp Business > หมายเลขโทรศัพท์

นอกจากนี้ หมายเลขโทรศัพท์ยังสามารถจัดเรียงได้ทั้งแบบน้อยไปมากและมากไปน้อยด้วย last_onboarded_time ซึ่งจะอ้างอิงจากเมื่อผู้ใช้เสร็จสิ้นขั้นการเริ่มต้นใช้งานสำหรับการสมัครใช้งานแบบฝัง หากไม่ได้ระบุ ลำดับตามค่าเริ่มต้นจะเรียงจากมากไปน้อย

ตัวอย่างคำขอ

curl -X GET "https://graph.facebook.com/v21.0/{whatsapp-business-account-id}/phone_numbers
      ?access_token={system-user-access-token}"

เมื่อดำเนินการสำเร็จ ระบบจะส่งคืนอ็อบเจ็กต์ JSON พร้อมรายการชื่อธุรกิจ, หมายเลขโทรศัพท์, ID หมายเลขโทรศัพท์ และคะแนนคุณภาพทั้งหมดที่เชื่อมโยงกับธุรกิจ ระบบจะเรียงผลลัพธ์ตามวันที่ดำเนินการสมัครใช้งานแบบฝังเสร็จสมบูรณ์ตามลำดับจากใหม่ไปเก่า โดยนำรายการที่มีการใช้งานล่าสุดมาก่อน

{
  "data": [
    {
      "verified_name": "Jasper's Market",
      "display_phone_number": "+1 631-555-5555",
      "id": "1906385232743451",
      "quality_rating": "GREEN"
      
    },
    {
      "verified_name": "Jasper's Ice Cream",
      "display_phone_number": "+1 631-555-5556",
      "id": "1913623884432103",
      "quality_rating": "NA"
    }
  ]
}

ตัวอย่างคำขอ

curl -X GET "https://graph.facebook.com/v21.0/{whatsapp-business-account-id}/phone_numbers
      ?access_token={system-user-access-token}]&sort=['last_onboarded_time_ascending']"

เมื่อดำเนินการสำเร็จ ระบบจะส่งคืนอ็อบเจ็กต์ JSON พร้อมรายการชื่อธุรกิจ, หมายเลขโทรศัพท์, ID หมายเลขโทรศัพท์ และคะแนนคุณภาพทั้งหมดที่เชื่อมโยงกับธุรกิจ ระบบจะเรียงตามเวลาที่ผู้ใช้สมัครใช้งานแบบฝังเสร็จสมบูรณ์ตามลำดับจากเก่าไปใหม่ โดยนำรายการที่มีการใช้งานล่าสุดไว้หลัง

{
  "data": [
   {
      "verified_name": "Jasper's Ice Cream",
      "display_phone_number": "+1 631-555-5556",
      "id": "1913623884432103",
      "quality_rating": "NA"
    },
    {
      "verified_name": "Jasper's Market",
      "display_phone_number": "+1 631-555-5555",
      "id": "1906385232743451",
      "quality_rating": "GREEN"     
    }   
  ]
}

กรองหมายเลขโทรศัพท์

คุณสามารถสืบค้นหมายเลขโทรศัพท์และกรองตาม account_mode ได้ โดยตัวเลือกในการกรองกำลังอยู่ระหว่างการทดสอบในโหมดเบต้า จึงมีผู้พัฒนาเพียงบางรายที่สามารถใช้งานตัวเลือกดังกล่าวได้

พารามิเตอร์

ตัวอย่างคำขอ

curl -i -X GET "https://graph.facebook.com/v21.0/{whatsapp-business-account-ID}/phone_numbers?filtering=[{"field":"account_mode","operator":"EQUAL","value":"SANDBOX"}]&access_token=access-token"

ตัวอย่างการตอบกลับ

{
  "data": [
    {
      "id": "1972385232742141",    
      "display_phone_number": "+1 631-555-1111",
      "verified_name": "John’s Cake Shop",
      "quality_rating": "UNKNOWN",
    }
  ],
  "paging": {
	"cursors": {
		"before": "abcdefghij",
		"after": "klmnopqr"
	}
   }
}

เรียกดูหมายเลขโทรศัพท์รายการเดียว

หากต้องการเรียกดูข้อมูลเกี่ยวกับหมายเลขโทรศัพท์ ให้ส่งคำขอ GET ไปยังตำแหน่งข้อมูลหมายเลขโทรศัพท์ WhatsApp Business:

รูปแบบคำสั่งของคำขอ

GET https://graph.facebook.com/<API_VERSION>/<PHONE_NUMBER_ID>

ตัวอย่างคำขอ

curl \
'https://graph.facebook.com/v15.0/105954558954427/' \
-H 'Authorization: Bearer EAAFl...'

เมื่อดำเนินการสำเร็จ ระบบจะส่งคืนอ็อบเจ็กต์ JSON พร้อมชื่อธุรกิจ, หมายเลขโทรศัพท์, ID หมายเลขโทรศัพท์ และคะแนนคุณภาพสำหรับหมายเลขโทรศัพท์ที่สืบค้น

{
  "code_verification_status" : "VERIFIED",
  "display_phone_number" : "15555555555",
  "id" : "105954558954427",
  "quality_rating" : "GREEN",
  "verified_name" : "Support Number"
}

เรียกดูสถานะของชื่อที่แสดง (เบต้า)

ระบุ fields=name_status เป็นพารามิเตอร์สตริงการสืบค้นเพื่อเรียกดูข้อมูลสถานะชื่อที่แสดงที่เชื่อมโยงกับหมายเลขโทรศัพท์ที่เฉพาะเจาะจง ช่องนี้อยู่ในรุ่นเบต้าและไม่ได้เข้าถึงได้สำหรับผู้พัฒนาทุกคน

ตัวอย่างคำขอ

curl \
'https://graph.facebook.com/v15.0/105954558954427?fields=name_status' \
-H 'Authorization: Bearer EAAFl...'

ตัวอย่างการตอบกลับ

{
  "id" : "105954558954427",
  "name_status" : "AVAILABLE_WITHOUT_REVIEW"
}

ค่า name_status อาจเป็นอย่างใดอย่างหนึ่งต่อไปนี้

• APPROVED: ชื่อได้รับการอนุมัติแล้ว คุณสามารถดาวน์โหลดใบรับรองของคุณได้เลย
• AVAILABLE_WITHOUT_REVIEW: ระบบรับรองหมายเลขโทรศัพท์แล้วและชื่อที่แสดงก็พร้อมให้ใช้งานโดยไม่ต้องมีการตรวจสอบ
• DECLINED: ชื่อไม่ได้รับการอนุมัติ คุณไม่สามารถดาวน์โหลดใบรับรองของคุณได้
• EXPIRED: ใบรับรองของคุณหมดอายุแล้วและไม่สามารถดาวน์โหลดได้อีกต่อไป
• PENDING_REVIEW: คำขอชื่อของคุณอยู่ระหว่างการตรวจสอบ คุณไม่สามารถดาวน์โหลดใบรับรองของคุณได้
• NONE: ไม่มีใบรับรอง

โปรดทราบว่าใบรับรองนี้ใช้ได้เป็นเวลา 7 วัน

เรียนรู้เพิ่มเติม

โปรดดูรายการค่าที่เป็นไปได้ทั้งหมดสำหรับแต่ละช่องที่ข้อมูลอ้างอิงเกี่ยวกับ API กราฟของช่องหมายเลขโทรศัพท์