Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

Endereço da API exemplo

GET https://sip.nextbilling.com.br/api/manageIvr/API_TOKEN/API_KEY/0

Parâmetros:

  • id_cliente: Obter o cadastro de um registro em específico

  • descricao: Descrição do Registro

  • alow_dial_extension: 0 - Apenas opção de URA permitido | 1 - Permite digitar opção da URA ou um número de ramal para discagem direta

  • timeout_response: Tempo em segundos para um Digito do Cliente

  • timeout_digit: Tempo em Segundos entre os Dígitos

  • perfil_horario: Objeto informando o ID do perfil de horário, ex: "perfil_horario": {id: 12}

  • audio_invalido: Objeto informando o ID do Audio de Opção inválida, ex: "audio_invalido": {id: 12}

  • audio_timeout: Objeto informando o ID do Audio de Tempo Esgostado, ex: "audio_timeout": {id: 12}

  • have_question: Inteiro que ativa ou desativa a Pesquisa de Satisfação: 0 - inativo | 1 - ativo

  • audio_question: Objeto informando o ID do Audio da Pesquisa de Satisfação, ex: "audio_timeout": {id: 12}

  • closed_audio: Objeto informando o ID do Audio de Fora de Funcionamento, ex: "closed_audio": {id: 12}

  • closed_action: Objeto informando a ação a ser tomada caso a URA esteja Fora do Horário de Funcionamento, ex: 

    • "closed_action": {"action": "hangup", "action_data": ""} (Nesse caso a chamada seria desligada se fora de Funcionamento)

    • "closed_action": {"action": "voicemail", "action_data": "23"} (Nesse caso, action_data deve conter o ID da Linha referente a caixa postal)

  • action1: Objeto informando a ação a ser realizada assim que a chamada entrar nessa URA, ex: 

    • "action1": {"action": "hangup", "action_data": ""} (Nesse caso a chamada seria desligada)

    • "action1": {"action": "voicemail", "action_data": "23"} (Nesse caso, action_data deve conter o ID da Linha referente a caixa postal)

    • "action1": {"action": "background", "action_data": "23"} (Nesse caso, action_data deve conter o ID do Audio a ser reproduzido)

    • "action1": {"action": "dial", "action_data": "23"} (Nesse caso, action_data deve conter o ID da Linha IP a ser chamada)

    • "action1": {"action": "queue", "action_data": "23"} (Nesse caso, action_data deve conter o ID da Fila de Atendimento a ser chamada)

  • option0: Objeto informando a ação a ser realizada quando o usuário digitar a opção 0, ex: 

    • "option0": {"action": "hangup", "action_data": ""} (Nesse caso a chamada seria desligada)

    • "option0": {"action": "voicemail", "action_data": "23"} (Nesse caso, action_data deve conter o ID da Linha referente a caixa postal)

    • "option0": {"action": "dial", "action_data": "23"} (Nesse caso, action_data deve conter o ID da Linha que será chamada)

    • "option0": {"action": "queue", "action_data": "23"} (Nesse caso, action_data deve conter o ID da Fila de Atendimento que a chamada será enviada)

    • "option0": {"action": "ivr", "action_data": "23"} (Nesse caso, action_data deve conter o ID do Bloco de URA (IVR) que a chamada será desviada)

    • "option0": {"action": "portal", "action_data": "0"} (Nesse caso a chamada será enviada para um Portal de Voz)

    • "option0": {"action": "extension", "action_data": "0"} (Nesse caso, a URA irá solicitar ao cliente que digite o número da Linha que ele quer falar)

    • "option0": {"action": "execute_invalid", "action_data": "0"} (Nesse caso, a URA irá executar a ação presente na optioni que é o executado quando se digita uma opção inválida na URA)

  • option1: Objeto informando a ação a ser realizada quando o usuário digitar a opção 1 no telefone

  • option2: Objeto informando a ação a ser realizada quando o usuário digitar a opção 2 no telefone

  • option3: Objeto informando a ação a ser realizada quando o usuário digitar a opção 3 no telefone

  • option4: Objeto informando a ação a ser realizada quando o usuário digitar a opção 4 no telefone

  • option5: Objeto informando a ação a ser realizada quando o usuário digitar a opção 5 no telefone

  • option6: Objeto informando a ação a ser realizada quando o usuário digitar a opção 6 no telefone

  • option7: Objeto informando a ação a ser realizada quando o usuário digitar a opção 7 no telefone

  • option8: Objeto informando a ação a ser realizada quando o usuário digitar a opção 8 no telefone

  • option9: Objeto informando a ação a ser realizada quando o usuário digitar a opção 9 no telefone

  • option_star: Objeto informando a ação a ser realizada quando o usuário digitar a opção * (Asterisco) no telefone

  • option_hash: Objeto informando a ação a ser realizada quando o usuário digitar a opção # (Hashtag) no telefone

  • optiont: Objeto informando a ação a ser realizada quando o usuário não digitar nada no Bloco de URA

  • optioni: Objeto informando a ação a ser realizada quando o usuário digitar uma opção que não tiver uma ação configurada

  • status: Status do Registro: 0 - Inativo | 1 - Ativo

...