/voz/status

Método que retorna status da chamadas realizadas pela API de voz da Directcall.



DESCRIÇÃOCom este método podemos consultar uma chamada que está em andamento
ESTRUTURA DA URLhttps://api.directcallsoft.com/voz/status
VERSÃO2
MÉTODOGET
PARÂMETROS

callerid obrigatório  Código único que identifica uma chamada, é retornado ao solicitar uma chamada pela API

access_token obrigatório Chave de acesso ao método. Para saber como obter, clique aqui

RETORNO

api Origem API que está sendo usada

modulo Módulo que está sendo chamado

status Mensagem de status

codigo Código de retorno - Clique aqui para listar os códigos e suas descrições

msg Array de resposta da API


Exemplo de resposta em JSON
{
    "api": "voz",
    "modulo": "status",
    "status": "ok",
    "codigo": "000",
    "msg": {
        "callId": "653dbcb5-abef-4e5b-a01c-725a9354b7aa",
        "number": "5541991833249",
        "status": "RING_WAIT",
        "startTime": "2024-11-04T17:35:53",
        "duration": 21,
        "answerState": "answered"
    }
}


Opções de retorno de status:

RING_WAIT: A chamada está esperando para começar a tocar no destino.
RINGING: A chamada está tocando no dispositivo de destino.
ACTIVE: A chamada está ativa e em andamento, com áudio sendo trocado entre as partes.
HOLD: A chamada foi colocada em espera, geralmente pelo usuário ou por alguma ação no sistema.
EARLY: A chamada está em fase de sinalização inicial, antes de ser totalmente conectada.
ANSWERED: A chamada foi atendida, mas ainda pode estar no estágio inicial da comunicação.
HANGUP: A chamada foi desligada e está sendo encerrada.
END_CALL: A chamada está encerrada. 


Opções de retorno de answerState:

answered: Indica que a chamada foi atendida pelo destino e está pronta para comunicação.
early: Refere-se ao estágio de chamada que está tocando no dispositivo de destino, mas ainda não foi atendida (exibindo um toque de chamada).
ringing: A chamada está tocando no dispositivo de destino.
hangup: Indica que a chamada foi desligada antes de ser atendida.
hold: A chamada foi atendida e, posteriormente, colocada em espera.


Exemplos:

LinguagemDescriçãoArquivo
PHPArquivo em PHP com exemplo de como requisitar o access_token por meio da APIRequisitarToken.php
PHPArquivo em PHP com exemplo de como consultar status de uma chamada em andamento via APIConsultaStatusChamada.php



Validade dos tokens: Os tokens de acesso têm uma validade limitada, por isso convém que o sistema criado tenha em conta estes timings para que possa desenvolver rotinas de requisação de novos tokens.

Duration: É a duração desde o pedido de criação da chamada, portanto não é a duração cobrada. Para duração cobrada consultar a API de extrato.

  • Sem rótulos