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": [
            {
           ],
    "descriptiontopic": "<descricao_do_assunto>"
            }
        ],
 Solicitar posição do Ticket",
      "topicplatform": "<topico>Web",
   
    "platformrating": "<plataforma_que_foi_realizado_o_atendimento>",
  [],
     "ratingstatus_updates": [
    
       {
   
            "labelname": "completedCriado",
      
         "valuetimestamp": "Sim"
  1608235870503
         },
     
      {
     
          "labelname": "evaluationEm atendimento",
      
         "valuetimestamp": 4
    1608235873740
       },
   
        {
       
        "labelname": "commentsFechado",
     
          "valuetimestamp": "Comentários sobre o atendimento."
    1608243754669
       }
   
    ],
   
    "status_updatesannotation": ["",
    "medical": {
      {"prescriptions": [
      	{
      	  "namecreated_at": "Criado01/03/2023 08:38:16",
              	  "timestampprescription_id": 155387966994884500149
      	}
	  ]
    },
            {
         "closing_reason": {
      "nameid": "Em atendimento34",
         
      "timestampdescription": 1553879672899"Encerramento        por desistência."
    },
    "survey": [
      {
    
           "name"id_data": "Fechado620fd0f97ddc0a0",
        "survey_version": 17,
        "timestampid_survey": 1553879905560"61f2f0c40297190",
        "timestamp": 1645203724292
  }    }
    ]
    },
 
  "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>pedroalvarescabral@mobile.com.br",
  
     "data": [
   
        {
       
        "label": "namephone",
       
        "value": "<nome_chamador>"
     999878712382"
      },
    
       {
       
        "label": "emailname",
       
        "value": "<email_chamado>"Pedro Alvares    Cabral"
       },
      {
     {        "label": "email",
        "labelvalue": "phone",pedroalvarescabral@mobile.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."
}