Elencare i numeri di una lista nera

GET/v1/accounts/{accountId}/blackLists/{blackListId}/numbers

Restituisce i numeri di una lista nera, con filtri e ordinamento opzionali.

Parametri di percorso

accountIduuidObbligatorio

ID del tuo account SIP Caller. Consulta ID dell'account.

blackListIduuidObbligatorio

ID della lista nera.

Parametri di query

filterJSON object

Condizioni che i record devono soddisfare, ad esempio {"name":"sales"}. Consulta i Campi di filtro più avanti, e Filtro per la sintassi.

sortJSON array

Campo e direzione utilizzati per ordinare i record, ad esempio ["number","DESC"]. Il valore predefinito è ["number","ASC"]. Consulta Ordinamento.

rangeJSON array

Posizioni, a partire da zero, del primo e dell'ultimo record da restituire, entrambi inclusi, ad esempio [0,99]. Il valore predefinito è [0,9]. Consulta Paginazione.

Campi di filtro

Campi utilizzabili nel parametro di query filter. Consulta Filtro per la sintassi generale.

numberstring

Numeri che contengono il testo, il che consente ricerche parziali.

Esempio: {"number":"555010"}

Campi di ordinamento

Campi utilizzabili nel parametro di query sort, in ordine crescente (ASC) o decrescente (DESC). Consulta Ordinamento per la sintassi generale. Se sort viene omesso, i risultati sono ordinati per number in ordine crescente.

numberid

Restituisce

Restituisce un array di oggetti numero della lista nera per la pagina richiesta. Le intestazioni X-Total-Count e Content-Range contengono il numero totale di record che corrispondono al filtro, ad esempio Content-Range: blackListNumbers 0-9/57. Consulta Paginazione.

GET

/v1/accounts/ACCOUNT_ID/blackLists/BLACK_LIST_ID/numbers

curl -G 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/blackLists/BLACK_LIST_ID/numbers' \ -H 'Authorization: Bearer API_KEY_TOKEN' \ --data-urlencode 'filter={"number":"555010"}' \ --data-urlencode 'sort=["number","DESC"]' \ --data-urlencode 'range=[0,99]'

Risposta

200 OK

[ { "id": 3, "number": "+18005550103", "description": "Asked not to be called again" }, { "id": 2, "number": "+18005550102", "description": null }, { "id": 1, "number": "+18005550101", "description": "Customer request, 2026-09-12" } ]


SIP Caller
© 2026 Easy Caller LLC Tutti i diritti riservati
LinkedinYou Tube
Trustpilot