Listar listas de contatos

GET/v1/accounts/{accountId}/contactLists

Retorna as listas de contatos da conta, opcionalmente filtradas e ordenadas.

Parâmetros de caminho

accountIduuidObrigatório

ID da sua conta SIP Caller. Consulte ID da conta.

Parâmetros de query string

filterJSON object

Condições que os registros devem atender, como {"name":"sales"}. Consulte os Campos de filtro abaixo, e Filtro para a sintaxe.

sortJSON array

Campo e direção usados para ordenar os registros, como ["name","DESC"]. O padrão é ["name","ASC"]. Consulte Ordenação.

rangeJSON array

Posições, começando em zero, do primeiro e do último registro a retornar, ambos incluídos, como [0,99]. O padrão é [0,9]. Consulte Paginação.

Campos de filtro

Campos que podem ser usados no parâmetro de query string filter. Consulte Filtro para a sintaxe geral.

idsarray of uuids

Listas de contatos com qualquer um dos IDs informados.

Exemplo: {"ids":["CONTACT_LIST_ID_1","CONTACT_LIST_ID_2"]}
namestring

Listas de contatos cujo nome contém o texto (sem diferenciar maiúsculas e minúsculas).

Exemplo: {"name":"overdue"}

Campos de ordenação

Campos que podem ser usados no parâmetro de query string sort, em ordem crescente (ASC) ou decrescente (DESC). Consulte Ordenação para a sintaxe geral. Quando sort é omitido, os resultados são ordenados por name em ordem crescente.

namenumbersCount

Retorna

Retorna um array de objetos lista de contatos para a página solicitada. Os cabeçalhos X-Total-Count e Content-Range contêm o número total de registros que atendem ao filtro, por exemplo Content-Range: contactLists 0-9/57. Consulte Paginação.

GET

/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]'

Resposta

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" } ]


SIP Caller
© 2026 Easy Caller LLC Todos os direitos reservados
LinkedinYou Tube
Trustpilot