📳SMS

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.

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.

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

Request Body

{
    "messages": [
        "527d1da8-7365-424c-9067-0a146d19193d"
    ]
}

Se preferir, copie o curl abaixo 👇

curl --location --request POST 'https://runtime.hyperflowapis.global/sms' \
--header 'Content-Type: application/json' \
--header 'access_token: SEU_API_TOKEN' \
--data-raw '{
    "to": "34999999999",
    "text": "Mensagem teste"
}'

Pronto! Agora basta verificar o seu celular, para ver a mensagem entregue ✅

Enviar SMS para múltiplos destinatários

POST https://runtime.hyperflowapis.global/sms/multiple

Use este método para enviar até 1000 SMS para diferentes usuários de uma única vez. É possível customizar o texto para cada um dos destinatários

Importante: Caso você envie um texto com mais de 160 caracteres, a mensagem será rejeitada, para evitar a cobrança de dois SMS's neste envio.

Headers

Request Body

Exemplo de payload

{
    "messages": [
        {
            "to": "34999999991",
            "text": "Mensagem a ser enviada via SMS."
        },
        {
            "to": "34999999992",
            "text": "Outra mensagem a ser enviada via SMS."
        }
    ]
}

{
    "success": [ //Array contendo as mensagens que foram enviadas.
        {
            "id": 6346686788,
            "to": "34999999991",
            "text": "Mensagem a ser enviada via SMS."
        },
        {
            "id": 6346686789,
            "to": "34999999992",
            "text": "Outra mensagem a ser enviada via SMS."
        }
    ],
    "failed": [] //Array contendo as mensagens que falharam (Número inválido, texto com mais de 160 caracteres, outros...)
}

Se preferir, copie o curl abaixo 👇

curl --location 'https://runtime.hyperflowapis.global/sms/multiple' \
--header 'Content-Type: application/json' \
--header 'access_token: SEU_API_TOKEN' \
--data '{
    "messages": [
        {
            "to": "34999999991",
            "text": "Mensagem a ser enviada via SMS."
        },
        {
            "to": "34999999992",
            "text": "Outra mensagem a ser enviada via SMS."
        }
    ]
}'

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.