Integração API VOIP
Integração API VOIP
Prezado cliente,
Nossa API de integração com as centrais PABX está disponível no servidor Situator no caminho abaixo:
Para fazermos a integração com o Situator o administrador da central PABX necessita passar alguns paramentos para o Situator, mas para isso precisamos fazer alguns ajustes.
1 - A central VOIP precisa autenticar no Situator, ou seja, você precisa criar um usuário no Situator.
- Usuário : voip
- Senha: voip
- Perfil: Cliente da API
Você deve usar a API de autenticação abaixo.
PUT /api/login
Exemplo do uso da API
{
"userName": "voip",
"password": "voip
",
"rememberMe": true,
"accountId": 0
}
2 - Na central VOIP é necessário implementar e envio de eventos para o Situator, essa implementação é de total responsabilidade do desenvolvedor da aplicação VOIP. Ele precisa criar uma fila de atendimento (Ex: 1000 - Base de Atendimento) na qual todos os ramais que ligarem para essa fila deverão passar os parâmetros da API para o Situator no momento da ligação.
- "accountCode" Condigo da Conta do Situator.
- "zoneCode" Condigo da Zona do Situator.
- "eventCode" Condigo do Evento do Situator.
- "priority" Condigo da Prioridade do evento.
- "join" Caso queria agrupar ou não o evento na tela de monitoramento.
POST /api/remote-events
Exemplo do uso da API
{
"accountCode": "1000",
"zoneCode": "0010",
"eventCode": "0012",
"priority": 0,
"join": true,
}
3 - Atendimento automático da Ocorrência
Para implementar o atendimento automático da ocorrência é preciso usar a API VOIP que segue abaixo e configurar o Situator em duas etapas.
POST /api/voip/events
- Configurações - Preferencias
Configurar o ramal do atendente que está na estação
- Contas - Configurações da Conta - Eventos
Editar o evento do ramal e configurar a opção "Ramal de origem" nessa configuração você deve informar o numero do ramal que estava fazendo a ligação
Exemplo do uso da API
{
"call": {
"src": "1020",
"dst": "2003"
}
}
Com essa essa configuração as ligações que o operador do ramal 2003 atender as ocorrências também serão atribuídas a ele, desde que a integração esteja correta.
Obs: Lembrando que não prestamos suporte na integração da central PABX com o Situator nos apenas explicamos o comportamento da API, quais parâmetros devem ser passados para que a mesma funcione.