Enviar Mensagem
| ENDPOINT | /v1/Ativo | ||
| METHOD | POST | ||
| PARAMETERS | TYPE | DEMANDED | NOTES |
| CampaignId | int | opcional | |
| CarteiraId | int | Obrigatório | Id da carteira Link2go |
| WalletCode | string | Opcinal | Poder ser enviado walletCode ou carteiraId, codigo externo da carteira |
| MessageText | string | Obrigatório | No caso de envio de mensagens ativas pelo Whatsapp Oficial onde é enviado o código de template, enviar aqui o modelo da mensagem. |
| AddicionalData | json | Opcional | |
| ClientPhone (1) |
string | Obrigatório | |
| ClientDocument | string | Opcional | Informar CPF/CNPJ do cliente Esse campo se torna obrigatório caso a carteira esteja configurada como CPF/CNPJ obrigatório |
| ExternalId | string | Opcional | Informar um código do cliente utilizado no sistema do contratante. Será retornado em Webhook. (máximo de 64 caracteres). |
| SourceId | int | opcional |
Active = 1(default), Client = 2, Chat = 3, Mailing = 4, Bot = 6 OBS: usar 1 por padrão. Para demais tipos, entrar em contato com o suporte. |
| Expires | date | Opcional | formato mm-dd-yyyy hh:mm:ss |
| ClientId | string | Opcional | Pode ser usado o id do cliente, nesse caso não há necessidade de enviar o telefone |
| Schedule | date | Opcional | formato mm-dd-yyyy hh:mm:ss |
| SpecialistCode | int | Opcional | Id do especialista para onde direcionar o atendimento, caso se deseje usar "fidelização prévia". |
| UserIds | int | Opcional |
Utilizar este no lugar do SpecialistCode, caso se deseje informar uma lista de possíveis usuários atribuídos. Neste caso, aplica-se a "fidelização por demanda", ou seja, ocorrerá apenas se o cliente responder à demanda. formato: Ids separados por virgula.... "10,20,30" |
| LoyaltyHours | int | Opcional | Informar o tempo máximo para o qual o atendimento será atribuído ao especialista informado acima caso: - para fidelização prévia: este não realize o atendimento. - OBS: se não informado, ou informado 0 (zero): será considerado o tempo normal de retirada da fila da carteira. - para fidelização por demanda: um dos usuários não "puxe" o caso da fila de atendimento. - OBS: (1) se informado um valor maior que zero, este será o tempo máximo para esperar por um especialista dentre os informados buscar esse cliente da fila. Após este intervalo qualquer especialista poderá buscar da fila. (2) se não informado: será considerado o tempo de fidelização por demanda da carteira. (3) se informado 0 (zero): ocorrerá a fidelização automática ao usuário que estiver online dentre os informados, para o que tiver menos atendimentos. Se não houver nenhum online, será liberado para atendimento por qualquer usuário que puxar da fila. |
| ChannelCode |
string | Opcional | Informar "WHATSAPP_BUSINESS" para envio via Whatsapp Oficial |
| ProviderCode |
string | Opcional | Informar "DIALOG_WHATSAPP" para envio via Whatsapp Oficial (somente no envio ativo - SourceId = 1 ou 4) |
| TemplateCode |
string | Opcional | Código do template a ser utilizado no envio de mensagem ativa via Whatsapp Oficial |
| Variables |
string | Opcional | Envio obrigatório no caso do template utilizar variáveis. Enviar um array json de objetos com as propriedades name e value em formato string. Exemplo: "[{\"name\":\"customerName\",\"value\":\"Maria\"},{\"name\":\"customerName\",\"value\":\"João\"}]" |
| RETURN | TYPE | DEMANDED | NOTES |
| success | bool | ||
| message | string | ||
| data | json |
|
|
IDENTIFICAÇÃO DO CLIENTE
Para identificar um cliente, é possível enviar apenas um dentre:
ClientPhone: string - que contenha o DDI (55 - para o Brasil), DDD e TELEFONE.
ClientId: int - que seja um cliente previamente criado na carteira. (corresponde univocamente a um telefone - se informado junto com o telefone, será priorizado o telefone).
SEND - EXAMPLE
{
"CampaignId": 999,
"ClientPhone": "5519999999999",
"CarteiraId":999,
"MessageText":"Message text : sample [Parameter1] , [Parameter2].",
"Variables":"[{\"name\":\"{{Nome}}\",\"value\":\"João\"}, {\"name\":\"{{Idade}}\",\"value\":\"25\"}]",
"SourceId":1,
"Expires":"01-30-2023 10:58:22",
"Schedule":"01-28-2023 10:58:22",
"ChannelCode":"WHATSAPP_BUSINESS",
"TemplateCode": "NOME_TEMPLATE",
"ProviderCode":"DIALOG_WHATSAPP"
}RECEIVE EXAMPLE
{
"success": true,
"message": "Ativo enviado para processamento!",
"data":
{
"activeId": 99999999,
"walletId": 999,
"clientId": 99999999,
"status": "em processamento",
}
}RECEIVE EXAMPLE
{
"success": false,
"message": "Carteira é obrigatório"
}