@extends('layouts.sigma') @section('content')
Versão da API: v1.0
Utilizado para disparo de chamadas nos eventos X2/X5. Os parâmetros devem obedecer a ordem indicada neste documento. Configurável no Sigma Desktop em Configurações > Sistema > Confgurações de Discagem > Discagem Automática.
Devem ser substituídos os parâmetros conforme configurações do sistema Sigma. Após o consumo do recurso, a chamada será encaminhada para o telefone indicado e será retornado a id de recuperação de status/áudio da chamada.
Ao encerramento da chamada o status será enviado para a URL fornecida no parâmetro SigmaWS.
{{ url('/') }}/api/seg/v1/event
Parâmetro | Descrição | Requisito |
---|---|---|
Token | Token de autenticação com as credenciais de uso do recurso. São aceitos somente alfanuméricos, com tamanho exato de 41 caracteres. | Obrigatório |
Phone | Telefone a ser discasdo durante o evento. São aceitos somente caracteres numéricos, com tamanho entre 8 e 11. | Obrigatório |
EventId | Identificador do evento, usado para informar o status da chamada ao retornar os dados para a url presente no parâmetro SigmaWS. | Obrigatório |
EventCode-ContactId | Código do Evento (X2 ou X5) seguido de um hífen (-) e do código identificador do contato no Sigma. Os parâmetros são opcionais, porém o hífen que divide os dois parâmetros é obrigatório, atentar-se para este detalhe na montagem da URL dentro do Sigma Desktop. | Opcional |
Password | Senha de liberação normal. | Obrigatório |
Coercion | Senha de liberação por coação. | Obrigatório |
SigmaWS | Endereço onde está o SIGMA Web Service do cliente, utilizado para montar a URL do Sigma para onde será enviado o retorno com status da chamada. | Obrigatório |
{{ url('/') }}/api/seg/v1/event/token/phone/eventId/eventcode-contactId/password/coercion/sigmaws
GET | {{ url('/') }}/api/seg/v1/event/f5fe9080564909794482ee0dc8169068b508dbbd2/4133009000/123456/X2-27001/1234/4321/http://sistema.sigma.cliente/retorno |
N/A
{
"status": "ok",
"id": "f0e7e96fddd985c671f2e6aa5045f9da"
}
{
"status": "error",
"cause": "Não foi possível realizar o originate"
}
Limite simultâneo | Sim |
Limite de Request | 100 req/s |
Formato do retorno | JSON |
Encoding | UTF-8 |
Restrito (requer Token) | Sim |