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ção

https://api.mosia.chat

2- Endpoint

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

GET

Método consulta informações de um 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.


Dica
titleComo obter seu MOSIA TOKEN

Para obter o TOKEN_API_MOSIA relacionado ao CRM. siga os passos:

  • Acesse a administração do MOSIA, em admin.mosia.chat
  • No menu principal, acesse "Ajustes Gerais" e habilite o CRM;
  • Indique uma URL de CALLBACK e salve as mudanças.
  • Um token será exibido. Este é o token que será utilizado nas integrações destas APIs.

4- Retorno de chamado com sucesso (200)

Bloco de código
languagejs
themeMidnight
titleRetorno API sucesso
linenumberstrue
{
    "call": {
        "status": "Fechado",
   
    "attended_at": <data_atendimento>1608235873740,
        "created_at": <data_criacao>1608235870503,
        "protocol": "<protocolo>99999920201217000004",
        "queue": "<nome_da_fila>Fila Padrão",
  
     "subjects": [
       ],
    {
                "description"topic": "<descricao_do_assunto>"
            }
        ],
 Solicitar posição do Ticket",
      "topicplatform": "<topico>Web",
        "platformrating": "<plataforma_que_foi_realizado_o_atendimento>"[],
        "rating"status_updates": [
     
      {

               "label"name": "completedCriado",
 
              "value"timestamp": "Sim"
     1608235870503
      },

           {
                "label"name": "evaluationEm atendimento",
    
           "valuetimestamp": 4
1608235873740
           },
            {
      
         "labelname": "commentsFechado",
                "value"timestamp": "Comentários sobre o atendimento."
     1608243754669
      }
  
     ],
        "status_updates"annotation": [             {
                "name": "Criado",
     
          "timestamp"medical": 1553879669948
            },
            {
                "name"prescriptions": "Em atendimento",[]
    },
           "timestamp": 1553879672899
            },
            {
      "closing_reason": {
         "nameid": "Fechado34",
   
            "timestamp"description": 1553879905560"Encerramento por desistência."
          }
  
     ]
    },
    "agent": {
		    "name": "<nome_atendente>Ranniêr Reis",
  
     "email": "<email_atendente>rannier@mobilesaude.com.br",
        "phone": "<telefone_atendente>(48) 3220-0949",

       "crm_reference": "<codigo_crm_referencia>"
 
  },

   "caller": {
        "caller_key": "<identificacao_chamador>francisalves@smilesaude.com.br",
        "data": [
            {

               "label": "namephone",
                "value": "<nome_chamador>"
    82996538831"
       },
 
          {
                "label": "emailname",
      
         "value": "<email_chamado>"
   Francis Alves"
        },
      {
     {   "label": "email",
            "labelvalue": "phonefrancisalves@smilesaude.com.br",
      }
    ]
  },
  "valueintegration": "<telefone_chamador>"{
    "id_operadora": null,
    "id_aplicacao": null
}  },
      ]
    "telecare": {}
}

5- Erro ao consultar um chamado (400)

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