Enviar números a partir de um arquivo CSV
/v1/accounts/{accountId}/campaigns/{campaignId}/numbers/uploadAdiciona a uma campanha os números de um arquivo CSV (valores separados por vírgula). Esta é a forma mais eficiente de adicionar uma grande quantidade de números.
Cada linha do arquivo contém um número na primeira coluna, seguido dos valores das suas variáveis. Por exemplo, um arquivo com 2 variáveis:
5550001,John,199
5550002,Mary,299
5550003,Susan,149
A primeira coluna pode conter vários números para o mesmo contato, separados por ponto e vírgula. Os números inválidos são ignorados, e informados na resposta. Uma linha com um número de colunas incorreto faz com que toda a solicitação falhe com 400 Bad Request, indicando a linha com o problema.
É possível adicionar números a campanhas no estado Draft, e a campanhas Active ou Paused com provisionamento de números Dynamic. As demais campanhas retornam 409 Conflict.
As duplicatas são tratadas de forma diferente dependendo do estado da campanha. Nas campanhas Draft, um número com os mesmos valores de variáveis de um número existente é ignorado (o mesmo número pode ser adicionado novamente com valores diferentes). Nas campanhas Active ou Paused, todos os números enviados são adicionados, mesmo que já existam, pois cada um é considerado uma nova chamada a fazer, por exemplo para contatar o mesmo cliente novamente.
Parâmetros de caminho
ID da sua conta SIP Caller. Consulte ID da conta.
ID da campanha.
Parâmetros de query string
Indica se a primeira linha do arquivo contém os nomes das colunas, e deve ser ignorada.
Quantidade de colunas de variáveis após a coluna do número, entre 0 e 20.
Nomes das colunas de variáveis, em ordem, como ["Customer Name","Due Balance"]. Quando incluído, deve conter varCount nomes.
Codificação de caracteres do arquivo. O padrão é UTF8. Outros valores comuns são LATIN1 e windows-1252.
Corpo da solicitação
Um corpo multipart/form-data com o arquivo, de até 100 MB. É possível enviar vários arquivos na mesma solicitação.
Retorna
Retorna um array com um resultado para cada arquivo enviado:
Nome do arquivo enviado.
Quantidade de linhas lidas do arquivo.
Quantidade de números adicionados.
Quantidade de linhas ignoradas, porque o número era inválido ou estava duplicado.
Até 10 dos números inválidos encontrados no arquivo, para ajudar você a encontrar o 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'Resposta
200 OK
[
{
"fileName": "campaign-numbers.csv",
"totalNumbers": 5000,
"numbersAdded": 4997,
"numbersSkipped": 3,
"firstInvalidNumbers": [
"55A0012",
"12"
]
}
]
