Listar listas negras

GET/v1/accounts/{accountId}/blackLists

Retorna as listas negras 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 negras com qualquer um dos IDs informados.

Exemplo: {"ids":["BLACK_LIST_ID_1","BLACK_LIST_ID_2"]}
namestring

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

Exemplo: {"name":"do not call"}

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 negra 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: blackLists 0-9/57. Consulte Paginação.

GET

/v1/accounts/ACCOUNT_ID/blackLists

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

Resposta

200 OK

[ { "id": "01a0dedd-b9a2-729d-8e0a-4e3ad9197aea", "name": "Do Not Call", "numbersCount": 3, "updatedAt": "2026-09-26T17:57:48.064" }, { "id": "01a0dad2-c0a6-7205-8d4e-a2d5f4197825", "name": "National DNC Registry", "numbersCount": 18452, "updatedAt": "2026-09-25T23:09:37.921" } ]


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