Saltar al contenido
Desarrolladores
3 min de lectura

Búsqueda de números

Busca en el catálogo de telefonía los números disponibles para una cuenta. La búsqueda es de solo lectura y no compra nada.

Compartir artículo

Este endpoint busca en el catálogo de telefonía los números disponibles para la cuenta. La búsqueda es de solo lectura: no selecciona nada ni compra nada, así que no genera ningún cargo.

Buscar requiere ser administrador de la cuenta.

Buscar no compra

Buscar en el catálogo nunca reserva ni compra un número. Los números se compran fuera de esta API, así que toma un resultado como una sugerencia que alguien más podría tomar.

POST /v0/account/{account_id}/number
curl -X POST https://api.furcata.com/v0/account/acc_123/number \
  -H "Authorization: Bearer YOUR_FURCATA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "local",
    "country": "US",
    "area": "CA",
    "areaCodes": [415, 510],
    "distance": 50
  }'
Respuesta
{
  "message": "2 numbers available",
  "items": [
    {
      "phoneNumber": "+15555550100",
      "friendlyName": "(555) 555-0100",
      "locality": "San Francisco",
      "region": "CA",
      "country": "US"
    }
  ]
}

Campos de la petición

  • type: local o tollFree. Por defecto es local.
  • areaCodes: hasta cincuenta códigos de área en los que buscar.
  • country: un código de país de dos letras.
  • area: una región administrativa, como un estado o una provincia.
  • latitude y longitude: el centro de la búsqueda.
  • distance: el radio de búsqueda, de 0 a 10000.
  • placeId: un identificador de lugar alrededor del cual buscar.

La respuesta tiene un message y un arreglo items con los números que coincidieron.

Capacidad del plan

La capacidad del plan se sigue aplicando. Una cuenta que ya alcanzó su límite de números recibe un error en lugar de un listado, así que un plan lleno se ve como una búsqueda fallida y no como una búsqueda vacía.

Errores

  • 400 cuando un campo está fuera de rango, por ejemplo una distancia mayor a 10000.
  • 401 cuando falta el token o no se acepta.
  • 403 cuando quien llama no es administrador de la cuenta.
  • 412 cuando la cuenta alcanzó la capacidad de su plan para números.
  • 429 cuando superas el límite de peticiones.

Próximos pasos

Lee Servicios para ver los programas ya configurados en la cuenta, o Contactos para agregar los contactos que planeas alcanzar.