Envio de SMS pelo HubSpot
API de integração SMS para utilização com a plataforma HubSpot.
Para utilização da API, utilize a funcionalidade de WebHook:
URL do Webhook https://sms.nexuscomunicacao.com/api/lib/hubspot_send_sms.aspx?api_key=CHAVE_API&template=ID_TEMPLATE
Método POST
Entrada JSON com os dados do contato (enviado pelo WebHook cadastrado no HubSpot)
Retorno JSON com resultado do agendamento do envio
| Parâmetro | Descrição |
|---|---|
| api_key | A chave de API encontra-se no menu SMS > Configurações SMS. |
| template | ID do template cadastrado na plataforma (Menu SMS > Templates SMS). |
| rota | [Opcional] Se não informado utiliza a rota padrão |
| numero | [Opcional] Se não informado utiliza o parâmetro mobilephone enviado pelo HubSpot |
Exemplo de Saída:
{
"Resultado": {
"CodigoResultado": 0,
"Mensagem": "Mensagem processada com sucesso. Processado em 177ms.",
"Chave": "154d1c4d-2836-4913-10f8-084b20f3e9ze",
"Cobrado": true,
"ValorCobrado": 0.20
},
"Mensagens": [
{
"numero": "+5511987654321",
"mensagem": "mensagem de teste 1",
"UniqueID": "31b2c48f-2ea9-4979-a9dd-cbfb927de18f",
"DataAgendamento": "2020-07-26 14:35:08",
"Custo": 0.2000,
"idDisparo": 25,
"Situacao": 1,
"MensagemSituacao": null,
"Codigo_cliente": "0000001",
"Rota": 228
}
],
"Saldo": 3220.6300
}
Templates
Para cadastrar templates SMS, acesse o menu SMS > Templates SMS. Utilize o campo Web ID nas chamadas do HubSpot.
Variáveis
Você pode utilizar as variáveis fornecidas pelo HubSpot nas suas mensagens, como: $firstname$, $lastname$, $email$, $state$, entre outras. Para ter acesso à lista completa de variáveis, faça um teste do WebHook no próprio HubSpot para analisar as váriaveis enviadas no POST:
