Recuperar números de teléfono

Usa la API de administración de WhatsApp Business para recuperar números de teléfono que una empresa registró en su cuenta de WhatsApp Business.

Antes de empezar

Necesitarás lo siguiente:

• El identificador de la cuenta de WhatsApp Business correspondiente a los números de teléfono de la empresa que quieres recuperar.
• Un token de acceso de usuario del sistema vinculado con tu cuenta de WhatsApp Business.
• El permiso whatsapp_business_management.

Limitaciones

• Esta API solo puede recuperar números de teléfono registrados. No se permite agregar, actualizar ni eliminar números de teléfono con esta API.

Obtener todos los números de teléfono

Para obtener una lista de todos los números de teléfono asociados con la cuenta de WhatsApp Business, envía una solicitud GET al punto de conexión Cuenta de WhatsApp Business > Números de teléfono.

Además, los números de teléfono pueden ordenarse en orden ascendente o descendente mediante last_onboarded_time, que se basa en el momento en que el usuario completó la incorporación para Registro insertado. Si no se especifica, el orden predeterminado es descendente.

Ejemplo de solicitud

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

Si se envía correctamente, se devuelve un objeto JSON con una lista de todos los nombres, números de teléfono, identificadores de números de teléfono y calificaciones de calidad asociados a una empresa. Los resultados se ordenan en forma descendente por fecha de finalización de registro insertado (se muestra primero el registro más reciente).

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

Ejemplo de solicitud

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

Si se envía correctamente, se devuelve un objeto JSON con una lista de todos los nombres, números de teléfono, identificadores de números de teléfono y calificaciones de calidad asociados a una empresa. Se ordena según el momento en que el usuario completó el registro insertado en orden ascendente (se muestra último el que se registró más recientemente).

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

Filtrar números de teléfono

Puedes buscar números de teléfono y filtrarlos según su account_mode. Esta opción de filtrado se está probando actualmente en modo beta. No todos los desarrolladores tienen acceso a este modo.

Parámetros

Ejemplo de solicitud

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"

Ejemplo de respuesta

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

Obtener un número de teléfono

Para obtener información sobre un número de teléfono, envía una solicitud GET al punto de conexión Número de teléfono de WhatsApp Business:

Sintaxis de la solicitud

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

Ejemplo de solicitud

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

Si se envía correctamente, se devuelve un objeto JSON con el nombre de la empresa, el número de teléfono, el identificador del número de teléfono y la clasificación de calidad del número de teléfono sobre el cual se realizó la consulta.

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

Obtener el estado del nombre para mostrar (beta)

Incluye el campo fields=name_status como parámetro de cadena de consulta para obtener el estado de un nombre para mostrar asociado con un número de teléfono específico. Por el momento, este campo está en versión beta y no está disponible para todos los desarrolladores.

Ejemplo de solicitud

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

Ejemplo de respuesta

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

El valor de name_status puede ser uno de los siguientes:

• APPROVED: se aprobó el nombre. Puedes descargar ahora tu certificado.
• AVAILABLE_WITHOUT_REVIEW: el certificado del teléfono está disponible y el nombre para mostrar está listo para su uso sin revisión.
• DECLINED: no se aprobó el nombre. No puedes descargar tu certificado.
• EXPIRED: tu certificado venció y ya no se puede descargar.
• PENDING_REVIEW: está en revisión la solicitud del nombre. No puedes descargar tu certificado.
• NONE: no hay ningún certificado disponible.

Ten en cuenta que los certificados tienen una validez de 7 días.

Más información

Si deseas obtener una lista de todos los valores posibles de cada campo, consulta la referencia de la API Graph sobre el campo Número de teléfono.