URL BASE
ENDPOINT
EXEMPLO RETORNO SUCESSO
Tópicos:
| Índice |
|---|
1- URL base API
| Ambientes | URL |
|---|---|
| Produção | .hmg |
2- Endpoint
| Endpoint | Método | Descrição |
|---|---|---|
| v1/call/<protocolo_atendimento>chamado> | GET | Método que obtém dados de um atendimento. |
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. |
| Dica | ||
|---|---|---|
| ||
Para obter o TOKEN_API_MOSIA relacionado ao CRM. siga os passos:
|
4- Retorno de chamado com sucesso (200)
| Bloco de código | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"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": [
{
"",
"namemedical": "Criado",
{
"timestampprescriptions": 1553879669948[
},
{
"name"created_at": "Em atendimento01/03/2023 08:38:16",
"timestamp"prescription_id": 84500149
1553879672899 }
]
},
{
"closing_reason": {
"name"id": "Fechado34",
"timestampdescription": 1553879905560"Encerramento }
]por desistência."
},
"agentsurvey": {
"data": [
{
"labelid_data": "name620fd0f97ddc0a0",
"valuesurvey_version": "<nome_atendente>"
},
{
17,
"labelid_survey": "email61f2f0c40297190",
"valuetimestamp": "<email_atendente>"
1645203724292
},
]
},
"agent": {
"name": "Ranniêr Reis",
"labelemail": "phonerannier@mobilesaude.com.br",
"phone": "(48) 3220-0949",
"valuecrm_reference": "<telefone_atendente>"
}
]
},
"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 | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
{
"message": "Nenhum resultado encontrado ou parâmetros inválidos."
} |