> For the complete documentation index, see [llms.txt](https://docs.uniqmobile.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.uniqmobile.com.br/master.md).

# Introdução

## Introdução API Rest

Bem-vindo(a)! A API da Uniq Mobile é construída no Padrão REST. Com ela, é possível enviar mensagens direto do seu sistema e pegar o status de envio dos SMSs através de consultas. Ela aceita os métodos POST (Para envios - Instantâneo e agendado), com parâmetros em JSON e GET (Para relatórios - Mensagens Enviadas, Recebidas, Consulta de Saldo), com a passagem de parâmetros via query string.

Nesse contexto, nossa API possui URLs de acordo com cada endpoint e também usa códigos de resposta HTTP padrão. A autenticação é feita via Header e todas as requisições também devem conter ‘Content-Type’: 'application/json’.

## Pontos Importantes

| Nome              | Descrição                                                                                                                                                                                             |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| SMS - MT          | Mensagem de Texto enviada.                                                                                                                                                                            |
| SMS - MO          | Mensagem de Texto (Resposta) recebida a mensagem que foi enviada.                                                                                                                                     |
| Área de Cobertura | Área geográfica em que um aparelho celular pode ser atendido pelo equipamento de rádio de uma estação de rádio base de uma operadora.                                                                 |
| Zona de Sombra    | Áreas dentro de uma área de cobertura que apresentam baixo ou nenhum sinal devido à presença de obstáculos que afetam a comunicação entre o aparelho celular e a antena, como construções e montanhas |

{% hint style="warning" %}

## **Importante:**

**Caso o destinatário esteja com o aparelho celular desligado ou fora da área de cobertura, a mensagem de texto não será enviada, ficando armazenada na operadora, disponível para ser enviada caso o aparelho celular seja ligado dentro da área de cobertura, dentro de um determinado período de tempo que varia de operadora para operadora, sendo que, após este período, a mensagem não será enviada.**
{% endhint %}

## URL Base da API

 `https://message.uniqmobile.com.br/api/sms`