Truy xuất số điện thoại

Truy xuất số điện thoại mà doanh nghiệp đã đăng ký cho Tài khoản WhatsApp Business của họ qua API Quản lý WhatsApp Business.

Trước khi bạn bắt đầu

Bạn sẽ cần:

• ID Tài khoản WhatsApp Business cho số điện thoại của doanh nghiệp mà bạn muốn truy xuất
• Mã truy cập dành cho Người dùng hệ thống được liên kết với Tài khoản WhatsApp Business của bạn
• Quyền whatsapp_business_management

Các giới hạn

• API này chỉ có thể truy xuất số điện thoại đã được đăng ký. Bạn không được phép thêm, cập nhật hoặc xóa số điện thoại qua API này.

Lấy tất cả số điện thoại

Để lấy danh sách tất cả số điện thoại được liên kết với Tài khoản WhatsApp Business, hãy gửi yêu cầu GET đến điểm cuối Tài khoản WhatsApp Business > Số điện thoại.

Ngoài ra, bạn có thể sắp xếp số điện thoại theo thứ tự tăng dần hoặc giảm dần dựa trên last_onboarded_time. Đây là thời điểm người dùng hoàn tất việc tích hợp cho quy trình Đăng ký nhúng. Nếu không được chỉ định, thứ tự mặc định là giảm dần.

Yêu cầu mẫu

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

Khi thành công, hệ thống sẽ trả về một đối tượng JSON kèm theo danh sách tất cả tên doanh nghiệp, số điện thoại, ID số điện thoại và xếp hạng chất lượng được liên kết với một doanh nghiệp. Kết quả được sắp xếp theo ngày hoàn thành quy trình đăng ký nhúng theo thứ tự giảm dần, trong đó mục tích hợp gần đây nhất được liệt kê đầu tiên.

{
  "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"
    }
  ]
}

Yêu cầu mẫu

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

Khi thành công, hệ thống sẽ trả về một đối tượng JSON kèm theo danh sách tất cả tên doanh nghiệp, số điện thoại, ID số điện thoại và xếp hạng chất lượng được liên kết với một doanh nghiệp. Danh sách được sắp xếp theo thời điểm người dùng hoàn thành quy trình đăng ký nhúng theo thứ tự tăng dần, trong đó mục tích hợp gần đây nhất được liệt kê sau cùng.

{
  "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"     
    }   
  ]
}

Lọc số điện thoại

Bạn có thể truy vấn số điện thoại và lọc dựa trên account_mode. Tùy chọn lọc này hiện đang được thử nghiệm ở chế độ beta. Không phải nhà phát triển nào cũng có quyền truy cập.

Thông số

Yêu cầu mẫu

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

Phản hồi mẫu

{
  "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"
	}
   }
}

Lấy một số điện thoại

Để lấy thông tin về một số điện thoại, hãy gửi yêu cầu GET đến điểm cuối Số điện thoại WhatsApp Business:

Cú pháp yêu cầu

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

Yêu cầu mẫu

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

Khi thành công, hệ thống sẽ trả về một đối tượng JSON kèm theo tên doanh nghiệp, số điện thoại, ID số điện thoại và xếp hạng chất lượng cho số điện thoại được truy vấn.

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

Lấy trạng thái tên hiển thị (Beta)

Hãy thêm fields=name_status làm thông số chuỗi truy vấn để lấy trạng thái của tên hiển thị được liên kết với số điện thoại cụ thể. Trường này đang ở chế độ beta và chưa được cung cấp cho tất cả nhà phát triển.

Yêu cầu mẫu

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

Phản hồi mẫu

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

Giá trị name_status có thể là một trong những loại sau:

• APPROVED: Tên đã được phê duyệt. Bạn có thể tải chứng chỉ xuống ngay bây giờ.
• AVAILABLE_WITHOUT_REVIEW: Đã có chứng chỉ cho điện thoại và tên hiển thị đã sẵn sàng để sử dụng mà không cần xét duyệt.
• DECLINED: Tên chưa được phê duyệt. Bạn không thể tải chứng chỉ xuống.
• EXPIRED: Chứng chỉ của bạn đã hết hạn và không tải xuống được nữa.
• PENDING_REVIEW: Yêu cầu đăng ký tên của bạn đang được xem xét. Bạn không thể tải chứng chỉ xuống.
• NONE: Không có chứng chỉ nào.

Lưu ý rằng chứng chỉ có giá trị trong 7 ngày.

Tìm hiểu thêm

Để biết danh sách tất cả các giá trị có thể dùng cho từng trường, hãy xem tài liệu tham khảo về API Đồ thị của trường Số điện thoại.