WhatsApp APIAPI

WhatsApp: listar los números

Lista los números de WhatsApp del workspace conectados por la API oficial de Meta y obtén el id que va en numberId en los envíos.

Actualizado el

GET /whatsapp/numbers devuelve los números de WhatsApp del workspace. El id de cada uno va en numberId en los envíos de plantillas y de mensajes.

Listar los números

GET https://api.xbase.app/api/external/v1/whatsapp/numbers
curl https://api.xbase.app/api/external/v1/whatsapp/numbers \
  -H "Authorization: Bearer $XBASE_API_KEY"

Respuesta 200:

[
  {
    "id": "6d1f3c2a-4b5e-4f60-9a7b-8c9d0e1f2a3b",
    "phone": "5491155550000",
    "name": "Atención",
    "status": "ACTIVE"
  }
]
CampoTipoDescripción
idtextoId del número en XBASE. Va en numberId
phonetexto o nullNúmero que envía, solo dígitos, con el código de país
nametexto o nullNombre visible del número
statustextoACTIVE envía. INACTIVE está desconectado: los envíos por él responden 422 NUMBER_DISCONNECTED

La lista viene en el orden en que se conectaron los números. Un número quitado en WhatsApp API → Números no aparece.

Errores

EstadocodeCuándo
401INVALID_API_KEYSin clave, clave con formato incorrecto, inexistente o revocada
403MISSING_SCOPELa clave no tiene el alcance whatsapp:send

Mira el formato completo en Errores.

Preguntas frecuentes

Ver también

En esta página