Este artigo é destinado à discadores. Caso você seja um parceiro e deseja enviar metadados de ligações para Piperun, acesse o artigo Envio de Metadados de Ligações VoIP/SIP.

Este passo a passo descreve como cadastrar oportunidades e ligações utilizando a API do Piperun:

  1. Cadastre uma nova oportunidade utilizando o JSON de cadastro da oportunidade, de acordo com a documentação, e guarde o id da oportunidade cadastrada;
  2. Cadastre uma nova ligação de acordo os próximos passos:

Faça uma requisição HTTP com método POST para a URL https://api.pipe.run/v1/calls com os headers Content-Type: application/json e token: seu-token-de-acesso.

A estrutura do corpo desta requisição de ligação deve conter os seguintes campos (JSON):

atributodescrição
deal_idid da oportunidade (integer)
start_atdatetime inicial da ligação (string Y-m-d H:i:s)
end_atdatetime final da ligação (string Y-m-d H:i:s)
status200 para OK ou 404 para erro (integer)
record_urlURL para arquivo de áudio da ligação em mp3 (string)
external_call_idid da ligação no banco do parceiro (integer - optional)
durationduração da ligação (string H:i:s)
costcusto em reais da ligação (float)


Não esqueça de preencher o campo deal_id para vincular a ligação à oportunidade cadastrada anteriormente.

Abaixo há um exemplo de JSON para cadastrar uma nova ligação:

Abaixo há um exemplo de retorno esperado do cadastro de uma nova ligação/oportunidade: