📳SMS
Envie SMS através da Hyperflow
A Hyperflow disponibiliza em sua plataforma, o envio de SMS. Diferente dos outros canais, o SMS é utilizado apenas para envio, e não ativa um fluxo na resposta do usuário.
Todo SMS enviado pela Hyperflow é do formato OTP transacional, ou seja, é um SMS que possui uma entrega prioritária se comparado com um SMS normal, ou SMS marketing.
Saldo para disparo
Ao disparar um SMS, o valor será descontado da sua carteira Hyperflow, que pode ser consultada na tela "Gerenciar créditos" da sua organização. A carteira funciona de forma pré-paga. Basta fazer uma recarga via pix ou cartão de crédito para utilizar o SMS.
Para ver mais informações sobre a recarga, veja este vídeo curto: https://www.youtube.com/watch?v=hvljlbLnUtQ&list=PLyG28GgXFuLmbhfq0i4hMPDd3AC7xHzoE&index=4
Criando a sua chave de API
Para realizar o disparo de SMS, é necessário primeiro criar uma chave de API, que será utilizada para chamar a requisição que faz o envio.
Entre no menu "SMS", e em seguida clique em "Chaves" no canto superior direito.
Nesta tela, você poderá consultar e gerenciar todas as chaves de API criadas. Para criar a sua primeira chave, basta clicar no botão "+ Chave de API"
Ao clicar para criar uma chave de API, insira um nome para a sua chave, e clique em "Criar". Em seguida, você receberá a sua chave de API.
Por razões de segurança, você não poderá ver esta chave novamente. Se você perder esta chave, você precisará gerar uma nova. Salve esta chave em algum lugar seguro e acessível.
Realizando o disparo de um SMS
Agora que temos saldo carteira Hyperflow, e uma chave de API criada, nós podemos realizar o disparo do nosso primeiro SMS.
Caso a sua mensagem contenha algum tipo de link, será necessário primeiro "aprovar" o link junto as operadoras. Caso contrário, a sua mensagem não será entregue!
Isso é uma forma de combater golpes e envio de spam. Para solicitar aprovação de um link, entre em contato com o suporte da Hyperflow.
Enviar SMS para um destinatário
POST https://runtime.hyperflowapis.global/sms
Use este método para enviar um SMS para um destinatário.
Importante: Caso você envie um texto com mais de 160 caracteres, será enviada 2 mensagens, uma vez que o limite por SMS é de 160 caracteres.
Headers
| Name | Type | Description |
|---|---|---|
access_token* | String | Insira aqui a sua chave de API criada no passo anterior |
Request Body
| Name | Type | Description |
|---|---|---|
to* | String | Telefone que será enviado o SMS. Atualmente é suportado apenas para números brasileiros, e não é necessário incluir o código de país. |
text* | String | Texto a ser enviado no SMS. Caso passe de 160 caracteres, será enviado 2 SMS's para o destinatário. |
Ao enviar o SMS com sucesso, você receberá um status 200 OK, com o seguinte body de resposta. O parâmetro messages será o array de todas as mensagens enviadas. (Caso ultrapasse 160 caracteres, será enviada 2 mensagens para o destinatário, e ai você receberá 2 itens no array "messages")
Se preferir, copie o curl abaixo 👇
Pronto! Agora basta verificar o seu celular, para ver a mensagem entregue ✅
Acompanhando o resultado dos disparos
Agora que você já realizou o seu disparo, você pode acompanhar pelo portal da Hyperflow o resultados dos seus disparos.
Nesta tela é possível filtrar por data, e você receberá uma visão consolidada por chave de API, do status dos envios realizados.
Também é possível realizar uma consulta detalhada, tendo uma resposta exata de cada envio realizado.
Para isso, basta entrar em "Detalhes" e filtrar o período desejado. Você pode baixar um relatório em .csv, clicando no botão "Exportar"
Caso tenha qualquer outra dúvida, favor acionar o nosso suporte.
Last updated
