Tópicos:
| Índice |
|---|
1- URL base API
| Ambientes | URL | Homologação | https://api.hmg.mosia.chat|
|---|---|---|---|
| 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. |
| 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>,
"created_at": <data_criacao>,
"protocol": "<protocolo>",
"queue": "<nome_da_fila>",
"subjects": [
{
"description": "<descricao_do_assunto>"
}
],
"topic": "<topico>",
"platform": "<plataforma_que_foi_realizado_o_atendimento>",
"rating": [
{
"label": "completed",
"value": "Sim"
},
{
"label": "evaluation",
"value": 4
},
{
"label": "comments",
"value": "Comentários sobre o atendimento."
}
],
"status_updates": [
{
"name": "Criado",
"timestamp": 1553879669948
},
{
"name": "Em atendimento",
"timestamp": 1553879672899
},
{
"name": "Fechado",
"timestamp": 1553879905560
}
]
},
"agent": {
"data": [
{
"label": "name",
"value": "<nome_atendente>"
},
{
"label": "email",
"value": "<email_atendente>"
},
{
"label": "phone",
"value": "<telefone_atendente>"
}
]
},
"caller": {
"caller_key": "<identificacao_chamador>",
"data": [
{
"label": "name",
"value": "<nome_chamador>"
},
{
"label": "email",
"value": "<email_chamado>"
},
{
"label": "phone",
"value": "<telefone_chamador>"
}
]
}
} |
5- Erro ao consultar um chamado (400)
| Bloco de código | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"message": "Nenhum resultado encontrado ou parâmetros inválidos."
} |