Adicionar números
/v1/accounts/{accountId}/campaigns/{campaignId}/numbersAdiciona um ou mais números a uma campanha, com os valores das suas variáveis.
É 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
Nomes das variáveis cujos valores são enviados em varValues, na mesma ordem, como ["Customer Name","Due Balance"]. Cada nome deve começar com uma letra, e conter somente letras, dígitos, espaços e sublinhados, com até 255 caracteres.
Os primeiros números adicionados à campanha definem os nomes das suas variáveis: se varNames for omitido nesse momento, elas recebem os nomes Var1, Var2, e assim por diante. As solicitações posteriores devem enviar a mesma quantidade de valores de variáveis, e se varNames for incluído, os nomes devem coincidir com os existentes.
Corpo da solicitação
Um array JSON de objetos, um para cada número a adicionar. Um único objeto também é aceito.
Número de telefone para o qual ligar. Separadores como espaços, hifens, pontos e parênteses são permitidos e removidos, por exemplo +1 (555) 123-9000. O número deve conter entre 3 e 50 dígitos, e pode terminar com p seguido de dígitos DTMF a discar depois que a chamada for atendida, como +15551239000p123. É possível especificar até 15 números para o mesmo contato, separados por ponto e vírgula (;).
Valores das variáveis para este número, usados para personalizar as mensagens do fluxo de chamada ou a conversa do agente de IA. Todos os números da solicitação devem ter a mesma quantidade de valores, correspondente às variáveis da campanha. O padrão é um array vazio.
Retorna
Retorna um array com os objetos número de campanha adicionados. As duplicatas ignoradas não são incluídas, portanto o array fica vazio se todos os números estavam duplicados.
/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers
curl -X POST 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns/CAMPAIGN_ID/numbers?varNames=%5B%22Customer%20Name%22%2C%22Due%20Balance%22%5D' \
-H 'Authorization: Bearer API_KEY_TOKEN' \
-H 'Content-Type: application/json' \
-d '[
{
"number": "+18005551234",
"varValues": [
"John Carter",
"$199.00"
]
},
{
"number": "+18005551235",
"varValues": [
"Jane Miller",
"$449.50"
]
}
]'Resposta
200 OK
[
{
"id": 1048201,
"number": "+18005551234",
"varValues": [
"John Carter",
"$199.00"
],
"addedAtLocal": "2026-10-02T11:24:05.310",
"attempts": 0,
"status": "NotContacted"
},
{
"id": 1048202,
"number": "+18005551235",
"varValues": [
"Jane Miller",
"$449.50"
],
"addedAtLocal": "2026-10-02T11:24:05.310",
"attempts": 0,
"status": "NotContacted"
}
]
