> For the complete documentation index, see [llms.txt](https://help.blazon.im/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.blazon.im/guias/casos-de-uso/provedores-sms/envio-de-sms-com-retorno-falso-positivo.md).

# Envio de SMS com retorno falso positivo

Nesse caso de uso o envio do SMS é feito e espera-se para cada requisição HTTP um retorno 200 OK como sucesso do envio, porém um *firewall* está bloqueando as requisições e retornando 200 OK. 

### Público alvo deste caso de uso

Analista de IAM, ou qualquer outro profissional que será responsável pela administração do Blazon.

### Objetivo

Esse cenário tem como objetivo descrever como realizar as **configurações adequadas** do provedor de SMS de forma a **evitar falsos positivos** mesmo quando um retorno 200 OK acontece mas não significa sucesso no envio do SMS.

### Descrição

No ambiente de execução deste cenário, entre o Blazon e a API de SMS, existe um **firewall de camada 7** que intercepta as mensagens HTTP de envios de SMS. 

Por configuração esse firewall intercepta e retorna uma página HTML descrevendo um "erro" de **Página bloqueada**, mas com código de retorno **200 OK**. 

Como o firewall **bloqueia** as requisições mas retorna 200 OK, a simples validação do retorno das requisições HTTP com base no código de status 200 vai gerar **falsos positivos**.

## Requisição

Essa seção apresenta na tabela abaixo as definições relacionadas à requisição HTTP para o envio do SMS usando uma API externa.

<table><thead><tr><th width="240">Item</th><th>Valor</th></tr></thead><tbody><tr><td>Método HTTP</td><td>POST</td></tr><tr><td>URL</td><td><pre><code>https://sms.services/api/send-sms.php
</code></pre></td></tr><tr><td>Segurança</td><td>Autenticação HTTP básica</td></tr><tr><td>Cabeçalhos</td><td><ul><li>Accept: application/json</li><li>Content-Type: application/json</li></ul></td></tr><tr><td>Body</td><td><pre><code>{
  "telefone": "34---------",
  "mensagem": "Token de autenticação Blazon: 154567"
}
</code></pre></td></tr></tbody></table>

Com as configurações acima a API envia um SMS para o **telefone** descrito no JSON do *body*, contendo a **mensagem** definida juntamente com o **token** de acesso.

## Resposta

Essa seção apresenta as configurações das respostas HTTP esperadas tanto da API de SMS quanto do firewall quando ele realiza o bloqueio do envio do SMS.

### Resposta da API de SMS

A tabela abaixo descreve as informações de retorno da API de SMS quando o envio ocorre com sucesso.

<table><thead><tr><th width="304">Item</th><th>Descrição</th></tr></thead><tbody><tr><td>HTTP STATUS</td><td>200 OK</td></tr><tr><td>Body</td><td><pre class="language-json"><code class="lang-json">{
    "status": "SUCESSO"
}
</code></pre></td></tr><tr><td>Response-type</td><td>application/json</td></tr></tbody></table>

### Resposta do firewall&#x20;

A tabela abaixo descreve as informações de retorno do firewall quando ele realiza o bloqueio do envio do SMS.

<table><thead><tr><th width="304">Item</th><th>Descrição</th></tr></thead><tbody><tr><td>HTTP STATUS</td><td>200 OK</td></tr><tr><td>Body</td><td><pre class="language-html"><code class="lang-html">&#x3C;!doctype html>
&#x3C;html>
&#x3C;head>
    &#x3C;meta charset="utf-8">
    &#x3C;title>Página Bloqueada!&#x3C;/title>
&#x3C;/head>
&#x3C;body>
    &#x3C;h1>Essa página está bloqueada!&#x3C;/h1>
&#x3C;/body>
</code></pre></td></tr><tr><td>Response-type</td><td>text/html</td></tr></tbody></table>

Nas duas tabelas observa-se que o código HTTP de retorno é 200 com status HTTP OK.&#x20;

Nesse caso se configurarmos o provedor SMS com um retorno validando apenas o código HTTP e o firewall bloquear a mensagem, vai gerar um envio com SUCESSO o que não é verdade.

## Configurações

As configurações descritas nessa seção são referenciadas na documentação do **Administrador** na página [Configurando um provedor de SMS](https://docs.blazon.im/administrador/mais-opcoes/configuracoes-gerais/sms#configurando-um-provedor-sms).&#x20;

### Configurações da Requisição

Todas as configurações são realizadas no detalhamento do provedor na aba **Configurações**:

* O método HTTP e URL são definidos no topo do card da aba de **Configurações**;
* A configuração de Segurança é feita na aba **Segurança** selecionando o tipo "Autenticação HTTP Básica";
* A configuração dos cabeçalhos é feita na aba **Cabeçalhos**, adicionando-se os dois cabeçalhos descritos;
* A configuração do Body é feita na aba **Body**, configurando o *media-type* **application/json** e com o conteúdo:
  * ```
    {
      "telefone": "${[to]}",
      "mensagem": "Token de autenticação Blazon: ${[token]}"
    }
    ```

### Configuração dos Retornos

A configuração dos retornos, feito na aba **Retornos**, deve evidenciar quando o retorno 200 OK é do firewall (falha no envio) e quando o retorno 200 OK é da API (sucesso no envio). Qualquer coisa diferente disso será considerado como falha no envio.&#x20;

Dado o cenário e o fato de que os retornos são avaliados na ordem, sugere-se a seguinte configuração dos **Retornos**:

<table><thead><tr><th width="259">Retorno</th><th>Descrição</th></tr></thead><tbody><tr><td>Retorno do firewall</td><td>retorno quando o código HTTP é 200 e no corpo da resposta tem o texto HTML com o termo "<strong>Página Bloqueada!</strong>". Será considerado como FALHA.</td></tr><tr><td>Retorno da API de SMS</td><td>retorno quando o código HTTP é 200 e não cai no retorno anterior. Será considerado como SUCESSO.</td></tr><tr><td>Retorno padrão</td><td>retorno diferente do que está definido nos retornos anteriores. Será considerado como FALHA.</td></tr></tbody></table>

Analisando os retornos acima, observa-se que qualquer retorno 200 OK que voltar pro Blazon, será antes verificado se é um retorno proveniente do firewall caso que será definido como FALHA.&#x20;

Caso não seja do firewall, o retorno 200 OK vai casar com a definição do retorno da API e será definido como SUCESSO.&#x20;

Qualquer coisa diferente disso vai cair no retorno padrão que será considerado como FALHA.&#x20;

As configurações dos retornos descritos, na tabela acima, estão detalhadas abaixo:

#### Retorno do firewall

Como o retorno do firewall tem que validar um termo "Página Bloqueada!" no corpo da resposta sugere-se a configuração usando um **script** BeanShell.

<table><thead><tr><th width="215">Campo</th><th>Valor</th></tr></thead><tbody><tr><td>Tipo</td><td>Script</td></tr><tr><td>Valor</td><td><pre class="language-java"><code class="lang-java">body = (String) httpResponse.payload;
ehCodigo200 = httpResponse.httpCodeStatus == 200;
ehPaginaDeBloqueio = body.contains("Página Bloqueada!");
return ehCodigo200 &#x26;&#x26; ehPaginaDeBloqueio;
</code></pre></td></tr><tr><td>Status</td><td>Falha</td></tr><tr><td>Situação</td><td>Falha no envio </td></tr></tbody></table>

Observa-se que no script o corpo da mensagem é lido na variável **httpResponse.payload** e o código de retorno é lido na variável **httpResponse.httpCodeStatus**.&#x20;

Caso o corpo contenha o termo "Página Bloqueada!" e o código de retorno seja 200 tem-se o resultado TRUE o que configura um retorno do firewall e portanto seŕa definido como FALHA no envio.

#### Retorno da API de SMS

Como esse retorno tem que validar apenas o código HTTP 200 sugere-se a configuração usando o tipo **Código HTTP** que é mais simples e direta.

<table><thead><tr><th width="215">Campo</th><th>Valor</th></tr></thead><tbody><tr><td>Tipo</td><td>Código HTTP</td></tr><tr><td>Valor</td><td>200</td></tr><tr><td>Status</td><td>Sucesso</td></tr><tr><td>Situação</td><td>OK</td></tr></tbody></table>

Na configuração desse retorno, uma vez que já foi verificado que não é um retorno do firewall devido a ordem de avaliação, basta que seja verificado que o código HTTP de retorno seja igual a 200 o que configura um SUCESSO no envio.

{% hint style="info" %}

#### Nota

A configuração do retorno padrão é intuitiva e basta definir o **status** como **Falha** e definir a **situação** como **Falha no envio do SMS**. &#x20;

Nesse caso qualquer coisa que retornar diferente do que foi configurado nos retornos anteriores será dado como FALHA.
{% endhint %}