Elencare gli elenchi di contatti
/v1/accounts/{accountId}/contactListsRestituisce gli elenchi di contatti dell'account, con filtri e ordinamento opzionali.
Parametri di percorso
ID del tuo account SIP Caller. Consulta ID dell'account.
Parametri di query
Condizioni che i record devono soddisfare, ad esempio {"name":"sales"}. Consulta i Campi di filtro più avanti, e Filtro per la sintassi.
Campo e direzione utilizzati per ordinare i record, ad esempio ["name","DESC"]. Il valore predefinito è ["name","ASC"]. Consulta Ordinamento.
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.
Elenchi di contatti con uno qualsiasi degli ID indicati.
{"ids":["CONTACT_LIST_ID_1","CONTACT_LIST_ID_2"]}Elenchi di contatti il cui nome contiene il testo (senza distinzione tra maiuscole e minuscole).
{"name":"overdue"}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 name in ordine crescente.
namenumbersCountRestituisce
Restituisce un array di oggetti elenco di contatti 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: contactLists 0-9/57. Consulta Paginazione.
/v1/accounts/ACCOUNT_ID/contactLists
curl -G 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/contactLists' \
-H 'Authorization: Bearer API_KEY_TOKEN' \
--data-urlencode 'filter={"name":"overdue"}' \
--data-urlencode 'sort=["name","ASC"]' \
--data-urlencode 'range=[0,99]'Risposta
200 OK
[
{
"id": "019ffc4b-1c59-72ed-b15a-cbf81a2b95d9",
"name": "Overdue Accounts",
"numbersCount": 1255,
"varNames": [
"Customer Name",
"Due Balance"
],
"updatedAt": "2026-08-13T18:03:28.729"
}
]
