> For the complete documentation index, see [llms.txt](https://docs.altu.d1.cx/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.altu.d1.cx/connect/apis/outbound/rcs.md).

# Outbound RCS

Ao habilitar a API de outbound, é gerado um **endpoint** e um **token**, que serão utilizados para realizar o envio das mensagens de outbound.

## Request <a href="#a537e334-fd72-4c36-9623-94213e86759b" id="a537e334-fd72-4c36-9623-94213e86759b"></a>

**Endpoint**:&#x20;

**POST** <https://outbound.ms.altubots.com/rcs/>\<slug>/\<id\_integracao>

**Header**:

* Authorization: **`<token_gerado_ao_habilitar_a_api>`**

**Body template**:

```
{
    "destination": "+5599999999999",
    "context": {
        "status": "aprovado"
    },
    "hsmToBeSent": {
        "contentMessage": {
            "text": "Olá! Essa é uma mensagem de outbound"
        }
    },
    "restartContact": false
}
```

**Atributos**:

* **destination (obrigatório)**: número que irá receber a mensagem (importante incluir o +55 e o DDD)
* **context (opcional)**: variáveis que serão salvas no contexto do usuário
* **text (obrigatório)**: mensagem que será enviada para o número
* **restartContact (opcional)**: boleano para resetar as variáveis de contexto do usuário

## Response <a href="#id-88be1aa8-e3e3-479c-9fe0-7f7bbf2dcda8" id="id-88be1aa8-e3e3-479c-9fe0-7f7bbf2dcda8"></a>

### Status 200 (OK - Mensagem enviada) <a href="#id-50c04e6b-0867-4055-8e94-bed55c76600d" id="id-50c04e6b-0867-4055-8e94-bed55c76600d"></a>

**Body (exemplo):**

```
{
    "external_id": "1c43e910-235f-11eb-b4a5-8fa49633e957",
    "message": {
        "name": "phones/+5599999999999/agentMessages/1c43e910-235f-11eb-b4a5-8fa49633e957",
        "sendTime": "2020-11-10T14:14:59.813Z",
        "contentMessage": {
            "text": "Olá! Essa é uma mensagem de outbound"
        }
    }
}
```

* **external\_id**: id único da mensagem de outbound
* **message**: é a resposta de sucesso da api do RCS.
  * **name**: url de envio
  * **sendTime**: data e hora do envio
  * **text**: mensagem enviada

### Status 404 (Integração inválida) <a href="#d479b947-c999-4f74-a6b0-8ee496a8deba" id="d479b947-c999-4f74-a6b0-8ee496a8deba"></a>

**Body (exemplo):**

```
{
    "message": "Invalid integration id"
}
```

### Status 404 (Número inválido) <a href="#c11ad2ae-312e-4a5f-b7af-27d8b94ea1f1" id="c11ad2ae-312e-4a5f-b7af-27d8b94ea1f1"></a>

**Body (exemplo):**

```
{
    "message": "Invalid destination!"
}
```

O campo **destination** no body pode está errado. Verificar se está com '+55' e se é um número que existe e é válido.