Recupero dei numeri di telefono

Recupera i numeri di telefono che un'azienda ha registrato per il proprio account WhatsApp Business utilizzando l'API WhatsApp Business Management.

Prima di iniziare

Ecco cosa ti servirà:

• L'ID dell'account WhatsApp Business per i numeri di telefono dell'azienda che desideri recuperare
• Un token d'accesso dell'utente di sistema collegato al tuo account WhatsApp Business
• L'autorizzazione whatsapp_business_management

Limitazioni

• Questa API è in grado di recuperare esclusivamente numeri di telefono registrati. Con l'API non è possibile aggiungere, aggiornare o eliminare i numeri di telefono.

Ottenimento di tutti i numeri di telefono

Per ottenere un elenco di tutti i numeri di telefono associati a un account WhatsApp Business, invia una richiesta GET all'endpoint Account WhatsApp Business > Numeri di telefono.

Inoltre, i numeri di telefono possono essere ordinati sia in ordine crescente che in ordine decrescente per last_onboarded_time, che si basa sul momento in cui l'utente ha completato la registrazione per l'iscrizione integrata. Se non specificato, l'ordine predefinito è decrescente.

Esempio di richiesta

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

Se l'operazione viene eseguita correttamente, viene restituito un oggetto JSON con una lista di tutti i nomi delle aziende, dei numeri di telefono e dei relativi ID e delle valutazioni di qualità associate a ogni azienda. I risultati sono ordinati in base alla data di completamento dell'iscrizione in ordine decrescente, con le registrazioni più recenti elencate per prime.

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

Esempio di richiesta

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

Se l'operazione viene eseguita correttamente, viene restituito un oggetto JSON con una lista di tutti i nomi delle aziende, dei numeri di telefono e dei relativi ID e delle valutazioni di qualità associate a ogni azienda. La lista è ordinata in base al momento in cui l'utente ha completato l'iscrizione integrata in ordine crescente, con le registrazioni più recenti elencate per ultime.

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

Applicazione del filtro ai numeri di telefono

Puoi inviare query sui numeri di telefono e filtrarli in base all'account_mode. Questa opzione di filtro è attualmente in fase di test in modalità beta. Non vi hanno accesso tutti gli sviluppatori.

Parametri

Esempio di richiesta

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"

Esempio di risposta

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

Ottenimento di un singolo numero di telefono

Per ottenere informazioni su un numero di telefono, invia una richiesta GET all'endpoint Numero di telefono WhatsApp Business:

Sintassi della richiesta

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

Esempio di richiesta

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

Se l'operazione viene eseguita correttamente, viene restituito un oggetto JSON con il nome dell'azienda, il numero di telefono e il relativo ID e la valutazione della qualità associata al numero di telefono oggetto della query.

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

Ottenimento dello stato del nome visualizzato (beta)

Includi fields=name_status tra i parametri della stringa di query per ottenere lo stato di un nome visualizzato associato a uno specifico numero di telefono. Questo campo è attualmente in beta e non è disponibile per tutti gli sviluppatori.

Esempio di richiesta

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

Esempio di risposta

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

Il valore name_status può essere uno dei seguenti:

• APPROVED: il nome è stato approvato. Puoi scaricare subito il certificato.
• AVAILABLE_WITHOUT_REVIEW: il certificato per il numero di telefono è disponibile e il nome visualizzato è pronto per l'uso senza essere sottoposto a controllo.
• DECLINED: il nome non è stato approvato. Non puoi scaricare il certificato.
• EXPIRED: il certificato è scaduto e non può più essere scaricato.
• PENDING_REVIEW: la richiesta del nome è in fase di controllo. Non puoi scaricare il certificato.
• NONE: nessun certificato disponibile.

I certificati sono validi per 7 giorni.

Scopri di più

Per una lista di tutti i possibili valori per ciascun campo, consulta il riferimento all'API Graph del campo Numero di telefono.