# Envio de HSM

## **Introdução**

Você pode encontrar sua lista de Templates HSM indo em **Configurações / Canal / Templates HSM**. Em seguida você terá a listagem dos modelos que você possue, mas lembre-se que para visualizar o exemplo de payload é necessário que seu módulo **API** ou **Notificação** esteja habilitado e essa funcionalidade está disponível apenas para canais oficiais.

Abaixo mostraremos como criar seus templates e seus pontos importantes de preenchimento.

![Visualização de exemplo de payload](https://2130626743-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLX8gSmkCb1jTa2VFMTkP%2Fuploads%2FMWY7EB020mjwtm0R51YV%2Fplayload.png?alt=media\&token=b2452bc1-2383-4bcf-9804-b6c67ea10376)

### Criando template <a href="#criando-template" id="criando-template"></a>

Para criar um novo clique em **Adicionar template.**&#x4C;istagem de templatesEm seguida você verá esta tela.Tela de criação

![](https://2288038409-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk8cXYAlw1NwOtztN7K%2Fuploads%2Fq4MoRGt6czlIvX62XEkw%2Fimage.png?alt=media\&token=3280052d-a60b-4526-8ed9-ea03f5e00c5d)

![](https://2288038409-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk8cXYAlw1NwOtztN7K%2Fuploads%2FOGWWiwtV1NK1OgPePZWn%2Fimage.png?alt=media\&token=64dd9240-fe4e-4b12-bd34-0fe653d0e758)

### ​✉Blocos das Mensagem <a href="#blocos-das-mensagem" id="blocos-das-mensagem"></a>

As mensagens **HSM** são compostas por campos importantes(**Cabeçalho, Corpo, Rodapé e botões**), onde cada um possui características de preenchimento único. Atente-se para evitar futuros imprevistos.

#### Cabeçalho <a href="#cabecalho" id="cabecalho"></a>

Seu cabeçalho pode ser do tipo **texto**, **imagem**, **vídeo** ou **documento**. Lembre-se que para inserir variável e texto é somente possível quando o tipo do cabeçalho for texto.Cabeçalho do template

![](https://2288038409-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk8cXYAlw1NwOtztN7K%2Fuploads%2F6mXYupkutwScPMijfNI7%2Fimage.png?alt=media\&token=0187e4a7-5e4a-4671-9c2c-e804717a4414)

#### Corpo <a href="#corpo" id="corpo"></a>

O corpo de seu template é composto por texto livre e com 4 variáveis. Não se esqueça de deixar sua mensagem principal nessa seção 😉.Corpo do template

![](https://2288038409-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk8cXYAlw1NwOtztN7K%2Fuploads%2Faz69DofX1V2L1JDtckl7%2Fimage.png?alt=media\&token=794ae1ce-c1d7-4da1-bde5-17f0a7be3658)

#### Rodapé <a href="#rodape" id="rodape"></a>

O rodapé de seu template é simples, ele é composto apenas por texto livre.Rodapé do template

![](https://2288038409-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk8cXYAlw1NwOtztN7K%2Fuploads%2F7vXVP4r91DL9YE6nhOcq%2Fimage.png?alt=media\&token=965572ef-f13b-486d-8f96-64989b737f96)

#### Botões <a href="#botoes" id="botoes"></a>

A seção de botões é composta por dois tipos: **Call to action** e **Resposta rápida**.**Call to action**O tipo **Call to action** te permite inserir até dois botões, um **botão de telefone** com apenas texto livre e um **botão de url** com texto livre e uma variável.Call to action**Resposta rápida**O tipo **Resposta rápida** te permite inserir até três botões, ambos com texto livre e sem a possibilidade de inserir variáveis.Resposta rápida

![](https://2288038409-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk8cXYAlw1NwOtztN7K%2Fuploads%2Fd1P9lK3uKnRw8iRP7WxV%2Fimage.png?alt=media\&token=5efa987a-de50-40a5-b0ea-2bd7639357de)

![](https://2288038409-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Mk8cXYAlw1NwOtztN7K%2Fuploads%2FcDoyzCcixhUBsbd6e28V%2Fimage.png?alt=media\&token=2305f714-2727-445f-9bd4-5501db5dd5c9)

## Send HSM API

<mark style="color:green;">`POST`</mark> `https://{SUBDOMAIN}.brpex.com/api/v1 /send-hsm`

Utilize esse método sempre que quiser enviar uma mensagem contendo um texto simples via WhatsApp  para um determinado contato.

#### Headers

| Name    | Type   | Description                                     |
| ------- | ------ | ----------------------------------------------- |
| token\* | String | As tokens são geradas na configuração do canal. |

#### Request Body

| Name    | Type   | Description                                                                   |
| ------- | ------ | ----------------------------------------------------------------------------- |
| text\*  | String | O texto que deseja enviar                                                     |
| phone\* | String | Número no formato internacional (DDI + DDD + Número). Exemplo: 5511988887777. |

{% tabs %}
{% tab title="200: OK Mensagem recebida para fila de envios." %}

```javascript
{
  "message": "success"
}
```

{% endtab %}

{% tab title="401: Unauthorized Erro de autenticação. Verifique o token informado" %}

```javascript
{
"message": "unauthorized" 
}
```

{% endtab %}

{% tab title="422: Unprocessable Entity Informações insuficientes. Você precisa enviar todos os dados obrigatórios" %}

```javascript
{
    // Response
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://brpex.gitbook.io/brpex-crm/notificacao-api/envio-de-hsm.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
