Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Tópicos:

Índice

1- URL base API

AmbientesURL
Produçãohttps://api.mosia.chat

2- Endpoint

EndpointMétodoDescrição
v1/call/<protocolo_chamado>/messages

GET

Método que retorna mensagens de uma chamado.

3- Autenticação

KeyValueDescrição
Authorization

<TOKEN_API_MOSIA>

Token de autenticação pode ser encontrado na página de configuração de integração com CRM no painel administrativo.

4- Retorno de mensagens de um chamado com sucesso (200)

Bloco de código
languagejs
themeMidnight
titleRetorno API sucesso
linenumberstrue
[
    {
        "data": {
            "protocol": "220190329100001",
            "subtype": "protocol",
            "message": "Para este atendimento foi gerado o número de protocolo nº <numero_protocolo>"
        },
        "origin": "system",
        "created_at": 1553879672405,
        "from": "MENSAGEM AUTOMATICA",
        "type": "automessage",
        "timestamp": 1553879672559.75
    },
    {
        "data": {
            "message": "Olá, meu nome é  Rafael S. Mobile! Como posso ajudá-lo?"
        },
        "origin": "agent",
        "created_at": 1553879672409,
        "from": "Antônio Silva",
        "type": "message",
        "timestamp": 1553879672559.75
    },
    {
        "data": {
            "message": "Olá!"
        },
        "origin": "caller",
        "created_at": 1553879829094,
        "from": "Michel Alves",
        "type": "message",
        "timestamp": 1553879829104.75
    },
    {
        "data": {
            "message": "Tudo bom?"
        },
        "origin": "caller",
        "created_at": 1553879845818,
        "from": "Michel Alves",
        "type": "message",
        "timestamp": 1553879845819.75
    },
    {
        "data": {
            "message": "Tudo bom!"
        },
        "origin": "agent",
        "created_at": 1553879851693,
        "from": "Antônio Silva",
        "type": "message",
        "timestamp": 1553879851839.75
    },
    {
        "data": {
            "message": "Este é um atendimento de teste para integração "
        },
        "origin": "agent",
        "created_at": 1553879870463,
        "from": "Antônio Silva",
        "type": "message",
        "timestamp": 1553879870615.75
    },
    {
        "origin": "system",
        "type": "automessage",
        "from": "MENSAGEM AUTOMATICA",
        "timestamp": 1553879903272.75,
        "data": {
            "subtype": "default",
            "title": "Solicitação de Encerramento",
            "message": "Solicitação de encerramento enviada. Aguardando resposta do chamador."
        }
    },
    {
        "origin": "system",
        "type": "automessage",
        "from": "MENSAGEM AUTOMATICA",
        "timestamp": 1553879905261.75,
        "data": {
            "subtype": "default",
            "title": "Resposta ao pedido de encerramento",
            "message": "O chamador aceitou o pedido de encerramento. Chamado encerrado"
        }
    }
]
4

5- Erro ao consultar mensagens um chamado (400)

Bloco de código
languagejs
themeMidnight
titleRetorno API falha
linenumberstrue
{
    "message": "Nenhum resultado encontrado ou parâmetros inválidos."
}