> 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-falha-de-timeout.md).

# Envio de SMS com falha de timeout

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 uma falha de ***timeout*** (tempo esgotado) da requisição acontece.

### 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 capturar o comportamento de falha de **tempo esgotado** da requisição.

### Descrição

No ambiente de execução deste cenário, ocorrem alguns erros de envios de SMS para alguns provedores devido à falhas de tempo esgotado, ou seja, timeout da requisição.

## 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 de sucesso como a resposta de falha de *timeout* da requisição.

### Resposta de envio 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 de falha de *timeout* da requisição

A falha de timeout, ou tempo esgotado da requisição, acontece quando uma requisição HTTP enviada não retorna no tempo de espera máxima configurado para o retorno HTTP.&#x20;

{% hint style="info" %}

#### Nota

Independente da resposta HTTP, quando o tempo máxima do retorno (***timeout***) é atingido, a API de envio das mensagens HTTP, vai gerar uma **exceção** do tipo SocketTimeoutException. &#x20;
{% endhint %}

## 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 é um 200 OK com sucesso no envio. Além disso deve evidenciar as falhas de ***timeout*** da requisição.

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="271">Retorno</th><th>Descrição</th></tr></thead><tbody><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 vai casar com a definição do retorno de envio da API e será definido como SUCESSO.&#x20;

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

#### Retorno com timeout

Uma falha de ***timeout*** da requisição vai gerar internamente e **automaticamente** uma exceção independente do conteúdo do retorno HTTP.

Esse timeout depende do tempo de espera máximo do retorno definido para as requisições HTTP.

{% hint style="info" %}

#### Nota

Esse tempo de espera máxima do retorno **não é configurável** no Blazon.&#x20;

No caso dos **provedores de SMS** configurados no Blazon, o tempo máximo de espera está definido internamente como 3000 (três mil) milisegundos, ou seja **3 (três) segundos**.

Portanto **nenhuma configuração** adicional será necessária no provedor de SMS.
{% endhint %}

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

#### 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>Sucesso no envio</td></tr></tbody></table>

Observa-se que a configuração verifica apenas o código de retorno, se ele é 200 será detectado como 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 %}