Pular para o conteúdo principal

Adicionando números de telefone à campanha

O método Calls API a seguir é usado para adicionar números de telefone com parâmetros à campanha:

POST https://ds.tovie.ai/api/calls/campaign/{token}/addPhones

Corpo da solicitação​

O corpo das solicitações para este método contém uma matriz de objetos que definem os números de telefone adicionados à campanha, bem como a política de chamadas para cada número. Cada objeto pode ter os seguintes campos.

CampoDescriçãoExemplo
phoneNúmero de telefone do cliente.
Campo obrigatório.		"551123456780"
payloadDados arbitrários a serem aprovados no script.
Campo opcional.		{"promo": "20% de desconto em todos os planos de negócios do Tovie DialogStudio!"}
startDateTimeData inicial da chamada. A chamada será feita no intervalo entre startDateTime e finishDateTime.
Campo opcional.		"2020-03-23T00:00:00Z"
finishDateTimeData final da chamada. Após finishDateTime, nenhuma chamada será feita.
Campo opcional.		"2020-03-23T00:00:00Z"
allowedDaysDias da semana em que as chamadas são permitidas.
Campo opcional.		["mon", wed", "fri"]
allowedTimeIntervalos de tempo em que as chamadas são permitidas para cada dia da semana.
Campo opcional.		"default": [{"localTimeFrom": "10:00", "localTimeTo": "11:30"}]
retryIntervalInMinutesA pausa entre as tentativas de retorno de chamada, em minutos.
Campo opcional.		120
maxAttemptsO número total de tentativas de retorno de chamada.
Campo opcional.		1
gmtZoneFuso horário do cliente.
Campo opcional.		"-03:00"

Tempo de chamada permitido​

allowedDays​

O campo allowedDays configura os dias da semana em que as chamadas podem ocorrer. O valor do campo é uma matriz com as seguintes strings permitidas: "mon", "tue", "wed", "thu", "fri", "sat", "sun".

cuidado
Quando allowedDays é especificado, é somente durante esses dias que as chamadas são possíveis. Quaisquer configurações de allowedTime para outros dias da semana são ignoradas.

allowedTime​

No campo allowedTime, todos os dias da semana são mapeados para um ou vários intervalos de tempo quando as chamadas para o número de telefone forem permitidas.

Este campo contém um objeto com chaves iguais aos nomes dos dias da semana do campo allowedDays, bem como uma chave default. Os valores para cada chave devem ser matrizes de objetos com campos aninhados localTimeFrom e localTimeTo, correspondentes aos limites de intervalo de tempo permitidos.

dica
O formato de hora é HH:mm. A hora é relativa, portanto, a hora local do cliente é levada em consideração.

As chamadas efetuadas em dias úteis não especificados no corpo da solicitação serão efetuadas de acordo com as configurações fornecidas no valor default.

localTimeFrom e localTimeTo​

Existem algumas restrições nos campos localTimeFrom e localTimeTo:

  • Cada intervalo deve conter tanto o limite superior quanto o inferior. Ocorre um erro de solicitação quando um deles está ausente.
  • Os intervalos de tempo não devem se sobrepor, ou seja, o limite superior de um não deve ser maior que o limite inferior do outro. Situações como essa também produzem erros de solicitação.

Fuso horário do cliente​

O valor gmtZone deve estar em conformidade com um dos seguintes formatos:

  • Z para o horário UTC.
  • +h, +hh, ±hhmm ou ±hhmmss com vários elementos opcionais:
    • um separador : entre horas, minutos e segundos, por exemplo +hh:mm:ss;
    • um prefixo UTC, GMT ou UT, por exemplo GMT-hh:mm.
  • Um dos IDs de fuso horário conforme especificado pela IANA TZDB.

Exemplo de solicitação​

curl --request POST 'https://ds.tovie.ai/api/calls/campaign/8231.7056.1b131df1/addPhones' \
--header 'Content-Type: application/json' \
--data-raw '[
  {
    "phone": 551123456780,
    "payload": {
      "name": "Margarida",
      "age": 34
    },
    "allowedTime": {
      "mon": [
        {
          "localTimeFrom": "10:00",
          "localTimeTo": "11:30"
        },
        {
          "localTimeFrom": "13:00",
          "localTimeTo": "14:30"
        }
      ],
      "default": [
        {
          "localTimeFrom": "10:00",
          "localTimeTo": "18:00"
        }
      ]
    },
    "retryIntervalInMinutes": 120,
    "maxAttempts": 0,
    "gmtZone": "-03:00"
  }
]'

A resposta a essa solicitação será uma matriz de todos os IDs de trabalho de chamada criados.