Mengambil Nomor Telepon

Mengambil Nomor Telepon yang telah didaftarkan oleh bisnis untuk Akun WhatsApp Business mereka menggunakan API Pengelolaan WhatsApp Business.

Sebelum Memulai

Anda akan memerlukan:

• ID Akun WhatsApp Business untuk nomor telepon bisnis yang ingin Anda ambil
• Token akses Pengguna Sistem yang tertaut ke Akun WhatsApp Business Anda
• Izin whatsapp_business_management

Batasan

• API ini hanya dapat mengambil nomor telepon yang telah terdaftar. Menambah, memperbarui, atau menghapus nomor telepon tidak diizinkan menggunakan API.

Mendapatkan Semua Nomor Telepon

Untuk mendapatkan daftar semua nomor telepon yang terkait dengan Akun WhatsApp Business, kirimkan permintaan GET ke endpoint Nomor Telepon WhatsApp Business.

Selain itu, nomor telepon dapat diurutkan dalam urutan naik atau turun berdasarkan last_onboarded_time, yang didasarkan pada saat pengguna menyelesaikan onboarding untuk Pendaftaran Tersemat. Jika tidak ditentukan, urutan default-nya menurun.

Contoh Permintaan

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

Setelah berhasil, objek JSON ditampilkan dengan daftar semua nama bisnis, nomor telepon, ID nomor telepon, dan penilaian kualitas yang terkait dengan suatu bisnis. Hasil diurutkan berdasarkan tanggal penyelesaian pendaftaran tersemat dalam urutan menurun, dengan yang terbaru onboarding terlebih dahulu.

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

Contoh Permintaan

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']"

Setelah berhasil, objek JSON ditampilkan dengan daftar semua nama bisnis, nomor telepon, ID nomor telepon, dan penilaian kualitas yang terkait dengan suatu bisnis. Ini diurutkan berdasarkan kapan pengguna telah menyelesaikan pendaftaran tersemat dalam urutan naik, dengan yang terbaru onboarding di urutan terakhir.

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

Filter Nomor Telepon

Anda dapat menanyakan nomor telepon dan memfilternya berdasarkan account_mode mereka. Opsi pemfilteran ini sedang diuji dalam mode beta. Tidak semua developer memiliki akses ke situ.

Parameter

Contoh Permintaan

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"

Contoh Tanggapan

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

Mendapatkan Satu Nomor Telepon

Untuk mendapatkan informasi tentang nomor telepon, kirim permintaan GET ke endpoint Nomor Telepon WhatsApp Business:

Sintaksis Permintaan

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

Contoh Permintaan

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

Jika berhasil, objek JSON ditampilkan dengan nama bisnis, nomor telepon, ID nomor telepon, dan peringkat kualitas untuk nomor telepon yang di-kueri.

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

Mendapatkan Status Nama Tampilan (Beta)

Sertakan fields=name_status sebagai parameter string kueri untuk mendapatkan status nama tampilan yang terkait dengan nomor telepon tertentu. Kolom ini sekarang dalam versi beta dan belum tersedia untuk semua developer.

Contoh Permintaan

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

Contoh Tanggapan

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

Nilai name_status dapat berupa salah satu dari berikut:

• APPROVED: Nama telah disetujui. Anda dapat mengunduh sertifikat Anda sekarang.
• AVAILABLE_WITHOUT_REVIEW: Sertifikat untuk telepon sudah tersedia dan nama tampilan sudah siap digunakan tanpa tinjauan.
• DECLINED: Nama belum disetujui. Anda tidak dapat mengunduh sertifikat Anda.
• EXPIRED: Sertifikat Anda telah kedaluwarsa dan tidak dapat diunduh lagi.
• PENDING_REVIEW: Permintaan nama Anda sedang ditinjau. Anda tidak dapat mengunduh sertifikat Anda.
• NONE: Tidak ada sertifikat yang tersedia.

Perhatikan bahwa sertifikat berlaku selama 7 hari.

Pelajari Selengkapnya

Untuk melihat daftar semua kemungkinan nilai tiap kolom, baca referensi Graph API kolom Nomor Telepon.