> 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-sucesso.md).

# Envio de SMS com sucesso

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.

### 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 um envio com sucesso baseado no retorno HTTP 200 OK.

### Descrição

No ambiente de execução deste cenário, os envios de SMS são realizados por uma API externa a qual retorna um 200 OK sempre que o envio resulta em sucesso.

## Requisição

As definições relacionadas à requisição HTTP de envio são:

<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: 203040"
}
</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

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>

## 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 da API é um 200 OK como sucesso no envio. Qualquer coisa diferente disso será considerado como falha no envio.&#x20;

Dado o cenário 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 da API de SMS</td><td>retorno do tipo <strong>código HTTP</strong> que resulta SUCESSO quando o código é 200.</td></tr><tr><td>Retorno padrão</td><td>resulta FALHA</td></tr></tbody></table>

A configuração dos retornos descritos na tabela estão detalhados abaixo:

#### Retorno da API de SMS

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

| Campo    | Valor       |
| -------- | ----------- |
| Tipo     | Código HTTP |
| Valor    | 200         |
| Status   | Sucesso     |
| Situação | OK          |

Na configuração desse retorno, 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 no retorno anterior será dado como FALHA.
{% endhint %}