Skip to content

Objeto de envio ​

Campos ​

CampoTipoObrigatórioLimiteO que é
lead_idstringsim191Id do lead, vindo de GET /partners/leads.
id_chamadastringsim120Único por ligação. É a chave de idempotência.
resultadostringsim—lead_fechar_negocio, lead_qualificado ou lead_desqualificado.
produtostringsim—imoveis ou veiculos. Precisa bater com o lead.
autorizou_contato_especialistabooleanosim—Se o anunciante autorizou o contato comercial.
resumostringsim20.000Resumo da conversa, em texto livre.
transcricaostringsim1.000.000Transcrição da ligação.
link_gravacaostringsim2.000URL da gravação. Só http:// ou https://.
data_chamadadata ISO 8601sim—Quando a ligação aconteceu, com fuso.
quantidade_informadanúmeronão0 a 1.000.000Quantos anúncios o anunciante disse ter.
plano_id_ofertadostringnão60plano_id vindo de GET /partners/planos.
motivo_desqualificacaostringnão2.000Só com lead_desqualificado.
usuario_destinostringcondicional191Obrigatório em lead_fechar_negocio. Id do usuário de destino.
tarefaobjetonão—Tarefa de acompanhamento. Sem ele, nenhuma tarefa é criada.

Bloco tarefa ​

Opcional. Quando vem, estes são os seus campos:

CampoTipoObrigatórioLimiteO que é
titulostringsim191O que aparece na fila do responsável.
tipostringsim—ligacao, email, reuniao, whatsapp ou tarefa.
prazodata ISO 8601sim—Vencimento, com fuso.
descricaostringnão16.000Contexto para quem vai executar.
parastringnão191Id de quem fica com a tarefa. Sem ele, o dono do card.

Regras de validação que surpreendem ​

motivo_desqualificacao só vale com lead_desqualificado. Enviar junto de outro resultado devolve 400. Motivo de perda em lead qualificado quase sempre significa que o resultado foi montado errado do outro lado, e aceitar em silêncio gravaria no card uma perda que não existe.

usuario_destino é obrigatório em lead_fechar_negocio. Sem ele o lead ficaria parado com o vendedor antigo, em silêncio. Nos outros dois resultados o campo é conferido (usuário inexistente ou desligado devolve 400) mas não muda o dono.

link_gravacao só aceita http e https. Outros esquemas são recusados com 400.

produto precisa bater com o lead. Lead de veículos com produto: "imoveis" devolve 400.

Texto acima do limite devolve 400, não erro interno. A mensagem diz qual campo e qual é o limite.

Toda data precisa de fuso. Veja Formato de datas.

Onde cada campo vai parar ​

Campo enviadoOnde aparece no CRM
resumoAba da ligação, no card do lead.
transcricaoAba da ligação, carregada ao expandir.
link_gravacaoAba da ligação, como link.
quantidade_informadaAba da ligação, em campo próprio.
plano_id_ofertadoAba da ligação, em campo próprio.
autorizou_contato_especialistaAba da ligação, em campo próprio.
motivo_desqualificacaoAba da ligação, e vira o motivo de perda do card.
data_chamadaAba da ligação, como a hora da conversa.
tarefaFila de tarefas do responsável.
resultadoSituação do card e a anotação na linha do tempo.

A anotação na linha do tempo tem duas linhas e aponta para a aba. Mais em Tarefas e anotações.

Documentação das integrações da Chaves na Mão