Subir números desde un archivo CSV
/v1/accounts/{accountId}/campaigns/{campaignId}/numbers/uploadAgrega a una campaña los números de un archivo CSV (valores separados por comas). Es la forma más eficiente de agregar una gran cantidad de números.
Cada fila del archivo contiene un número en la primera columna, seguido de los valores de sus variables. Por ejemplo, un archivo con 2 variables:
5550001,John,199
5550002,Mary,299
5550003,Susan,149
La primera columna puede contener varios números para el mismo contacto, separados por punto y coma. Los números no válidos se omiten, y se informan en la respuesta. Una fila con una cantidad incorrecta de columnas hace que toda la solicitud falle con 400 Bad Request, indicando la línea con el problema.
Se pueden agregar números a las campañas en estado Draft, y a las campañas Active o Paused con provisión de números Dynamic. Las demás campañas devuelven 409 Conflict.
Los duplicados se gestionan de forma diferente según el estado de la campaña. En las campañas Draft, se omite un número con los mismos valores de variables que uno existente (el mismo número se puede volver a agregar con valores diferentes). En las campañas Active o Paused, se agrega cada número enviado, aunque ya exista, ya que se considera una nueva llamada a realizar, por ejemplo para volver a contactar al mismo cliente.
Parámetros de ruta
ID de tu cuenta de SIP Caller. Consulta ID de la cuenta.
ID de la campaña.
Parámetros de consulta
Indica si la primera fila del archivo contiene nombres de columnas, y debe omitirse.
Cantidad de columnas de variables después de la columna del número, entre 0 y 20.
Nombres de las columnas de variables, en orden, como ["Customer Name","Due Balance"]. Si se incluye, debe contener varCount nombres.
Codificación de caracteres del archivo. El valor predeterminado es UTF8. Otros valores comunes son LATIN1 y windows-1252.
Cuerpo de la solicitud
Un cuerpo multipart/form-data con el archivo, de hasta 100 MB. Se pueden subir varios archivos en la misma solicitud.
Devuelve
Devuelve un array con un resultado por cada archivo subido:
Nombre del archivo subido.
Cantidad de filas leídas del archivo.
Cantidad de números agregados.
Cantidad de filas omitidas, porque el número no era válido o estaba duplicado.
Hasta 10 de los números no válidos encontrados en el archivo, para ayudarte a encontrar el problema.
/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers/upload
curl -X POST 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers/upload?firstRowIsHeader=false&varCount=2&varNames=%5B%22Customer%20Name%22%2C%22Due%20Balance%22%5D' \
-H 'Authorization: Bearer API_KEY_TOKEN' \
-F 'file=@campaign-numbers.csv;type=text/csv'Respuesta
200 OK
[
{
"fileName": "campaign-numbers.csv",
"totalNumbers": 5000,
"numbersAdded": 4997,
"numbersSkipped": 3,
"firstInvalidNumbers": [
"55A0012",
"12"
]
}
]
