Listar números de campaña

GET/v1/accounts/{accountId}/campaigns/{campaignId}/numbers

Devuelve los números de una campaña, opcionalmente filtrados y ordenados. Los números eliminados no se incluyen: usa el reporte de detalle de números para obtenerlos.

Parámetros de ruta

accountIduuidObligatorio

ID de tu cuenta de SIP Caller. Consulta ID de la cuenta.

campaignIduuidObligatorio

ID de la campaña.

Parámetros de consulta

filterJSON object

Condiciones que deben cumplir los registros, como {"name":"sales"}. Consulta los Campos de filtro más abajo, y Filtro para ver la sintaxis.

sortJSON array

Campo y dirección usados para ordenar los registros, como ["id","DESC"]. El valor predeterminado es ["id","ASC"]. Consulta Ordenamiento.

rangeJSON array

Posiciones, comenzando en cero, del primer y del último registro a devolver, ambos incluidos, como [0,99]. El valor predeterminado es [0,9]. Consulta Paginación.

Campos de filtro

Campos que se pueden usar en el parámetro de consulta filter. Consulta Filtro para ver la sintaxis general.

numberstring

Números que contienen el texto, lo que permite búsquedas parciales.

Ejemplo: {"number":"555100"}
varValuesobject

Números cuya variable contiene el texto (sin distinguir mayúsculas de minúsculas). La clave es $ seguido de la posición de la variable, comenzando en 1.

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

Números por cantidad de intentos.

Ejemplo: {"attempts_gt":1}
statusenum

Números en el estado indicado. Usa un array para varios estados.

Valores posibles:NotContactedContactingSuccessFailureRetryPendingBlacklisted
Ejemplo: {"status":["NotContacted","RetryPending"]}

Campos de ordenamiento

Campos que se pueden usar en el parámetro de consulta sort, en orden ascendente (ASC) o descendente (DESC). Consulta Ordenamiento para ver la sintaxis general. Cuando se omite sort, los resultados se ordenan por id en orden ascendente.

idnumberaddedAtattempts

Devuelve

Devuelve un array de objetos número de campaña para la página solicitada. Los encabezados X-Total-Count y Content-Range contienen la cantidad total de registros que cumplen el filtro, por ejemplo Content-Range: campaignNumbers 0-9/57. Consulta Paginación.

GET

/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers

curl -G 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers' \ -H 'Authorization: Bearer API_KEY_TOKEN' \ --data-urlencode 'filter={"status":["RetryPending","Success"]}' \ --data-urlencode 'sort=["number","ASC"]' \ --data-urlencode 'range=[0,99]'

Respuesta

200 OK

[ { "id": 1048165, "number": "+18035551004", "varValues": [ "Stefan Robertson", "$99.00" ], "addedAtLocal": "2026-10-01T10:05:23.452", "attempts": 1, "status": "RetryPending" }, { "id": 1048166, "number": "+18035551005", "varValues": [ "Millie Watson", "$118.49" ], "addedAtLocal": "2026-10-01T10:05:23.452", "attempts": 1, "status": "Success" } ]


SIP Caller
© 2026 Easy Caller LLC Todos los Derechos Reservados
LinkedinYou Tube
Trustpilot