Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Esta API é destinada a Canais e Alianças da Directcall que desejam oferecer para o mercado equipamentos e aplicativos SIP com o valor agregado de uma Linha Telefônica gratuita para os seus clientes, que permite ligar para telefones fixos e móveis por até 45 dias (ou até que sejam consumidos os minutos gratuitos associados a cada linha). 

Permite iniciativas como esta no seu website:                                                                                            Image Added

Onde as informações geradas por cada solicitação podem ser totalmente compartilhadas com o parceiro Directcall.    

Este documento descreve os passos necessários para que os parceiros utilizem a API de forma eficaz, desde o login até a confirmação do teste realizado.


Requisitos:

  • Ser parceiro Directcall homologado.

...


Descrição do passo a passo da API:

  1. Autenticação via OAuth: Antes de iniciar qualquer interação com a DirectCall, o parceiro deve autenticar-se utilizando OAuth, garantindo segurança e controle de acesso às funcionalidades da API.

  2. Solicitar a lista de cidades disponiveis: Utilizando a rota /city/list-by-uf/{uf} obter os detalhes das cidades disponiveis para realizar o teste
  3. Obter informações de equipamento: Utilizando a rota /equipment/ obter informações de equipamento cadastrados
  4. Registrar uma URL de callback:  Registrar uma URL de callback para receber status dos testes criados pela API.
  5. Registro de Pedidos de Teste: Uma vez autenticado, o parceiro pode registrar pedidos de teste na DirectCall fornecendo as informações necessárias. É crucial que todos os campos obrigatórios estejam preenchidos corretamente para evitar recusas pela API.

  6. Verificação de Teste Existente: Caso o contato já tenha realizado um teste prévio do nosso SIP Trunk, a API retornará um código de erro  409 (Test already exists), informando que o pedido de teste foi negado devido ao teste anterior já existente.

  7. Processo para Novos Testes: Se o contato ainda não tiver testado o SIP Trunk, a API irá retornar a URL da DirectCall. O parceiro deve redirecionar o contato para essa URL, onde será solicitado que o mesmo verifique seu e-mail cadastrado. Existe também a opção para atualização do e-mail cadastrado, caso necessário.

  8. Início do Processo de Liberação: Uma vez que o contato tenha acessado a URL e validado seu e-mail, a DirectCall iniciará o processo para liberar o teste, incluindo instruções detalhadas sobre o uso do serviço, planos de minutos disponíveis, entre outros detalhes relevantes.

  9. Retorno de Informações ao Parceiro: Finalmente, a API retornará ao parceiro o status do pedido de teste, indicando se foi ativado com sucesso. Além disso, será fornecido o e-mail encontrado no banco de dados da DirectCall, permitindo que o parceiro mantenha seus registros atualizados conforme necessário.

...


Clique aqui para acessar a documentação técnica

Este guia visa proporcionar uma integração clara e eficiente entre os sistemas dos parceiros e a DirectCall, otimizando o processo de solicitação e gerenciamento de testes do nosso SIP Trunk. Para mais detalhes técnicos e exemplos práticos de implementação, consulte a documentação completa da API fornecida pela DirectCall.