Integração Leads

Envio dos Leads

Os leads serão enviados via protocolo HTTP no verbo POST, passando um JSON com as informações do lead no endpoint especificado e homologado por nosso time.

O processo de integração será acionado para cada lead individualmente sempre que recebermos um contato do usuário. Nosso controle de sucesso de envio dos leads será feito através dos códigos de status do protocolo HTTP da seguinte forma:

2xx: indica que o Software/CRM recebeu o lead com sucesso e que ações adicionais não são necessárias. Qualquer código de status da família 200 terá esse efeito. 3xx, 4xx ou 5xx: indica que houve falha no processamento do lead por parte do Software/CRM.

Caso o endpoint do Software/CRM retorne qualquer código de status que não são da família 200, haverá retentativa automática no envio do lead. O reenvio será executado por 3 vezes e, caso não haja sucesso, ele será armazenado temporariamente por até 14 dias, podendo ser reenviado a pedido do Software/CRM.

O controle do status de recebimento dos leads será feito exclusivamente através dos códigos de status do protocolo HTTP. Qualquer informação enviada no corpo da resposta será totalmente ignorada!

Contrato JSON:

{
  "leadOrigin": "Grupo OLX",
  "timestamp": "2017-10-23T15:50:30.619Z",
  "originLeadId": "59ee0fc6e4b043e1b2a6d863",
  "originListingId": "87027856",
  "clientListingId": "a40171",
  "name": "Nome Consumidor",
  "email": "nome.consumidor@email.com",
  "ddd": "11",
  "phone": "999999999",
  "phoneNumber": "11999999999",
  "message": "Olá, tenho interesse neste imóvel. Aguardo o contato. Obrigado.",
  "temperature": "Alta",
  "transaction_type": "SELL"
}

Onde:

• leadOrigin¹: Identificador da origem do lead (Grupo OLX);
• timestamp: Data e horário da criação do lead no formato ISO_LOCAL_DATE_TIME;
• originLeadId: Identificador do lead do GrupoZap;
• originListingId: Identificador do anúncio do GrupoZap;
• clientListingId: Identificador do anúncio para o anunciante (ListingId);
• name: Nome do consumidor que gerou o lead;
• email: E-Mail do consumidor que gerou o lead;
• ddd: DDD do telefone do consumidor que gerou o lead Ex:11;
• phone: Telefone do consumidor que gerou o lead Ex:999999999;
• phoneNumber: [deprecado] Telefone do consumidor que gerou o lead (DDD + Phone) Ex:11999999999;
• message²: Mensagem do consumidor que gerou o lead;
• temperature: Temperatura do lead (Baixa, Média, Alta);
• transactionType: Tipo de transação (RENT, SELL);

Notas

¹ O campo leadOrigin deixou de receber os valores "VivaReal", "Zap" e "GrupoZap" e agora adota somente o valor "Grupo OLX".

² No campo message, é possível discernir o canal por meio do qual o lead é gerado com base em determinados padrões presentes no conteúdo da mensagem, como exemplificado abaixo:

1. "Gostaria de ter mais informações para alugar e comprar"
2. "Um novo contato foi estabelecido via WhatsApp"
3. "Você recebeu uma nova visualização de telefone"

Observações Importantes:

clientListingId

O campo clientListingId é único identificador do anúncio/empreendimento conhecido pelo Software/CRM e GrupoZap, este identificador chega até nós via carga Feeds como código da listing (ListingId) ou customizado diretamente nos Software/CRM pelo cliente. Considere este identificador para realizar a devida associação do lead com o anúncio/empreendimento do cliente. Caso este identificador não estiver contido na requisição, deverá retornar o statusCode da família 400 (4xx) para ser analisado e reprocessado futuramente.

Leads em duplicidade

Os leads podem ser gerados por diferentes canais do Grupo OLX. Dessa forma, temos que um mesmo lead pode entrar em contato por mais de um canal. Para que seja possível distinguir os leads, é necessário verificar o originLeadId.

Homologação

Assim que as implementações forem realizadas, valide seu endpoint e depois nos envie as informações preenchendo o formulário abaixo:

*Caso encontre problemas para acessar o formulário, tente acessar diretamente através do link

Dúvidas, Sugestões ou Problemas

Caso tenha alguma dúvida, sugestão ou problemas durante a implementação da integração de Leads, envie um e-mail para chamado.integracao@olxbr.com que iremos responder assim que possível.

Exemplos

Possuímos alguns projetos simples feitos exclusivamente para demonstrar o recebimento de leads:

Python
NodeJS
Java
Go