Números de teléfono
Las líneas que atienden tus agentes: tipo, estado y quién tiene cada línea.
Los endpoints de números de teléfono devuelven las líneas que atienden tus agentes. Necesitan el permiso numbers:read.
| Endpoint | Ruta | Permiso |
|---|---|---|
| Listar números | GET /v1/numbers |
numbers:read |
| Un número | GET /v1/numbers/{number_id} |
numbers:read |
Los números son de todo el cliente: una clave limitada a algunos locales recibe 403 insufficient_scope. En los ejemplos, $BASE es https://api.bookline.ai/v1 y $BOOKLINE_API_KEY tu clave, como en los primeros pasos.
Listar números
Sección titulada «Listar números»GET /v1/numbers devuelve tus números, paginados.
| Parámetro | Tipo | Por defecto | Reglas |
|---|---|---|---|
type |
PSTN | VIRTUAL |
ambos | Solo los números de este tipo |
status |
ACTIVE | BLOCKED | INACTIVE | PENDING_DELETION |
todos | Solo los números en este estado |
limit |
de 1 a 100 | 50 | Números por página |
cursor |
texto | ninguno | meta.next_cursor de la página anterior, con los mismos filtros y el mismo limit |
customer_id |
UUID | el cliente de la clave | Consulta qué lee cada clave |
curl -s -H "apikey: $BOOKLINE_API_KEY" "$BASE/numbers?status=ACTIVE"{ "data": [ { "id": "…", "phone_number": "+34910000000", "virtual_id": null, "type": "PSTN", "status": "ACTIVE", "ownership": "BOOKLINE" } ], "meta": { "limit": 50, "next_cursor": null }}| Campo | Qué es |
|---|---|
id |
El identificador del número |
phone_number |
El número en E.164, p. ej. +34910000000; null en un número que no es PSTN |
virtual_id |
El id con el que se llega a un número VIRTUAL en tu centralita, si tiene |
type |
PSTN: una línea de la red telefónica pública; VIRTUAL: se llega a través de una centralita |
status |
ACTIVE: en servicio; BLOCKED: en servicio pero no asignable; INACTIVE; PENDING_DELETION |
ownership |
BOOKLINE: Bookline tiene la línea con el operador; CUSTOMER: la tienes tú y Bookline solo la enruta |
Un número
Sección titulada «Un número»GET /v1/numbers/{number_id} devuelve los mismos campos. Un número que no es de tu cliente es 404 not_found.
Reglas de los datos
Sección titulada «Reglas de los datos»- Solo los campos de esta página. La configuración del operador y del enrutamiento no forma parte de la API.
- Solo lectura. Los números se gestionan en el portal o los gestiona Bookline.
