Listar detalhes dos números

GET/v1/accounts/{accountId}/campaigns/{campaignId}/reports/numberDetails

Retorna os números de uma campanha com seu status atual, opcionalmente filtrados e ordenados. Ao contrário de Listar números da campanha, os números excluídos são incluídos.

Parâmetros de caminho

accountIduuidObrigatório

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

campaignIduuidObrigatório

ID da campanha.

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 ["id","DESC"]. O padrão é ["id","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.

numberstring

Números que contêm o texto, o que permite buscas parciais.

Exemplo: {"number":"555100"}
varValuesobject

Números cuja variável contém o texto (sem diferenciar maiúsculas e minúsculas). A chave é $ seguido da posição da variável, começando em 1.

Exemplo: {"varValues":{"$1":"robertson"}}
attemptsintegerOperadores: _gt_gte_lt_lte

Números por quantidade de tentativas.

Exemplo: {"attempts_gt":1}
statusenum

Números no status informado. Use um array para vários status.

Valores possíveis:NotContactedContactingSuccessFailureRetryPendingBlacklistedDeleted
Exemplo: {"status":["NotContacted","RetryPending"]}

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 id em ordem crescente.

idnumberaddedAtattempts

Retorna

Retorna um array de objetos detalhes do número 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: numberDetails 0-9/57. Consulte Paginação.

GET

/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/reports/numberDetails

curl -G 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/reports/numberDetails' \ -H 'Authorization: Bearer API_KEY_TOKEN' \ --data-urlencode 'filter={"status":"RetryPending","attempts_gte":2}' \ --data-urlencode 'sort=["attempts","DESC"]' \ --data-urlencode 'range=[0,99]'

Resposta

200 OK

[ { "id": 1048170, "number": "+18035551009", "varValues": [ "Clara White", "$350.00" ], "addedAtLocal": "2026-10-01T10:05:23.452", "attempts": 2, "status": "RetryPending" } ]


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