Este artigo é voltado para empresas de telefonia que queiram iniciar o processo de homologação do seu sistema voIP/SIP no PipeRun.
Será explicado o passo a passo para realizar a solicitação de homologação de um serviço de telefonia VoIP/SIP ao PipeRun, bem como a integração do serviço de telefonia ao PipeRun.
Atenção! Atente-se aos prazos de cada etapa, pois atrasos podem acarretar em cancelamento da solicitação, sendo necessário repetir todos os processos novamente para a conclusão da integração.
O prazo para retorno do time de suporte é de 30 a 45 dias. Este prazo é estimado. Qualquer dúvida, entre com nossa equipe de suporte clicando aqui.
TÓPICOS DO ARTIGO
PRIMEIRA ETAPA - SOLICITAÇÃO DE HOMOLOGAÇÃO
Para realizar a homologação, inicialmente a empresa fornecedora de telefonia deverá preencher o formulário disponibilizado neste link, informando:
Nome: nome do responsável técnico;
Telefone: telefone do responsável técnico;
E-mail: e-mail do responsável técnico;
E-mail adicional: caso queira incluir mais alguma pessoa para acompanhar o processo, informe o e-mail desta pessoa;
No campo Descrição, será necessário preencher com algumas informações. Informe:
Nome do usuário do PipeRun que fez a indicação;
Nome e CNPJ da empresa de telefonia. O CNPJ deve ser informado somente números, sem traços ou barras;
Nome do produto de telefonia.
Anexo: anexar arquivo contendo a logomarca da empresa de telefonia.
Atenção! O arquivo com a imagem da logomarca da empresa deve, obrigatoriamente, possuir dimensão mínima de 500 x 500px.
SEGUNDA ETAPA - TESTE DE RECEBIMENTO DE DADOS
Após o preenchimento do formulário disponibilizado no tópico anterior, nossa equipe de suporte realizará a análise dos dados enviados e caso esteja tudo correto, entraremos em contato via e-mail informando o token de integração.
Após receber o token, o responsável técnico da operadora de telefonia deverá realizar um teste de envio de dados, conforme informado abaixo, neste artigo.
Atenção! Será necessário criar uma conta trial no PipeRun para testar o envio do payload de uma ligação. Após criar a conta, confira abaixo o passo a passo para realizar o teste do payload.
Atente-se ao prazo de 15 (quinze) dias para a realização da segunda e terceira etapa presentes neste artigo. Este prazo diz respeito às contas trial do PipeRun, que possuem duração de 15 (quinze) dias.
Caso o prazo seja expirado, será necessário retornar à primeira etapa e reiniciar o processo da homologação.
1. Faça login na conta trial do PipeRun. Após, clique aqui ou posicione o mouse sobre o avatar da conta, localizado no canto superior direito da tela. Clique em "Editar dados da conta".
2. Agora, clique em "Configurações". Role a página até o final e localize e clique na opção "Telefonia".
3. No campo "Fornecedor de telefonia" selecione a sua empresa na listagem.
Nos campos abaixo, selecione ou preencha:
"Usuário" da conta de testes;
"URL" de recebimento do payload. Sugerimos gerar e utilizar um URL do Beeceptor para recebimento dos dados que serão enviados via API do PipeRun;
"Nome" e "Senha" referentes à conta de testes;
"Ramal" (Poderá ser qualquer número, este campo é utilizado de acordo com as necessidades de criação de ramal dos usuários).
INFORMAÇÕES QUE VOCÊ DEVERÁ RECEBER NO PAYLOAD:
A estrutura padrão do payload deverá ser a seguinte, em formato JSON:
Exemplo de envio do payload pelo CRM PipeRun:
{
"user": "piperun",
"pass": "1qaz2wsx",
"id_crm_call": 2345787,
"exten": "12",
"destination": "5555999887766"
}
4. Verifique se todos os atributos foram recebidos corretamente, conforme o exemplo acima. Caso tenha tido algum problema nesta etapa, contate nossa equipe do suporte.
Caso esteja tudo correto, dê início à próxima etapa da homologação.
TERCEIRA ETAPA - ENVIO DE METADADOS
O terceiro passo da integração consiste no envio de metadados à API do PipeRun. Os metadados serão enviados para um webhook criado especialmente para o serviço de telefonia, por meio de uma requisição HTTPS com método POST.
O webhook estará disponível em: https://api.pipe.run/v1/webhooks/webphones/[SEU-TOKEN-AQUI].
Atenção! Substitua
[SEU-TOKEN-AQUI]pelo token da integração, fornecido pela nossa equipe do suporte via e-mail.
A requisição deve ter o cabeçalho "Content-Type: application/json". A estrutura do corpo da requisição deverá ser a seguinte, em formato JSON:
Observação: Quanto mais campos você disponibilizar no envio dos dados, mais completo ficará o histórico da ligação para o seu cliente acessar na nossa plataforma.
Atenção! O "id" da ligação será enviado ao seu serviço quando a chamada for agendada. Através dele, vinculamos a chamada à Oportunidade cadastrada na conta do PipeRun, local onde a chamada foi originada.
Atenção! O PipeRun não se responsabiliza pelo tratamento dos campos à serem enviados para a nossa API.
Exemplo de requisição de envio de metadados do histórico da ligação pelo parceiro:
{
"id": 6473,
"start_at": "2019-03-10 17:16:18",
"end_at": "2019-03-10 17:19:35",
"status": 200,
"record_url": "http://caminho/do/arquivo.mp3",
"external_call_id": 3572,
"duration": "00:03:17",
"cost": 0.8
}
Exemplo de retorno do PipeRun para a requisição do histórico:
{
"success": true,
"message": "OK",
"data": {
"id": 582133,
"account_id": 1,
"user_id": 1,
"from_user_id": 1,
"deal_id": 1891456,
"company_id": null,
"person_id": 705503,
"webphone_id": 1,
"webphone_extension_id": 1,
"username": null,
"from_number": "3016",
"to_number": "55999887766",
"record_audio": null,
"from_caller_id": "3016",
"to_caller_id": null,
"description": null,
"start_at": "2019-03-10 17:16:18",
"end_at": "2019-03-10 17:19:35",
"status": 200,
"record_url": null,
"external_call_id": 3572,
"json_return": {
"id": 582133,
"start_at": "2019-03-10 17:16:18",
"end_at": "2019-03-10 17:19:35",
"status": 200,
"record_url": null,
"external_call_id": 3572,
"duration": "00:03:17",
"cost": 0.8
},
"important": null,
"duration": "00:03:17",
"cost": 0.8,
"created_at": "2019-03-21 16:50:49",
"updated_at": "2019-03-21 16:52:13"
}
}
Atenção: atente-se ao prazo de 15 (quinze) dias para a realização da segunda e terceira etapa da homologação. Este prazo diz respeito às contas trial do PipeRun, que possuem duração de 15 (quinze) dias.
Caso o prazo seja expirado, será necessário retornar à primeira etapa e reiniciar o processo da homologação.
QUARTA ETAPA - FINALIZAÇÃO DA HOMOLOGAÇÃO
Após finalizar a etapa de envio de metadados, nossa equipe fará uma checagem do funcionamento da integração e caso esteja funcionando corretamente, esta será homologada e estará disponível para uso dos nossos clientes no CRM de Vendas PipeRun.
Em caso de dúvidas, chame nossa equipe no chat. 😉