Enviar números da lista de contatos a partir de um arquivo CSV

POST/v1/accounts/{accountId}/contactLists/{contactListId}/numbers/upload

Adiciona a uma lista de contatos os números de um arquivo CSV (valores separados por vírgula), com os valores das suas variáveis. 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. Um número com os mesmos valores de variáveis de um número existente também é ignorado. 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.

Os primeiros números adicionados à lista de contatos definem suas variáveis. Os envios posteriores devem ter a mesma quantidade de colunas de variáveis, e se varNames for incluído, os nomes devem coincidir com os existentes.

Parâmetros de caminho

accountIduuidObrigatório

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

contactListIduuidObrigatório

ID da lista de contatos.

Parâmetros de query string

firstRowIsHeaderbooleanObrigatório

Indica se a primeira linha do arquivo contém os nomes das colunas, e deve ser ignorada.

varCountintegerObrigatório

Quantidade de colunas de variáveis após a coluna do número, entre 0 e 20.

varNamesJSON array of strings

Nomes das colunas de variáveis, em ordem, como ["Customer Name","Due Balance"]. Quando incluído, deve conter varCount nomes.

encodingstring

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. É possível enviar vários arquivos na mesma solicitação.

Retorna

Retorna um array com um resultado para cada arquivo enviado:

fileNamestring

Nome do arquivo enviado.

totalNumbersinteger

Quantidade de linhas lidas do arquivo.

numbersAddedinteger

Quantidade de números adicionados.

numbersSkippedinteger

Quantidade de linhas ignoradas, porque o número era inválido ou estava duplicado.

firstInvalidNumbersarray of strings

Até 10 dos números inválidos encontrados no arquivo, para ajudar você a encontrar o problema.

POST

/v1/accounts/ACCOUNT_ID/contactLists/CONTACT_LIST_ID/numbers/upload

curl -X POST 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/contactLists/CONTACT_LIST_ID/numbers/upload?firstRowIsHeader=true&varCount=2&varNames=%5B%22Customer%20Name%22%2C%22Due%20Balance%22%5D' \ -H 'Authorization: Bearer API_KEY_TOKEN' \ -F 'file=@contact-list-numbers.csv;type=text/csv'

Resposta

200 OK

[ { "fileName": "contact-list-numbers.csv", "totalNumbers": 1255, "numbersAdded": 1254, "numbersSkipped": 1, "firstInvalidNumbers": [ "55A0012" ] } ]


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