Este artigo contemplará:
- O passo a passo para realizar a solicitação de homologação de um serviço de telefonia VoIP/SIP ao PipeRun;
- O passo a passo para realizar a integração do serviço de telefonia ao PipeRun.
PRIMEIRA ETAPA - SOLICITAÇÃO DE HOMOLOGAÇÃO
Para realizar a homologação, a empresa operadora de telefonia deverá preencher o formulário abaixo, 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 o nome do usuário do PipeRun que fez a indicação, nome e CNPJ da empresa de telefonia e o nome do produto de telefonia;
- Anexo: logo da empresa de telefonia.
SEGUNDA ETAPA - TESTE DO PAYLOAD
Após o preenchimento do formulário, a nossa equipe de suporte fará a análise dos dados enviados e caso esteja tudo correto, enviaremos um email 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, através da conta do PipeRun e conferir se está tudo correto. Portanto, será necessário criar uma conta trial no PipeRun para testar o envio do payload de uma ligação. O envio dos dados será feito através da nossa API. Para visualizar a resposta da requisição, sugerimos utilizar a ferramenta Beeceptor.
Informações que você deverá receber no payload:
A estrutura padrão do payload deverá ser a seguinte, em formato JSON:
Exemplo do envio do payload pelo CRM PipeRun:
{
"user": "piperun",
"pass": "1qaz2wsx",
"id_crm_call": 2345787,
"exten": "12",
"destination": "5555999887766"
}
Após os testes de recebimento do payload e a validação das informações, daremos início à terceira parte da integração.
TERCEIRA ETAPA - ENVIO DE METADADOS
O terceiro passo da integração consiste no envio de metadados à API. Os metadados são enviados para um webhook criado especialmente para o seu serviço, por meio de uma requisição HTTPS com método POST. Este webhook estará disponível em: https://api.pipe.run/v1/webhooks/webphones/[token]
A requisição deve ter o cabeçalho Content-Type: application/json.
A estrutura do corpo da requisição deve ser a seguinte, em formato JSON:
Observação: quanto mais campos você disponibilizar no envio, mais completo ficará o histórico da ligação para o seu cliente acessar na nossa plataforma.
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"
}
}
QUARTA ETAPA - FINALIZAÇÃO DA HOMOLOGAÇÃO
Nesta última etapa para finalizar o processo de homologação, uma videoconferência deverá ser realizada com a nossa equipe técnica para avaliarmos se a configuração foi realizada corretamente e se o serviço está apto para ser utilizado na nossa plataforma.
Em caso de dúvida, entre em contato com nossa equipe de integrações.