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

Endpoint:

POST https://outbound.ms.altubots.com/rcs/<slug>/<id_integracao>

Header:

• Authorization: <token_gerado_ao_habilitar_a_api>

Body template:

{
    "destination": "[phone]",
    "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

Status 200 (OK - Mensagem enviada)

Body (exemplo):

{
    "external_id": "1c43e910-235f-11eb-b4a5-8fa49633e957",
    "message": {
        "name": "phones/[phone]/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)

Body (exemplo):

{
    "message": "Invalid integration id"
}

Status 404 (Número inválido)

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.