Envio de Metadados de Ligações VoIP/SIP
7 min
Criado por: Ana Bittencourt em: 24/03/2020 12:02

 

O objetivo deste artigo é informar como realizar o processo de integração do seu VOIP/SIP ao CRM PipeRun.

 

A operadora deverá solicitar a parceria com o CRM PipeRun, enviando um e-mail para o setor de vendas, informando essa intenção. O e-mail para este contato é sales@pipe.run.

 

  • No título do e-mail, informe: "Homologar Empresa de Telefonia Com o CRM PipeRun"
  • Envie os dados de sua empresa operadora de telefonia
    • Nome da Empresa/Produto
    • Sobre o Parceiro
      • Explicar qual é o objetivo da integração
    • Tipo
      • Ligação - SIP
    • Categoria
      • Comunicações - Telefonia
    • Logo (FTP p/ S3)
    • Link da Integração
    • Link do Site do Parceiro
    • Link de Ajuda
  • Identifique o cliente usuário do CRM PipeRun que o indicou.
  • Informe o nome e e-mail dos responsáveis comerciais e técnicos de sua empresa.

Desenho do Processo

Processo de Integração SIP.jpeg

Iniciando a Integração

Logo após a solicitação de integração, o parceiro passará por uma entrevista com o consultor técnico. Na entrevista o consultor realizará o primeiro teste da integração para consumo dos dados enviados pelo CRM PipeRun. Para os testes, recomendamos o uso da ferramenta Beeceptor.

Na primeira parte enviamos um payload para o parceiro com as informações da chamada realizada no CRM PipeRun. O payload poderá ser ajustado de acordo com o parceiro, desde que mantenha o ID da chamada como padrão.

A estrutura padrão do payload deverá ser a seguinte, em formato JSON:

Atributo Tipo Descrição
user String Usuário do ramal
pass String Senha do ramal
id_crm_call Inteiro ID da chamada realizada no CRM PipeRun
exten Inteiro Número do ramal
destination String Número de telefone da chamada realizada no CRM PipeRun

 

Exemplo de envio do payload pelo CRM PipeRun:

{
    "user": "piperun",
    "pass": "1qaz2wsx",
    "id_crm_call": 2345787,
    "exten": "12",
    "destination": "5555999887766"
}

Envio dos Metadados

Ao finalizar a etapa de testes, o serviço será homologado e o parceiro receberá um token secreto para enviar metadados para a API do CRM PipeRun. O token será fornecido após a conferência por e-mail ou então você receberá as instruções para contactar o consultor técnico.

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-secreto]

 

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:

 

Atributo Tipo Descrição
id Inteiro ID da ligação
start_at Data (Y-m-d H:i:s) Data de início da ligação
end_at Data (Y-m-d H:i:s) Data final da ligação.
status Inteiro 200 para OK ou 404 para erro
record_url String URL para arquivo de áudio da ligação em mp3
external_call_id Inteiro ID da ligação no banco do parceiro (opcional)
duration Hora (H:i:s) Duração da ligação.
cost Decimal Custo em reais da ligação (float)

 

IMPORTANTE! 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.

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"
    }
}
 

Em caso de dúvida, entre em contato com nossa equipe de integrações

O que você achou deste artigo?
Últimos artigos visitados