Aqui você encontra todas as API's públicas de integração de leads para as aplicações Hypnobox. Se precisar de ajuda com alguma integração, entre em contato com suporte@hypnobox.com.br
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"15270022","collectionId":"2bf647f3-7178-4ae0-9c1e-da051ecea0f2","publishedId":"2s83tCLZ6E","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"adc239"},"publishDate":"2024-03-19T13:25:43.000Z"},"item":[{"name":"Autenticação","item":[{"name":"Obter Token","id":"827b22c4-9f0c-4c4f-be8a-922c990ffa35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{subdominio}}.hypnobox.com.br/api/auth?login=&password=&returnType=json","urlObject":{"path":["api","auth"],"host":["{{subdominio}}","hypnobox","com","br"],"query":[{"description":{"content":"Login de API (diferente de Login do sistema)
\n","type":"text/plain"},"key":"login","value":""},{"description":{"content":"Senha de API (diferente de senha do sistema)
\n","type":"text/plain"},"key":"password","value":""},{"description":{"content":"\"json\" ou \"xml\"
\n","type":"text/plain"},"key":"returnType","value":"json"}],"variable":[]}},"response":[{"id":"b97f175e-753c-4622-844a-c799b83c72ef","name":"Obter Token","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{subdominio}}.hypnobox.com.br/api/auth?login=joao_silva@api&password=M1NH4-S3NH4&returnType=json","host":["{{subdominio}}","hypnobox","com","br"],"path":["api","auth"],"query":[{"key":"login","value":"joao_silva@api","description":"Login de API (diferente de Login do sistema)"},{"key":"password","value":"M1NH4-S3NH4","description":"Senha de API (diferente de senha do sistema)"},{"key":"returnType","value":"json","description":"\"json\" ou \"xml\""}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"3b5aa81d24fe2926a1c7763978f33be1\"\n}"}],"_postman_id":"827b22c4-9f0c-4c4f-be8a-922c990ffa35"}],"id":"88fbb610-8a34-4587-b79f-0f84739fcdd9","description":"Se o seu ambiente possui proteção de leads com token (/email.receber) ou outro endpoint protegido por autenticação, utilize esse endpoint para obter o token. Recomenda-se gerar um novo em cada requisição, para evitar que o token expire.
\nEm alguns casos o token pode expirar em até 2 horas.
\n","_postman_id":"88fbb610-8a34-4587-b79f-0f84739fcdd9"},{"name":"CRM - Vendas e Parcerias (v1.4.2)","item":[{"name":"Formulário - Envio de leads","id":"07e01b95-425a-487f-b93d-21ee73d41a5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"token","value":"","description":"Token obrigatório somente se o seu ambiente possui proteção na entrada de leads. Utilize o endpoint de autenticação para gerar um token.
\n","type":"text","disabled":true},{"key":"nome","value":"","description":"🔴 Nome do cliente
\n","type":"text","disabled":true},{"key":"email","value":"","description":"🔴 E-mail do cliente
\n","type":"text","disabled":true},{"key":"id_produto","value":"","description":"🔴 ID do produto no CRM
\n","type":"text","disabled":true},{"key":"id_interno","value":"","description":"ID legado do produto\nSe o id_interno for fornecido, o id_produto deixa de ser obrigatório
\n","type":"text","disabled":true},{"key":"assunto","value":"","description":"Assunto do contato
\n","type":"text","disabled":true},{"key":"mensagem","value":"","description":"Corpo da mensagem/contato
\n","type":"text","disabled":true},{"key":"midia","value":"","description":"Mídia de origem do contato/conversão
\n","type":"text","disabled":true},{"key":"id_canal","value":"","description":"ID do canal de origem
\n","type":"text","disabled":true},{"key":"id_sub_canal","value":"","description":"ID do sub canal
\n","type":"text","disabled":true},{"key":"ddd_residencial","value":"","description":"DDD do telefone
\n","type":"text","disabled":true},{"key":"tel_residencial","value":"","description":"Telefone do cliente
\n","type":"text","disabled":true},{"key":"ddd_celular","value":"","description":"DDD do cliente
\n","type":"text","disabled":true},{"key":"tel_celular","value":"","description":"Telefone do cliente
\n","type":"text","disabled":true},{"key":"ddd_comercial","value":"","description":"DDD do cliente
\n","type":"text","disabled":true},{"key":"tel_comercial","value":"","description":"Telefone do cliente
\n","type":"text","disabled":true},{"key":"ddd_outro","value":"","description":"DDD do cliente
\n","type":"text","disabled":true},{"key":"tel_outro","value":"","description":"Telefone do cliente
\n","type":"text","disabled":true},{"key":"denylist","value":"","description":"0 ou 1 - usado somente se o ambiente possuir o pacote LGPD
\n","type":"text","disabled":true},{"key":"consentimento","value":"","description":"0 ou 1 - usado somente se o ambiente possuir o pacote LGPD
\n","type":"text","disabled":true},{"key":"regional","value":"","description":"ID da regional no ambiente
\n","type":"text","disabled":true},{"key":"descricao","value":"","description":"Descrição na ficha do cliente
\n","type":"text","disabled":true},{"key":"valor_entrada","value":"","description":"decimal - Valor de entrada sugerida pelo cliente
\n","type":"text","disabled":true},{"key":"renda_familiar","value":"","description":"decimal - valor da renda fornecida pelo cliente
\n","type":"text","disabled":true},{"key":"valor_fgts","value":"","description":"decimal - valor do FGTS disponível para uso
\n","type":"text","disabled":true},{"key":"cpf","value":"","description":"CPF do cliente
\n","type":"text","disabled":true},{"key":"sexo","value":"","description":"M ou F - sexo do cliente
\n","type":"text","disabled":true},{"key":"dt_nascimento","value":"","description":"AAAA-MM-DD - data de nascimento do cliente
\n","type":"text","disabled":true},{"key":"id_faseproduto","value":"","description":"ID da fase do produto no sistema
\n","type":"text","disabled":true},{"key":"torre_produto_interesse","value":"","description":"Nome da torre de interesse
\n","type":"text","disabled":true},{"key":"unidade_produto_interesse","value":"","description":"Unidade de interesse do cliente
\n","type":"text","disabled":true},{"key":"id_usuario_exclusivo","value":"","description":"Direciona o lead para um corretor específico do sistema
\n","type":"text","disabled":true},{"key":"ip_externo","value":"","description":"O sistema captura o IP automaticamente, mas você pode deixar registrado um IP coletado pelo seu serviço (caso possua um middleware) no banco de dados. Essas informações não são exibidas no sistema.
\n","type":"text","disabled":true},{"key":"versao_politica_privacidade","value":"","description":"STRING - Código da versão de política de privacidade. Ex: V1.2-04-25
\n","type":"text","disabled":true},{"key":"cnpj","value":"","description":"CRM PARCERIAS - CNPJ do parceiro imobiliária
\n","type":"text","disabled":true},{"key":"tipo_parceiro","value":"","description":"CRM PARCERIAS - tipo do parceiro (imobiliaria ou autonomo ou autonomo_imobiliaria)
\n","type":"text","disabled":true},{"key":"creci","value":"","description":"CRM PARCERIAS - creci do parceiro
\n","type":"text","disabled":true},{"key":"area_atuacao","value":"","description":"CRM PARCERIAS - área de atuação do parceiro
\n","type":"text","disabled":true},{"key":"id_responsavel_imobiliaria","value":"","description":"CRM PARCERIAS - ID da imobiliaria do autônomo
\n","type":"text","disabled":true},{"key":"regiao_bairro[xxx]","value":"","description":"CRM PARCERIAS - em xxx do campo atual, forneça o id_regiao e o valor do campo como os bairros. Caso queira passar somente os bairros, sem região, preencha xxx como 0.\nCaso queira passar somente região, preencha o id_regional nos colchetes.
\n","type":"text","disabled":true},{"key":"campos_customizados","value":"","description":"json no formato {\"chave1\": \"valor1\", \"chave2\": \"valor2\"}
\n","type":"text","uuid":"4fb17837-aac8-4eed-94d3-8d11a6748291","disabled":true}]},"url":"https://{{subdominio}}.hypnobox.com.br/email.receber.php","description":"🚨 Ao trabalhar com o objeto de campos customizados, envie os dados sempre em body
\n","urlObject":{"protocol":"https","path":["email.receber.php"],"host":["{{subdominio}}","hypnobox","com","br"],"query":[],"variable":[]}},"response":[{"id":"f3f38351-0b0c-4bfd-85ad-98d179f788f1","name":"[1] Sucesso","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"nome","value":"João da Silva","description":"❗️Nome do lead","type":"text"},{"key":"email","value":"joao@hypnobox.email","description":"❗️E-mail do lead","type":"text"},{"key":"id_produto","value":"1","description":"❗️ID do produto no Hypnobox","type":"text"},{"key":"id_interno","value":"","description":"ID legado do produto\nSe o id_interno for fornecido, o id_produto deixa de ser obrigatório","type":"text","disabled":true},{"key":"assunto","value":"","description":"Assunto do contato","type":"text","disabled":true},{"key":"mensagem","value":"","description":"Corpo da mensagem/contato","type":"text","disabled":true},{"key":"midia","value":"Landing Page - Uselink","description":"Mídia de origem do contato/conversão","type":"text"},{"key":"id_canal","value":"","description":"ID do canal de origem","type":"text","disabled":true},{"key":"id_sub_canal","value":"","description":"ID do sub canal","type":"text","disabled":true},{"key":"ddd_residencial","value":"","description":"DDD do telefone","type":"text","disabled":true},{"key":"tel_residencial","value":"","description":"Telefone do cliente","type":"text","disabled":true},{"key":"ddd_celular","value":"","description":"DDD do cliente","type":"text","disabled":true},{"key":"tel_celular","value":"","description":"Telefone do cliente","type":"text","disabled":true},{"key":"ddd_comercial","value":"","description":"DDD do cliente","type":"text","disabled":true},{"key":"tel_comercial","value":"","description":"Telefone do cliente","type":"text","disabled":true},{"key":"ddd_outro","value":"","description":"DDD do cliente","type":"text","disabled":true},{"key":"tel_outro","value":"","description":"Telefone do cliente","type":"text","disabled":true},{"key":"denylist","value":"","description":"0 ou 1 - usado somente se o ambiente possuir o pacote LGPD","type":"text","disabled":true},{"key":"consentimento","value":"","description":"0 ou 1 - usado somente se o ambiente possuir o pacote LGPD","type":"text","disabled":true},{"key":"regional","value":"","description":"ID da regional no ambiente","type":"text","disabled":true},{"key":"descricao","value":"","description":"Descrição na ficha do cliente","type":"text","disabled":true},{"key":"valor_entrada","value":"","description":"decimal - Valor de entrada sugerida pelo cliente","type":"text","disabled":true},{"key":"renda_familiar","value":"","description":"decimal - valor da renda fornecida pelo cliente","type":"text","disabled":true},{"key":"valor_fgts","value":"","description":"decimal - valor do FGTS disponível para uso","type":"text","disabled":true},{"key":"cpf","value":"","description":"CPF do cliente","type":"text","disabled":true},{"key":"sexo","value":"","description":"M ou F - sexo do cliente","type":"text","disabled":true},{"key":"dt_nascimento","value":"","description":"AAAA-MM-DD - data de nascimento do cliente","type":"text","disabled":true},{"key":"id_faseproduto","value":"","description":"ID da fase do produto no sistema","type":"text","disabled":true},{"key":"torre_produto_interesse","value":"","description":"Nome da torre de interesse","type":"text","disabled":true},{"key":"unidade_produto_interesse","value":"","description":"Unidade de interesse do cliente","type":"text","disabled":true},{"key":"id_usuario_exclusivo","value":"","description":"Direciona o lead para um corretor específico do sistema","type":"text","disabled":true},{"key":"cnpj","value":"","description":"CRM PARCERIAS - CNPJ do parceiro imobiliária","type":"text","disabled":true},{"key":"tipo_parceiro","value":"","description":"CRM PARCERIAS - tipo do parceiro (imobiliaria ou autonomo ou autonomo_imobiliaria)","type":"text","disabled":true},{"key":"creci","value":"","description":"CRM PARCERIAS - creci do parceiro","type":"text","disabled":true},{"key":"area_atuacao","value":"","description":"CRM PARCERIAS - área de atuação do parceiro","type":"text","disabled":true},{"key":"id_responsavel_imobiliaria","value":"","description":"CRM PARCERIAS - ID da imobiliaria do autônomo","type":"text","disabled":true},{"key":"regiao_bairro[xxx]","value":"","description":"CRM PARCERIAS - em xxx do campo atual, forneça o id_regiao e o valor do campo como os bairros. Caso queira passar somente os bairros, sem região, preencha xxx como 0.\nCaso queira passar somente região, preencha o id_regional nos colchetes.","type":"text","disabled":true}]},"url":"https://{{subdominio}}.hypnobox.com.br/email.receber.php"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, POST, DELETE, OPTIONS, post, get"},{"key":"Access-Control-Max-Age","value":""},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, X-Auth-Token"},{"key":"Access-Control-Allow-Credentials","value":""},{"key":"Date","value":"Thu, 01 Jun 2023 19:28:15 GMT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"33883\",\n \"msg\": \"Mensagem do cliente novo com sucesso.\",\n \"erro\": \"NULL\",\n \"idCliente\": \"36126\",\n \"emailResponsavel\": \"corretor@hypnobox.com.br\",\n \"idResponsavel\": \"252\",\n \"consentimento\": \"0\"\n}"},{"id":"4fd13d4f-bcbd-42f0-a47f-5b55bcd4d6f1","name":"[2] Erro","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"nome","value":"João da Silva","description":"❗️Nome do lead","type":"text"},{"key":"email","value":"joao@hypnobox.email","description":"❗️E-mail do lead","type":"text"},{"key":"id_produto","value":"1","description":"❗️ID do produto no Hypnobox","type":"text","disabled":true},{"key":"id_interno","value":"","description":"ID legado do produto\nSe o id_interno for fornecido, o id_produto deixa de ser obrigatório","type":"text","disabled":true},{"key":"assunto","value":"","description":"Assunto do contato","type":"text","disabled":true},{"key":"mensagem","value":"","description":"Corpo da mensagem/contato","type":"text","disabled":true},{"key":"midia","value":"","description":"Mídia de origem do contato/conversão","type":"text","disabled":true},{"key":"id_canal","value":"","description":"ID do canal de origem","type":"text","disabled":true},{"key":"id_sub_canal","value":"","description":"ID do sub canal","type":"text","disabled":true},{"key":"ddd_residencial","value":"","description":"DDD do telefone","type":"text","disabled":true},{"key":"tel_residencial","value":"","description":"Telefone do cliente","type":"text","disabled":true},{"key":"ddd_celular","value":"","description":"DDD do cliente","type":"text","disabled":true},{"key":"tel_celular","value":"","description":"Telefone do cliente","type":"text","disabled":true},{"key":"ddd_comercial","value":"","description":"DDD do cliente","type":"text","disabled":true},{"key":"tel_comercial","value":"","description":"Telefone do cliente","type":"text","disabled":true},{"key":"ddd_outro","value":"","description":"DDD do cliente","type":"text","disabled":true},{"key":"tel_outro","value":"","description":"Telefone do cliente","type":"text","disabled":true},{"key":"denylist","value":"","description":"0 ou 1 - usado somente se o ambiente possuir o pacote LGPD","type":"text","disabled":true},{"key":"consentimento","value":"","description":"0 ou 1 - usado somente se o ambiente possuir o pacote LGPD","type":"text","disabled":true},{"key":"regional","value":"","description":"ID da regional no ambiente","type":"text","disabled":true},{"key":"descricao","value":"","description":"Descrição na ficha do cliente","type":"text","disabled":true},{"key":"valor_entrada","value":"","description":"decimal - Valor de entrada sugerida pelo cliente","type":"text","disabled":true},{"key":"renda_familiar","value":"","description":"decimal - valor da renda fornecida pelo cliente","type":"text","disabled":true},{"key":"valor_fgts","value":"","description":"decimal - valor do FGTS disponível para uso","type":"text","disabled":true},{"key":"cpf","value":"","description":"CPF do cliente","type":"text","disabled":true},{"key":"sexo","value":"","description":"M ou F - sexo do cliente","type":"text","disabled":true},{"key":"dt_nascimento","value":"","description":"AAAA-MM-DD - data de nascimento do cliente","type":"text","disabled":true},{"key":"id_faseproduto","value":"","description":"ID da fase do produto no sistema","type":"text","disabled":true},{"key":"torre_produto_interesse","value":"","description":"Nome da torre de interesse","type":"text","disabled":true},{"key":"unidade_produto_interesse","value":"","description":"Unidade de interesse do cliente","type":"text","disabled":true},{"key":"id_usuario_exclusivo","value":"","description":"Direciona o lead para um corretor específico do sistema","type":"text","disabled":true},{"key":"cnpj","value":"","description":"CRM PARCERIAS - CNPJ do parceiro imobiliária","type":"text","disabled":true},{"key":"tipo_parceiro","value":"","description":"CRM PARCERIAS - tipo do parceiro (imobiliaria ou autonomo ou autonomo_imobiliaria)","type":"text","disabled":true},{"key":"creci","value":"","description":"CRM PARCERIAS - creci do parceiro","type":"text","disabled":true},{"key":"area_atuacao","value":"","description":"CRM PARCERIAS - área de atuação do parceiro","type":"text","disabled":true},{"key":"id_responsavel_imobiliaria","value":"","description":"CRM PARCERIAS - ID da imobiliaria do autônomo","type":"text","disabled":true},{"key":"regiao_bairro[xxx]","value":"","description":"CRM PARCERIAS - em xxx do campo atual, forneça o id_regiao e o valor do campo como os bairros. Caso queira passar somente os bairros, sem região, preencha xxx como 0.\nCaso queira passar somente região, preencha o id_regional nos colchetes.","type":"text","disabled":true}]},"url":"https://{{subdominio}}.hypnobox.com.br/email.receber.php"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Expires","value":"Thu, 19 Nov 1981 08:52:00 GMT"},{"key":"Cache-Control","value":"no-store, no-cache, must-revalidate, post-check=0, pre-check=0"},{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"GET, PUT, POST, DELETE, OPTIONS, post, get"},{"key":"Access-Control-Max-Age","value":""},{"key":"Access-Control-Allow-Headers","value":"Origin, Content-Type, X-Auth-Token"},{"key":"Access-Control-Allow-Credentials","value":""},{"key":"Date","value":"Thu, 01 Jun 2023 19:27:50 GMT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"NULL\",\n \"msg\": \"NULL\",\n \"erro\": \"Id produto não fornecido\",\n \"emailResponsavel\": \"NULL\",\n \"idResponsavel\": \"NULL\"\n}"}],"_postman_id":"07e01b95-425a-487f-b93d-21ee73d41a5a"},{"name":"Chat - Vendas e Parcerias","id":"1c891cab-9156-448a-9366-1242f19354a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{subdominio}}.hypnobox.com.br/?controle=Atendimento&acao=&id_produto=&produto&nome=&email=&id_interno=®ional=&midia=&ddd_comercial=&tel_comercial=&ddd_celular=&tel_celular=&ddd_outro=&tel_outro=&ddd_residencial=&tel_residencial=&descricao=&valor_entrada=&renda_familiar=&valor_fgts=&cpf=&sexo=&dt_nascimento=&info_link=&id_sub_momento=&id_usuario_exclusivo=&produto_estado=&produto_cidade=&produto_bairro=&redirecionamento=®iao_bairro=&mensagem_site=&tipo_atendente=&consentimento","description":"Essa API permite chamar uma tela de atendimento via Chat. Você pode chamar a tela com pré-chat nativo do Hypnobox ou construir seu próprio formulário de pré-chat e redirecionar o cliente para a tela de atendimento.
\nEm todos os casos, você deve carregar a tela em uma nova aba, nova janela ou atualizar a aba atual. Nunca utilize -iframe- para se conectar à essa tela. Os parâmetros em querystring podem falhar dependendo de como são utilizados.
\nO tamanho de janela recomendada é width=497 height=674
\n","urlObject":{"protocol":"https","path":[""],"host":["{{subdominio}}","hypnobox","com","br"],"query":[{"description":{"content":"🔴 Obrigatório em todas as chamadas
\n","type":"text/plain"},"key":"controle","value":"Atendimento"},{"description":{"content":"🔴 [OBRIGATÓRIO] index = direciona para o formulário | entrar = direciona para o atendimento, se possuir todos os parâmetros obrigatórios
\n","type":"text/plain"},"key":"acao","value":""},{"description":{"content":"🔴 ID do produto No Hypnobox se o parâmetro ACAO for igual a ENTRAR
\n","type":"text/plain"},"key":"id_produto","value":""},{"description":{"content":"ID do produto se o parâmetro ACAO for igual a INDEX
\n","type":"text/plain"},"key":"produto","value":null},{"description":{"content":"[OBRIGATÓRIO] Nome do lead
\n","type":"text/plain"},"key":"nome","value":""},{"description":{"content":"[OBRIGATÓRIO] E-mail do lead
\n","type":"text/plain"},"key":"email","value":""},{"description":{"content":"ID legado do produto | se fornecido, o id_produto deixa de ser obrigatório
\n","type":"text/plain"},"key":"id_interno","value":""},{"description":{"content":"ID da regional
\n","type":"text/plain"},"key":"regional","value":""},{"description":{"content":"Mídia de origem do contato
\n","type":"text/plain"},"key":"midia","value":""},{"description":{"content":"DDD do cliente
\n","type":"text/plain"},"key":"ddd_comercial","value":""},{"description":{"content":"Telefone do cliente
\n","type":"text/plain"},"key":"tel_comercial","value":""},{"description":{"content":"DDD do cliente
\n","type":"text/plain"},"key":"ddd_celular","value":""},{"description":{"content":"Telefone do cliente
\n","type":"text/plain"},"key":"tel_celular","value":""},{"description":{"content":"DDD do cliente
\n","type":"text/plain"},"key":"ddd_outro","value":""},{"description":{"content":"Telefone do cliente
\n","type":"text/plain"},"key":"tel_outro","value":""},{"description":{"content":"DDD do cliente
\n","type":"text/plain"},"key":"ddd_residencial","value":""},{"description":{"content":"Telefone do cliente
\n","type":"text/plain"},"key":"tel_residencial","value":""},{"description":{"content":"Descrição do lead na ficha
\n","type":"text/plain"},"key":"descricao","value":""},{"description":{"content":"Valor de entrada do imóvel fornecido pelo cliente
\n","type":"text/plain"},"key":"valor_entrada","value":""},{"description":{"content":"Renda familiar do cliente
\n","type":"text/plain"},"key":"renda_familiar","value":""},{"description":{"content":"Valor do FGTS
\n","type":"text/plain"},"key":"valor_fgts","value":""},{"description":{"content":"CPF do cliente
\n","type":"text/plain"},"key":"cpf","value":""},{"description":{"content":"M ou F - sexo do cliente
\n","type":"text/plain"},"key":"sexo","value":""},{"description":{"content":"AAAA-MM-DD - data de nascimento do cliente
\n","type":"text/plain"},"key":"dt_nascimento","value":""},{"description":{"content":"Informação que aparece somente para o corretor no chat
\n","type":"text/plain"},"key":"info_link","value":""},{"description":{"content":"ID do sub momento
\n","type":"text/plain"},"key":"id_sub_momento","value":""},{"description":{"content":"ID do usuário que receberá o contato
\n","type":"text/plain"},"key":"id_usuario_exclusivo","value":""},{"description":{"content":"UF de interesse
\n","type":"text/plain"},"key":"produto_estado","value":""},{"description":{"content":"Cidade de interesse
\n","type":"text/plain"},"key":"produto_cidade","value":""},{"description":{"content":"Bairro de interesse
\n","type":"text/plain"},"key":"produto_bairro","value":""},{"description":{"content":"Precisa conter http:// - após finalizar o atendimento, o chat direciona para esse endereço.
\n","type":"text/plain"},"key":"redirecionamento","value":""},{"description":{"content":"Bairro do cliente
\n","type":"text/plain"},"key":"regiao_bairro","value":""},{"description":{"content":"boolean - 0 ou 1 - se fornecido como 1, abre um form nativo para mensagem
\n","type":"text/plain"},"key":"mensagem_site","value":""},{"description":{"content":"chatbox = Bot de chamada não atendida | botIntegracao = Bot de produto | humano = corretor
\n","type":"text/plain"},"key":"tipo_atendente","value":""},{"description":{"content":"0 ou 1 - usado somente se o ambiente possuir o pacote LGPD
\n","type":"text/plain"},"key":"consentimento","value":null}],"variable":[]}},"response":[{"id":"4867b968-4589-4ab4-aec5-dc03948a4c68","name":"Pré-chat nativo Hypnobox","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{subdominio}}.hypnobox.com.br/?controle=Atendimento&acao=index&produto=1&midia=Site Institucional","protocol":"https","host":["{{subdominio}}","hypnobox","com","br"],"path":[""],"query":[{"key":"controle","value":"Atendimento","description":"Obrigatório em todas as chamadas"},{"key":"acao","value":"index","description":"[OBRIGATÓRIO] index = direciona para o formulário | entrar = direciona para o atendimento, se possuir todos os parâmetros obrigatórios"},{"key":"id_produto","value":"","description":"ID do produto No Hypnobox se o parâmetro ACAO for igual a ENTRAR","disabled":true},{"key":"produto","value":"1","description":"ID do produto se o parâmetro ACAO for igual a INDEX"},{"key":"nome","value":"","description":"[OBRIGATÓRIO] Nome do lead","disabled":true},{"key":"email","value":"","description":"[OBRIGATÓRIO] E-mail do lead","disabled":true},{"key":"id_interno","value":"","description":"ID legado do produto | se fornecido, o id_produto deixa de ser obrigatório","disabled":true},{"key":"regional","value":"","description":"ID da regional","disabled":true},{"key":"midia","value":"Site Institucional","description":"Mídia de origem do contato"},{"key":"ddd_comercial","value":"","description":"DDD do cliente","disabled":true},{"key":"tel_comercial","value":"","description":"Telefone do cliente","disabled":true},{"key":"ddd_celular","value":"","description":"DDD do cliente","disabled":true},{"key":"tel_celular","value":"","description":"Telefone do cliente","disabled":true},{"key":"ddd_outro","value":"","description":"DDD do cliente","disabled":true},{"key":"tel_outro","value":"","description":"Telefone do cliente","disabled":true},{"key":"ddd_residencial","value":"","description":"DDD do cliente","disabled":true},{"key":"tel_residencial","value":"","description":"Telefone do cliente","disabled":true},{"key":"telefone","value":"","description":"❗️WHATSAPP - telefone do contato","disabled":true},{"key":"descricao","value":"","description":"Descrição do lead na ficha","disabled":true},{"key":"valor_entrada","value":"","description":"Valor de entrada do imóvel fornecido pelo cliente","disabled":true},{"key":"renda_familiar","value":"","description":"Renda familiar do cliente","disabled":true},{"key":"valor_fgts","value":"","description":"Valor do FGTS","disabled":true},{"key":"cpf","value":"","description":"CPF do cliente","disabled":true},{"key":"sexo","value":"","description":"M ou F - sexo do cliente","disabled":true},{"key":"dt_nascimento","value":"","description":"AAAA-MM-DD - data de nascimento do cliente","disabled":true},{"key":"info_link","value":"","description":"Informação que aparece somente para o corretor no chat","disabled":true},{"key":"id_sub_momento","value":"","description":"ID do sub momento","disabled":true},{"key":"id_usuario_exclusivo","value":"","description":"ID do usuário que receberá o contato","disabled":true},{"key":"produto_estado","value":"","description":"UF de interesse","disabled":true},{"key":"produto_cidade","value":"","description":"Cidade de interesse","disabled":true},{"key":"produto_bairro","value":"","description":"Bairro de interesse","disabled":true},{"key":"redirecionamento","value":"","description":"Precisa conter http:// - após finalizar o atendimento, o chat direciona para esse endereço.","disabled":true},{"key":"regiao_bairro","value":"","description":"Bairro do cliente","disabled":true},{"key":"mensagem_site","value":"","description":"boolean - 0 ou 1 - se fornecido como 1, abre um form nativo para mensagem","disabled":true},{"key":"tipo_atendente","value":"","description":"chatbox = Bot de chamada não atendida | botIntegracao = Bot de produto | humano = corretor | whatsapp = envia para o WhatsApp ❗Em caso de API para WhatsApp, enviar como = \"whatsapp\"","disabled":true},{"key":"canal","value":"","description":"❗Em caso de API para WhatsApp, enviar como = \"whatsapp\"","disabled":true},{"key":"subcanal","value":"","description":"❗Em caso de API para WhatsApp, enviar como = \"whatsapp\"","disabled":true},{"key":"pre_chat","value":"","description":"0 ou 1 - se o payload está vindo de um pre-chat proprio ou não","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"4c556f4b-c977-4e63-9fb4-be9ed80bb530","name":"Pré-chat externo","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{subdominio}}.hypnobox.com.br/?controle=Atendimento&acao=entrar&id_produto=1&nome=João&email=joao@hypnobox.email&midia=Site Institucional&tel_celular=11912345678","protocol":"https","host":["{{subdominio}}","hypnobox","com","br"],"path":[""],"query":[{"key":"controle","value":"Atendimento","description":"Obrigatório em todas as chamadas"},{"key":"acao","value":"entrar","description":"[OBRIGATÓRIO] index = direciona para o formulário | entrar = direciona para o atendimento, se possuir todos os parâmetros obrigatórios"},{"key":"id_produto","value":"1","description":"ID do produto No Hypnobox se o parâmetro ACAO for igual a ENTRAR"},{"key":"produto","value":"","description":"ID do produto se o parâmetro ACAO for igual a INDEX","disabled":true},{"key":"nome","value":"João","description":"[OBRIGATÓRIO] Nome do lead"},{"key":"email","value":"joao@hypnobox.email","description":"[OBRIGATÓRIO] E-mail do lead"},{"key":"id_interno","value":"","description":"ID legado do produto | se fornecido, o id_produto deixa de ser obrigatório","disabled":true},{"key":"regional","value":"","description":"ID da regional","disabled":true},{"key":"midia","value":"Site Institucional","description":"Mídia de origem do contato"},{"key":"ddd_comercial","value":"","description":"DDD do cliente","disabled":true},{"key":"tel_comercial","value":"","description":"Telefone do cliente","disabled":true},{"key":"ddd_celular","value":"","description":"DDD do cliente","disabled":true},{"key":"tel_celular","value":"11912345678","description":"Telefone do cliente"},{"key":"ddd_outro","value":"","description":"DDD do cliente","disabled":true},{"key":"tel_outro","value":"","description":"Telefone do cliente","disabled":true},{"key":"ddd_residencial","value":"","description":"DDD do cliente","disabled":true},{"key":"tel_residencial","value":"","description":"Telefone do cliente","disabled":true},{"key":"telefone","value":"","description":"❗️WHATSAPP - telefone do contato","disabled":true},{"key":"descricao","value":"","description":"Descrição do lead na ficha","disabled":true},{"key":"valor_entrada","value":"","description":"Valor de entrada do imóvel fornecido pelo cliente","disabled":true},{"key":"renda_familiar","value":"","description":"Renda familiar do cliente","disabled":true},{"key":"valor_fgts","value":"","description":"Valor do FGTS","disabled":true},{"key":"cpf","value":"","description":"CPF do cliente","disabled":true},{"key":"sexo","value":"","description":"M ou F - sexo do cliente","disabled":true},{"key":"dt_nascimento","value":"","description":"AAAA-MM-DD - data de nascimento do cliente","disabled":true},{"key":"info_link","value":"","description":"Informação que aparece somente para o corretor no chat","disabled":true},{"key":"id_sub_momento","value":"","description":"ID do sub momento","disabled":true},{"key":"id_usuario_exclusivo","value":"","description":"ID do usuário que receberá o contato","disabled":true},{"key":"produto_estado","value":"","description":"UF de interesse","disabled":true},{"key":"produto_cidade","value":"","description":"Cidade de interesse","disabled":true},{"key":"produto_bairro","value":"","description":"Bairro de interesse","disabled":true},{"key":"redirecionamento","value":"","description":"Precisa conter http:// - após finalizar o atendimento, o chat direciona para esse endereço.","disabled":true},{"key":"regiao_bairro","value":"","description":"Bairro do cliente","disabled":true},{"key":"mensagem_site","value":"","description":"boolean - 0 ou 1 - se fornecido como 1, abre um form nativo para mensagem","disabled":true},{"key":"tipo_atendente","value":"","description":"chatbox = Bot de chamada não atendida | botIntegracao = Bot de produto | humano = corretor | whatsapp = envia para o WhatsApp ❗Em caso de API para WhatsApp, enviar como = \"whatsapp\"","disabled":true},{"key":"canal","value":"","description":"❗Em caso de API para WhatsApp, enviar como = \"whatsapp\"","disabled":true},{"key":"subcanal","value":"","description":"❗Em caso de API para WhatsApp, enviar como = \"whatsapp\"","disabled":true},{"key":"pre_chat","value":"","description":"0 ou 1 - se o payload está vindo de um pre-chat proprio ou não","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"1c891cab-9156-448a-9366-1242f19354a9"},{"name":"Integração WhatsApp - receptivo","id":"7c47f6a8-f738-4d79-b906-3be0810fdabc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{subdominio}}.hypnobox.com.br/?controle=Atendimento&acao=index&nome=&email&telefone&produto&id_interno&midia&tipo_atendente=whatsapp&canal=whatsapp&subcanal=whatsapp&pre_chat&consentimento","urlObject":{"protocol":"https","path":[""],"host":["{{subdominio}}","hypnobox","com","br"],"query":[{"description":{"content":"🔴 OBRIGATÓRIO
\n","type":"text/plain"},"key":"controle","value":"Atendimento"},{"key":"acao","value":"index"},{"description":{"content":"🔴 OBRIGATÓRIO - Nome do cliente
\n","type":"text/plain"},"key":"nome","value":""},{"description":{"content":"🔴 OBRIGATÓRIO - E-mail do lead
\n","type":"text/plain"},"key":"email","value":null},{"description":{"content":"🔴 OBRIGATÓRIO - Número de WhatsApp do cliente
\n","type":"text/plain"},"key":"telefone","value":null},{"description":{"content":"🔴 OBRIGATÓRIO - ID do produto no CRM
\n","type":"text/plain"},"key":"produto","value":null},{"description":{"content":"🔴 OBRIGATÓRIO - ID do produto no CRM
\n","type":"text/plain"},"key":"id_interno","value":null},{"description":{"content":"Mídia da conversão
\n","type":"text/plain"},"key":"midia","value":null},{"description":{"content":"whatsapp = direciona para whatsapp receptivo, sem bot | whatsappbot = direciona para whatsapp com bot configurado - utilize este caso queira capturar mídia com bot de whatsapp
\n","type":"text/plain"},"key":"tipo_atendente","value":"whatsapp"},{"key":"canal","value":"whatsapp"},{"key":"subcanal","value":"whatsapp"},{"description":{"content":"boolean - se fornecido, abre o pré-chat do Hypnobox. Se não for passado e os parâmetros estiverem corretos, redireciona direto para o WhatsApp Web.
\n","type":"text/plain"},"key":"pre_chat","value":null},{"description":{"content":"0 ou 1 - usado somente se o ambiente possuir o pacote LGPD
\n","type":"text/plain"},"key":"consentimento","value":null}],"variable":[]}},"response":[{"id":"335fe7e4-de97-4eb0-91e7-252e0215fbc6","name":"Pré-chat nativo Hypnobox","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{subdominio}}.hypnobox.com.br/?controle=Atendimento&acao=index&nome=João&telefone=11912345678&produto=1&id_interno&midia=Landing Page&tipo_atendente=whatsapp&canal=whatsapp&subcanal=whatsapp","protocol":"https","host":["{{subdominio}}","hypnobox","com","br"],"path":[""],"query":[{"key":"controle","value":"Atendimento","description":"OBRIGATÓRIO"},{"key":"acao","value":"index"},{"key":"nome","value":"João","description":"OBRIGATÓRIO - Nome do cliente"},{"key":"telefone","value":"11912345678","description":"OBRIGATÓRIO - Número de WhatsApp do cliente"},{"key":"produto","value":"1","description":"OBRIGATÓRIO - ID do produto no CRM"},{"key":"id_interno","value":null,"description":"OBRIGATÓRIO - ID do produto no CRM"},{"key":"midia","value":"Landing Page","description":"Mídia da conversão"},{"key":"tipo_atendente","value":"whatsapp"},{"key":"canal","value":"whatsapp"},{"key":"subcanal","value":"whatsapp"},{"key":"pre_chat","value":null,"description":"boolean - se fornecido, abre o pré-chat do Hypnobox. Se não for passado e os parâmetros estiverem corretos, redireciona direto para o WhatsApp Web.","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"7476e6fa-0fef-4ec2-b0b1-1e578f1321d8","name":"Enviar direto para WhatsApp","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{subdominio}}.hypnobox.com.br/?controle=Atendimento&acao=index&nome=João&telefone=11912345678&produto=1&id_interno&midia=Landing Page&tipo_atendente=whatsapp&canal=whatsapp&subcanal=whatsapp&pre_chat=1","protocol":"https","host":["{{subdominio}}","hypnobox","com","br"],"path":[""],"query":[{"key":"controle","value":"Atendimento","description":"OBRIGATÓRIO"},{"key":"acao","value":"index"},{"key":"nome","value":"João","description":"OBRIGATÓRIO - Nome do cliente"},{"key":"telefone","value":"11912345678","description":"OBRIGATÓRIO - Número de WhatsApp do cliente"},{"key":"produto","value":"1","description":"OBRIGATÓRIO - ID do produto no CRM"},{"key":"id_interno","value":null,"description":"OBRIGATÓRIO - ID do produto no CRM"},{"key":"midia","value":"Landing Page","description":"Mídia da conversão"},{"key":"tipo_atendente","value":"whatsapp"},{"key":"canal","value":"whatsapp"},{"key":"subcanal","value":"whatsapp"},{"key":"pre_chat","value":"1","description":"boolean - se fornecido, abre o pré-chat do Hypnobox. Se não for passado e os parâmetros estiverem corretos, redireciona direto para o WhatsApp Web."}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"7c47f6a8-f738-4d79-b906-3be0810fdabc"},{"name":"Integração WhatsApp com bot Hypnobox","id":"48a1a1a9-d056-4eca-aca2-561104a02c92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{subdominio}}.hypnobox.com.br/?controle=Atendimento&acao=index&nome=&telefone&produto&id_interno&midia&tipo_atendente=whatsappbot&canal=whatsapp&subcanal=whatsapp&pre_chat&consentimento","urlObject":{"protocol":"https","path":[""],"host":["{{subdominio}}","hypnobox","com","br"],"query":[{"description":{"content":"🔴 OBRIGATÓRIO
\n","type":"text/plain"},"key":"controle","value":"Atendimento"},{"key":"acao","value":"index"},{"description":{"content":"🔴 OBRIGATÓRIO - Nome do cliente
\n","type":"text/plain"},"key":"nome","value":""},{"description":{"content":"🔴 OBRIGATÓRIO - Número de WhatsApp do cliente
\n","type":"text/plain"},"key":"telefone","value":null},{"description":{"content":"🔴 OBRIGATÓRIO - ID do produto no CRM
\n","type":"text/plain"},"key":"produto","value":null},{"description":{"content":"🔴 OBRIGATÓRIO - ID do produto no CRM
\n","type":"text/plain"},"key":"id_interno","value":null},{"description":{"content":"Mídia da conversão
\n","type":"text/plain"},"key":"midia","value":null},{"description":{"content":"whatsapp = direciona para whatsapp receptivo, sem bot | whatsappbot = direciona para whatsapp com bot configurado - utilize este caso queira capturar mídia com bot de whatsapp
\n","type":"text/plain"},"key":"tipo_atendente","value":"whatsappbot"},{"key":"canal","value":"whatsapp"},{"key":"subcanal","value":"whatsapp"},{"description":{"content":"boolean - se fornecido, abre o pré-chat do Hypnobox. Se não for passado e os parâmetros estiverem corretos, redireciona direto para o WhatsApp Web.
\n","type":"text/plain"},"key":"pre_chat","value":null},{"description":{"content":"0 ou 1 - usado somente se o ambiente possuir o pacote LGPD
\n","type":"text/plain"},"key":"consentimento","value":null}],"variable":[]}},"response":[{"id":"ecc5dc16-0aea-4e64-9d8b-ab7e0b22d92d","name":"Pré-chat nativo Hypnobox","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{subdominio}}.hypnobox.com.br/?controle=Atendimento&acao=index&nome=João&telefone=11912345678&produto=1&id_interno&midia=Landing Page&tipo_atendente=whatsapp&canal=whatsapp&subcanal=whatsapp","protocol":"https","host":["{{subdominio}}","hypnobox","com","br"],"path":[""],"query":[{"key":"controle","value":"Atendimento","description":"OBRIGATÓRIO"},{"key":"acao","value":"index"},{"key":"nome","value":"João","description":"OBRIGATÓRIO - Nome do cliente"},{"key":"telefone","value":"11912345678","description":"OBRIGATÓRIO - Número de WhatsApp do cliente"},{"key":"produto","value":"1","description":"OBRIGATÓRIO - ID do produto no CRM"},{"key":"id_interno","value":null,"description":"OBRIGATÓRIO - ID do produto no CRM"},{"key":"midia","value":"Landing Page","description":"Mídia da conversão"},{"key":"tipo_atendente","value":"whatsapp"},{"key":"canal","value":"whatsapp"},{"key":"subcanal","value":"whatsapp"},{"key":"pre_chat","value":null,"description":"boolean - se fornecido, abre o pré-chat do Hypnobox. Se não for passado e os parâmetros estiverem corretos, redireciona direto para o WhatsApp Web.","disabled":true}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"9778131a-5815-4310-aed1-44b1f366e3bb","name":"Enviar direto para WhatsApp","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{subdominio}}.hypnobox.com.br/?controle=Atendimento&acao=index&nome=João&telefone=11912345678&produto=1&id_interno&midia=Landing Page&tipo_atendente=whatsapp&canal=whatsapp&subcanal=whatsapp&pre_chat=1","protocol":"https","host":["{{subdominio}}","hypnobox","com","br"],"path":[""],"query":[{"key":"controle","value":"Atendimento","description":"OBRIGATÓRIO"},{"key":"acao","value":"index"},{"key":"nome","value":"João","description":"OBRIGATÓRIO - Nome do cliente"},{"key":"telefone","value":"11912345678","description":"OBRIGATÓRIO - Número de WhatsApp do cliente"},{"key":"produto","value":"1","description":"OBRIGATÓRIO - ID do produto no CRM"},{"key":"id_interno","value":null,"description":"OBRIGATÓRIO - ID do produto no CRM"},{"key":"midia","value":"Landing Page","description":"Mídia da conversão"},{"key":"tipo_atendente","value":"whatsapp"},{"key":"canal","value":"whatsapp"},{"key":"subcanal","value":"whatsapp"},{"key":"pre_chat","value":"1","description":"boolean - se fornecido, abre o pré-chat do Hypnobox. Se não for passado e os parâmetros estiverem corretos, redireciona direto para o WhatsApp Web."}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"48a1a1a9-d056-4eca-aca2-561104a02c92"},{"name":"Portais Verticais","id":"7b7e9aaa-3fe0-4a0d-95d0-c36910973e9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"http://{{subdominio}}.hypnobox.com.br/?controle=Api&acao=ExecutarNovaMsg&chave=&produto_codigo&produto_codigo_hypnobox&cliente_nome&cliente_email&cliente_ddd&cliente_telefone&cliente_assunto&cliente_mensagem","description":"Com essa API, é possível fazer com que portais que possuem integrações nativas com o Hypnobox passem a enviar leads automaticamente apenas habilitando a integração nas configurações do produto e cadastrando o ID do anúncio.
\nConfira a relação dos portais que possuem essa integração habilitada:
\nStartFragment
\nAqui está a tabela atualizada, com os portais ativos e não excluídos, além de suas respectivas chaves no formato solicitado:
\n","urlObject":{"protocol":"http","path":[""],"host":["{{subdominio}}","hypnobox","com","br"],"query":[{"key":"controle","value":"Api"},{"key":"acao","value":"ExecutarNovaMsg"},{"description":{"content":"Cada portal que possui integração nativa com Hypnobox possui uma chave única. Verifique na descrição desta API qual a chave de cada portal.
\n","type":"text/plain"},"key":"chave","value":""},{"description":{"content":"Se o código do produto/anúncio estiver cadastrado no Hypnobox, forneça o código neste parâmetro. Caso ele não esteja cadastrado, utilize o parâmetro produto_codigo_hypnobox para fornecer o ID do produto no CRM.
\n","type":"text/plain"},"key":"produto_codigo","value":null},{"description":{"content":"Se o código do produto/anúncio não estiver cadastrado, forneça aqui o ID do produto no CRM para integração. Utilize apenas um dos campos de ID de produto.
\n","type":"text/plain"},"key":"produto_codigo_hypnobox","value":null},{"description":{"content":"Nome do prospect
\n","type":"text/plain"},"key":"cliente_nome","value":null},{"description":{"content":"Email do prospect
\n","type":"text/plain"},"key":"cliente_email","value":null},{"description":{"content":"DDD do prospect
\n","type":"text/plain"},"key":"cliente_ddd","value":null},{"description":{"content":"Telefone nacional do prospect
\n","type":"text/plain"},"key":"cliente_telefone","value":null},{"description":{"content":"Assunto da mensagem
\n","type":"text/plain"},"key":"cliente_assunto","value":null},{"description":{"content":"Descrição da mensagem recebida no portal
\n","type":"text/plain"},"key":"cliente_mensagem","value":null}],"variable":[]}},"response":[],"_postman_id":"7b7e9aaa-3fe0-4a0d-95d0-c36910973e9b"}],"id":"5d1df25c-52ad-48b2-9159-4f95c8f54228","description":"Utilize a API /email.receber.php para enviar conversões de formulários. Esses leads são atribuídos aos corretores para atendimento online. Os campos dedicados ao ambiente de parcerias são aplicáveis somente se a sua aplicação possuir esse módulo ativado.
\n","_postman_id":"5d1df25c-52ad-48b2-9159-4f95c8f54228"},{"name":"Distribuidor (v1.2)","item":[{"name":"Formulário - Envio de leads","id":"585d0521-604a-4c24-a750-7e0a86d7eee4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://{{subdominio}}.hypnobox.com.br/acao/mensagem.php?codigo_interno=&produto_codigo&produto_codigo_hypnobox&nome&email&ddd&telefone&mensagem&midia=","urlObject":{"protocol":"https","path":["acao","mensagem.php"],"host":["{{subdominio}}","hypnobox","com","br"],"query":[{"description":{"content":"🔴 [OBRIGATÓRIO] código interno do produto no CRM - precisa ser igual em todos os ambientes
\n","type":"text/plain"},"key":"codigo_interno","value":""},{"description":{"content":"🔴 [OBRIGATÓRIO] ID do produto no CRM em caso de relacionamento, se possuir produto_codigo, não será obrigatório passar o codigo_interno - CONSULTE O SUPORTE PARA ENTENDER COMO SEGUIR.
\n","type":"text/plain"},"key":"produto_codigo","value":null},{"description":{"content":"🔴 [OBRIGATÓRIO] ID do produto no CRM em casos sem relacionamento, se possuir produto_codigo, não será obrigatório passar o codigo_interno - CONSULTE O SUPORTE PARA ENTENDER COMO SEGUIR.
\n","type":"text/plain"},"key":"produto_codigo_hypnobox","value":null},{"description":{"content":"🔴 [OBRIGATÓRIO] Nome do lead
\n","type":"text/plain"},"key":"nome","value":null},{"description":{"content":"🔴 [OBRIGATÓRIO] E-mail do lead
\n","type":"text/plain"},"key":"email","value":null},{"description":{"content":"DDD do cliente
\n","type":"text/plain"},"key":"ddd","value":null},{"description":{"content":"Número de telefone do cliente
\n","type":"text/plain"},"key":"telefone","value":null},{"description":{"content":"Corpo da mensagem/conversão do cliente
\n","type":"text/plain"},"key":"mensagem","value":null},{"description":{"content":"Midia da conversão para mensagem
\n","type":"text/plain"},"key":"midia","value":""}],"variable":[]}},"response":[],"_postman_id":"585d0521-604a-4c24-a750-7e0a86d7eee4"},{"name":"Chat","id":"619237ea-96e0-4141-a567-211b960e5aaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{subdominio}}.hypnobox.com.br/acao/chat.php?codigo_interno=&produto_codigo&nome&email&ddd&telefone&mensagem&midia=","description":"Utilize o endpoint /acao/chat.php se você possuir um formulário de pré-atendimento e precisar enviar o cliente direto para a fila.
\nUtilize o endpoint /chat.php se você não possui um formulário e deseja utilizar o formulário integrado do Hypnobox.
\nO tamanho recomendado para a janela aberta é de width=497 height=674
\n","urlObject":{"protocol":"https","path":["acao","chat.php"],"host":["{{subdominio}}","hypnobox","com","br"],"query":[{"description":{"content":"🔴 [OBRIGATÓRIO] código interno do produto no CRM - precisa ser igual em todos os ambientes
\n","type":"text/plain"},"key":"codigo_interno","value":""},{"description":{"content":"🔴 [OBRIGATÓRIO] ID do produto no CRM, se possuir produto_codigo, não será obrigatório passar o codigo_interno
\n","type":"text/plain"},"key":"produto_codigo","value":null},{"description":{"content":"🔴 [OBRIGATÓRIO] Nome do lead
\n","type":"text/plain"},"key":"nome","value":null},{"description":{"content":"🔴 [OBRIGATÓRIO] E-mail do lead
\n","type":"text/plain"},"key":"email","value":null},{"description":{"content":"DDD do cliente
\n","type":"text/plain"},"key":"ddd","value":null},{"description":{"content":"Número de telefone do cliente
\n","type":"text/plain"},"key":"telefone","value":null},{"description":{"content":"Corpo da mensagem/conversão do cliente
\n","type":"text/plain"},"key":"mensagem","value":null},{"description":{"content":"Midia da conversão para mensagem
\n","type":"text/plain"},"key":"midia","value":""}],"variable":[]}},"response":[],"_postman_id":"619237ea-96e0-4141-a567-211b960e5aaa"},{"name":"Portais Verticais","id":"b488afb2-65f9-4028-962b-925b2c19c326","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://{{subdominio}}.hypnobox.com.br/acao/mensagem.php?codigo_interno=&produto_codigo&produto_codigo_hypnobox&cliente_nome&cliente_email&cliente_ddd&cliente_telefone&cliente_mensagem&cliente_assunto&controle=Api&acao=ExecutarNovaMsg&chave=","description":"Se você não for um portal licenciado pela Hypnobox, utilize a API de mensagem ou entre em contato com o suporte@hypnobox.com.br
\n","urlObject":{"protocol":"https","path":["acao","mensagem.php"],"host":["{{subdominio}}","hypnobox","com","br"],"query":[{"description":{"content":"🔴 [OBRIGATÓRIO] código interno do produto no CRM - precisa ser igual em todos os ambientes
\n","type":"text/plain"},"key":"codigo_interno","value":""},{"description":{"content":"🔴 [OBRIGATÓRIO] ID do produto no CRM em casos de relacionamento, se possuir produto_codigo, não será obrigatório passar o codigo_interno
\n","type":"text/plain"},"key":"produto_codigo","value":null},{"description":{"content":"🔴 [OBRIGATÓRIO] ID do produto no CRM em casos sem relacionamento, se possuir produto_codigo, não será obrigatório passar o codigo_interno - CONSULTE O SUPORTE PARA ENTENDER COMO SEGUIR.
\n","type":"text/plain"},"key":"produto_codigo_hypnobox","value":null},{"description":{"content":"🔴 [OBRIGATÓRIO] Nome do lead
\n","type":"text/plain"},"key":"cliente_nome","value":null},{"description":{"content":"🔴 [OBRIGATÓRIO] E-mail do lead
\n","type":"text/plain"},"key":"cliente_email","value":null},{"description":{"content":"DDD do cliente
\n","type":"text/plain"},"key":"cliente_ddd","value":null},{"description":{"content":"Número de telefone do cliente
\n","type":"text/plain"},"key":"cliente_telefone","value":null},{"description":{"content":"Corpo da mensagem/conversão do cliente
\n","type":"text/plain"},"key":"cliente_mensagem","value":null},{"description":{"content":"Assunto da mensagem
\n","type":"text/plain"},"key":"cliente_assunto","value":null},{"description":{"content":"🔴 [OBRIGATÓRIO] Identifica o tipo de integração, enviar sempre como \"Api\"
\n","type":"text/plain"},"key":"controle","value":"Api"},{"description":{"content":"🔴 [OBRIGATÓRIO] Identifica o tipo de integração, enviar sempre como \"ExecutarNovaMsg\"
\n","type":"text/plain"},"key":"acao","value":"ExecutarNovaMsg"},{"description":{"content":"🔴 [OBRIGATÓRIO] .V.1.0 - portais aceitos:
\nEssa função permite consultar em todos os ambientes cadastrados no distribuidor se
um lead já existe no sistema. O distribuidor sempre deve retornar o ambiente em que o
cliente possui o cadastro mais antigo (se encontrar mais de um).
Caso o distribuidor não encontre nenhum cliente, se o disparo for realizado para
/mensagem ou /chat, ele será considerado um cliente novo.
🔴 E-mail para consulta
\n","type":"text/plain"},"key":"email","value":null}],"variable":[]}},"response":[{"id":"63e1000e-1af5-44de-bb1e-6241c80e29d5","name":"Sucesso","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{subdominio}}.hypnobox.com.br/acao/consulta.php?email=joao@hypnobox.email","protocol":"https","host":["{{subdominio}}","hypnobox","com","br"],"path":["acao","consulta.php"],"query":[{"key":"email","value":"joao@hypnobox.email","description":"E-mail para consulta"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"039b1d5e-4b27-475b-80fd-5f3b0448ab99"}],"id":"90b750a8-d317-473e-a980-48650bb0cb64","description":"A aplicação \"distribuidor\" permite distribuir proporcionalmente os leads recebidos entre ambientes Hypnobox diferentes.
\n","_postman_id":"90b750a8-d317-473e-a980-48650bb0cb64"},{"name":"Script de integração para websites","item":[],"id":"15acaef3-c087-4dde-8e22-5d9f6c8c6236","description":"O script deste documento possibilita ao usuário integrar diferentes páginas ou
websites com um ambiente Hypnobox. Os contatos serão registrados para a fila de
atendimento online de acordo com os parâmetros recebidos e configurados por meio
deste documento.
O Script foi baseado no framework bootstrap mas pode ser portado facilmente
para outros frameworks, desde que a base Jquery e Hypnobox sejam preservadas.
Como utilizar
É necessário incluir no do arquivo HTML os seguintes itens:
_head_ do documento<script src=\"https://ajax.googleapis.com/ajax/libs/jquery/2.1.3/jquery.min.js\"\ntype=\"text/javascript\"></script>\n<script src=\"http://X_AMBIENTE_X.hypnobox.com.br/web/assets/js/contato.js\"\ntype=\"text/javascript\"></script>\n<script src=\"https://maxcdn.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js\"></script>\n<link href=\"https://maxcdn.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css\"\nrel=\"stylesheet\" />\n\nbody da requisição<a data-toggle=\"modal\" class=\"btn\"\nhref=\"http://X_AMBIENTE_X.hypnobox.com.br/atendimento?controle=Atendimento&acao=index\"\ndata-target=\"#myModal\">NOME DO BOTÃO</a>\n<div class=\"modal hide fade\" id=\"myModal\" tabindex=\"-1\" role=\"dialog\" aria-labelledby=\"myModalLabel\" aria-hidden=\"true\">\n<div class=\"modal-dialog\">\n<div class=\"modal-content\" style=\"height:100vh\">\n<div class=\"modal-header\">\n<button type=\"button\" class=\"close\" id=\"close\" data-dismiss=\"modal\" aria-label=\"Close\">X</button>\n</div>\n<div class=\"modal-body\"> <input type=\"hidden\" name=\"id_produto\" id=\"id_produto\" value=\"2\">\n</div>\n</div>\n</div>\n</div>\n\nCom o conteúdo devidamente importados para o seu documento, substitua o
texto “X_AMBIENTE_X” presente nos endpoints pelo nome da empresa. Por exemplo,
se a empresa que você está trabalhando possui o ambiente
minhaempresa.hypnobox.com.br, substitua “X_AMBIENTE_X” por “minhaempresa”.
Em seguida, procure pela div com classe “modal-body”. Você encontrará uma
tag de entrada oculta com o nome “id_produto” e um valor definido. Esse valor deve
refletir o ID do produto no Hypnobox que o seu lead deve entrar para conversão.
Com esses dois itens configurados, ao clicar no botão #MyModal, você deve ver uma modal abrir com um formulário de atendimento.
\nObserve que no código fornecido acima, é possível customizar vários
parâmetros da modal como tamanho, comportamento ou aparência.
Esse script também está preparado para receber dados de campanha por meio
das UTM’s. Basta que a página em que o script se encontra receba os valores de UTM
e eles serão convertidos para o campo “mídia” do Hypnobox.
Os parâmetros de UTM aceitos são:
\nutm_source\nutm_content\nutm_medium\nutm_term\nutm_campaign\nutm_id\n\nOs alores devem sempre ser enviados como querystring.
\n","_postman_id":"15acaef3-c087-4dde-8e22-5d9f6c8c6236"},{"name":"Clientes","item":[{"name":"Adicionar comentário","id":"64676785-1e98-4f0f-bcf1-3c144024062d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id_cliente\": 0,\r\n \"id_tipo_interacao\": 0,\r\n \"comentario\": \"Aqui vai a descrição do comentário\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://{{subdominio}}.hypnobox.com.br/api/comentarios/criar?token={{token}}","description":"Crie comentários na timeline de um cliente
\nUtilize a autenticação /api/auth para obter o token e forneça ele via queryparams ou body.
\nFaça um GET para o mesmo endpoint fornecendo apenas o token para obter a lista de id_tipo_comentario disponível no ambiente selecionado.
\n","urlObject":{"protocol":"https","path":["api","comentarios","criar"],"host":["{{subdominio}}","hypnobox","com","br"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"7ca538d8-9c7e-42ff-8ad0-df18c2fa7769","name":"Adicionar comentário","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"id_cliente\": 48938,\r\n \"id_tipo_interacao\": 1,\r\n \"comentario\": \"Aqui vai a descrição do comentário\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://{{subdominio}}.hypnobox.com.br/api/comentarios/criar?token={{token}}","protocol":"https","host":["{{subdominio}}","hypnobox","com","br"],"path":["api","comentarios","criar"],"query":[{"key":"token","value":"{{token}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"message\": \"Comentário realizado com sucesso\",\n \"id_comentario\": \"118672\"\n}"}],"_postman_id":"64676785-1e98-4f0f-bcf1-3c144024062d"},{"name":"Obter lista tipo de comentário","id":"ee5fde1b-a48a-4473-b591-f5dc591e9c48","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[],"url":"https://{{subdominio}}.hypnobox.com.br/api/comentarios/criar?token={{token}}","description":"Crie comentários na timeline de um cliente
\nUtilize a autenticação /api/auth para obter o token e forneça ele via queryparams ou body.
\n","urlObject":{"protocol":"https","path":["api","comentarios","criar"],"host":["{{subdominio}}","hypnobox","com","br"],"query":[{"key":"token","value":"{{token}}"}],"variable":[]}},"response":[{"id":"e49422a1-ca47-4b5d-9597-196904d2ee01","name":"Obter lista tipo de comentário","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://{{subdominio}}.hypnobox.com.br/api/comentarios/criar?token={{token}}","protocol":"https","host":["{{subdominio}}","hypnobox","com","br"],"path":["api","comentarios","criar"],"query":[{"key":"token","value":"{{token}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"modulo_ativo\": true,\n \"interacoes_comentario\": [\n {\n \"id_tipo_interacao\": \"1\",\n \"tipo_interacao\": \"Ligação\\r\\nTelefone\"\n },\n {\n \"id_tipo_interacao\": \"3\",\n \"tipo_interacao\": \"Envio de\\r\\ne-mail\"\n },\n {\n \"id_tipo_interacao\": \"4\",\n \"tipo_interacao\": \"Informação sobre o\\r\\ncliente\"\n },\n {\n \"id_tipo_interacao\": \"5\",\n \"tipo_interacao\": \"Administrativo\"\n },\n {\n \"id_tipo_interacao\": \"1003\",\n \"tipo_interacao\": \"morada.ai\"\n },\n {\n \"id_tipo_interacao\": \"1005\",\n \"tipo_interacao\": \"AI\\r\\nCorretor\"\n }\n ]\n}"}],"_postman_id":"ee5fde1b-a48a-4473-b591-f5dc591e9c48"},{"name":"Gerenciar clientes","id":"16ab9791-2813-48fb-b48d-1b30e4bfd368","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"token\": \"{{token}}\",\n \"returnType\": \"json\",\n \"id_cliente_legado\": \"LEG-0001\",\n \"id_cliente\": \"\",\n \"nome\": \"Cliente Exemplo\",\n \"email\": \"cliente@example.com\",\n \"id_produto_interno\": \"\",\n \"id_produto\": 4050,\n \"regiao\": \"Zona Sul\",\n \"ddd_residencial\": \"11\",\n \"tel_residencial\": \"33334444\",\n \"ddd_celular\": \"11\",\n \"tel_celular\": \"999999999\",\n \"ddd_comercial\": \"11\",\n \"tel_comercial\": \"40001234\",\n \"status\": \"LIBERADO\",\n \"endereco\": \"Rua Exemplo\",\n \"cep\": \"01001-000\",\n \"numero\": \"100\",\n \"complemento\": \"Apto 12\",\n \"cidade\": \"São Paulo\",\n \"UF\": \"SP\",\n \"id_canal_origem\": 2,\n \"id_midia\": 1,\n \"id_momento\": 1,\n \"id_submomento\": null,\n \"id_temperatura\": 1,\n \"id_objetivo\": 4,\n \"sexo\": \"M\",\n \"cpf\": \"123.456.789-00\",\n \"renda_mensal\": 8000.00,\n \"fgts\": 15000.00,\n \"qtd_dependentes\": 0,\n \"rg\": \"123456789\",\n \"valor_entrada\": 50000.00,\n \"email2\": \"cliente2@example.com\",\n \"email3\": \"cliente3@example.com\",\n \"profissao\": \"Analista\",\n \"cargo\": \"Coordenador\",\n \"data_nascimento\": \"1990-01-01\",\n \"estado_civil\": \"Solteiro\",\n \"bairro\": \"Centro\",\n \"bairro_comercial\": \"Bela Vista\",\n \"cep_comercial\": \"01310-100\",\n \"cidade_comercial\": \"São Paulo\",\n \"complemento_comercial\": \"Sala 5\",\n \"conjuge_dt_nascimento\": \"1992-02-02\",\n \"conjuge_estado_civil\": \"Casado\",\n \"conjuge_profissao\": \"Arquiteta\",\n \"conjuge_renda_mensal\": \"6000.00\",\n \"conjuge_sexo\": \"F\",\n \"conjuge_cpf\": \"987.654.321-00\",\n \"data_atualização\": \"2026-03-17 19:00:00\",\n \"data_criacao\": \"2026-03-17 19:00:00\",\n \"ddd_outro\": \"11\",\n \"tel_outro\": \"988887777\",\n \"descricao\": \"Lead originado via integração.\",\n \"renda_familiar\": 14000.00,\n \"logradouro_comercial\": \"Avenida Paulista\",\n \"nome_conjuge\": \"Maria Exemplo\",\n \"numero_comercial\": \"1000\",\n \"uf_interesse\": \"SP\",\n \"cidade_interesse\": \"São Paulo\",\n \"bairro_interesse\": \"Moema\",\n \"cep_interesse\": \"04077-000\",\n \"fase_imovel\": 2,\n \"finalidade_imovel\": 2,\n \"metragem_de\": 50,\n \"metragem_ate\": 80,\n \"tipo_produto_imovel\": 7,\n \"valor_de_icidademovel\": 350000.00,\n \"valor_ate_imovel\": 650000.00,\n \"denylist\": 0,\n \"adicionar_tags\": [\n \"Alto Padrão\",\n \"Investidor\",\n \"Financeira\"\n ],\n \"remover_tags\": [\"Universitario\"]\n }","options":{"raw":{"language":"json"}}},"url":"https://{{subdominio}}.hypnobox.com.br/api/manageclients","description":"A API segue padrão RESTful e utiliza HTTPS nas requisições.
\nAs operações descritas usam os verbos GET e POST.
Todas as requisições, exceto autenticação, devem ser acompanhadas de um token de acesso.
Esse token é obtido no processo de autenticação e tem validade máxima de 10 horas.
A API suporta retorno em XML e JSON, controlado pelo parâmetro returnType.
Quando returnType não é informado, o padrão atual é XML.
Autenticar no endpoint GET /api/auth/ enviando login e password.
Receber um token de sessão para uso nas demais operações.
Enviar o token no corpo das requisições dos serviços da API.
Chamar o endpoint POST /api/manageclients para envio de prospects.
O campo status controla se o cliente pode ou não ser distribuído para corretor.
A documentação define o campo sexo com formato de um caractere.
A documentação informa os valores textuais aceitos para estado civil.
\nAlguns campos não trazem tabela de valores, mas a documentação define claramente o formato esperado.
\nEsses IDs podem ser usados nos campos fase_imovel, finalidade_imovel e tipo_produto_imovel.
Para considerar que o envio do cliente foi bem-sucedido, o campo id deve vir preenchido no retorno.
Quando isso não ocorre, a resposta pode trazer erros com id_erro e erro_desc.