Tópicos:
1- URL base API
| Ambientes | URL |
|---|---|
| Produção |
2- Endpoint
| Endpoint | Método | Descrição |
|---|---|---|
| v1/call/<protocolo_chamado> | GET | Método consulta informações de um chamado. |
3- Autenticação
| Key | Value | Descriçã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. |
Como 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)
Retorno API sucesso
{
"call": {
"status": "Fechado",
"attended_at": 1608235873740,
"created_at": 1608235870503,
"protocol": "99999920201217000004",
"queue": "Fila Padrão",
"subjects": [],
"topic": "Solicitar posição do Ticket",
"platform": "Web",
"rating": [],
"status_updates": [
{
"name": "Criado",
"timestamp": 1608235870503
},
{
"name": "Em atendimento",
"timestamp": 1608235873740
},
{
"name": "Fechado",
"timestamp": 1608243754669
}
],
"annotation": "",
"medical": {
"prescriptions": []
},
"closing_reason": {
"id": "34",
"description": "Encerramento por desistência."
},
"survey": [
{
"id_data": "620fd0f97ddc0a0",
"survey_version": 17,
"id_survey": "61f2f0c40297190",
"timestamp": 1645203724292
}
]
},
"agent": {
"name": "Ranniêr Reis",
"email": "rannier@mobilesaude.com.br",
"phone": "(48) 3220-0949",
"crm_reference": ""
},
"caller": {
"caller_key": "pedroalvarescabral@mobile.com.br",
"data": [
{
"label": "phone",
"value": "999878712382"
},
{
"label": "name",
"value": "Pedro Alvares Cabral"
},
{
"label": "email",
"value": "pedroalvarescabral@mobile.com.br"
}
]
},
"integration": {
"id_operadora": null,
"id_aplicacao": null
},
"telecare": {}
}
5- Erro ao consultar um chamado (400)
Retorno API falha
{
"message": "Nenhum resultado encontrado ou parâmetros inválidos."
}