DOCS

Call - Vinculação

Evento

POST voice/pbx/call/link

Como receber

Configure uma URL HTTPS pública para receber este evento e responda rapidamente com status de sucesso após aceitar o payload.

Payload

  • Content-Type: application/json
CampoTipoObrigatórioValores / ExemploDescrição
channelstringSimExemplo: SIP/101_pabx9999999.ligou.me-00001234Identificador do canal da ligação
uniqueidstringSimExemplo: srv999-91234567.99Id da Chamada (Origem)
subeventstringNãoExemplo: BeginDefinição do sub-evento.
dialstatusstringNãoAceita: CHANUNAVAIL, CONGESTION, NOANSWER, BUSY, ANSWER, CANCEL · Exemplo: CANCELStatus atual da chamada
destuniqueidstringNãoExemplo: srv999-91234567.99Id da chamada na conexão de destino
calleridnumstringNãoExemplo: 101Número da Bina (Canal Origem)
calleridnamestringNãoExemplo: Ramal JoãoNome da Bina (Canal Origem)
connectedlinenumstringNãoExemplo: 03140637007Nome da Bina (Canal Conectado)
connectedlinenamestringNãoExemplo: emptyNúmero da Bina (Canal Conectado)
dialstringstringNãoExemplo: CONTA_SIP/DESTINOComando de discagem da central
call_begindatetimeNãoExemplo: 2020-07-10 15:00:00.000Data de inicio da chamada no formato de string ISO 8601.
pbxstringNãoExemplo: pabx99999.ligou.meIdentificar/dóminio do seu PABX
eventNamestringNãoExemplo: voice/pbx/channel/dialNome completo do evento
eventTypestringNãoAceita: custom, db · Exemplo: customTipo de evento
projectstringNãoExemplo: projectIdentificador do projeto
verifyKeystringNãoChave de verificação da integração.
call_enddatetimeNãoExemplo: 2020-07-10 15:00:00.000Data de encerramento da chamada no formato de string ISO 8601.

Exemplo básico recebido:

{
  "channel": "SIP/101_pabx9999999.ligou.me-00001234",
  "uniqueid": "srv999-91234567.99"
}

Respostas

StatusDescriçãoConteúdo
200Return a 200 status to indicate that the data was received successfully

Boas práticas

  • Trate reenvios como possibilidade real.
  • Valide o payload antes de executar regras de negócio.
  • Registre o identificador do evento ou do registro recebido para auditoria.