Para enviar metadados de ligações para o piperun, primeiramente é necessário entrar em contato com nosso setor de vendas pelo email sales@pipe.run.

Quando a parceria for fechada, seu serviço será homologado e receberá um token secreto para enviar metadados para a API do piperun e preencher as informações de uma chamada já cadastrada em nosso banco de dados.

Os metadados são enviados para um webhook criado especialmente para o seu serviço por meio de uma requisição HTTP com método POST. Este webhook está disponível em /webhooks/webphones/[token-secreto].

https://api.pipe.run/v1/webhooks/webphones/[token-secreto]

A requisição deve ter o header Content-Type: application/json.

A estrutura do corpo da requisição deve ser a seguinte, em JSON:

atributo descrição
id id da ligação (integer)
start_at datetime inicial da ligação (string Y-m-d H:i:s)
end_at datetime final da ligação (string Y-m-d H:i:s)
status 200 para OK ou 404 para erro (integer)
record_url URL para arquivo de áudio da ligação em mp3 (string)
external_call_id id da ligação no banco do parceiro (integer - optional)
duration duração da ligação (string H:i:s)
cost custo em reais da ligação (float)

Nota: O id da ligação é enviado ao seu serviço quando a chamada é agendada. Por ele, vinculamos a chamada à oportunidade de onde a chamada foi originada.

Abaixo há um exemplo de requisição de envio de metadados:

Abaixo há um exemplo de retorno esperado desta requisição: