PROD

Este serviço é usado para enviar uma consulta ao cliente. Os dados básicos são solicitados e validados, e também é realizada verificação anti-spam.

Informações do recurso
AutenticaçãoRequired
Método HTTPPOST
RespostaJSON
Versão1

URL do recurso

https://mapaprop.app/api/action/portal-v2/messages

Parâmetros

ChaveTipoObrigatórioDescrição
propertyHashstringyesO hash ID do imóvel. Obtenha os IDs em GET /api/action/express-v1/properties ou GET /api/action/express-v1/properties/{propertyHash}
userAgentstringyesA string userAgent real do navegador do usuário. Obrigatório para verificação anti-spam.
refererstringyesA string referer da requisição de envio da consulta. Obrigatório para verificação anti-spam.
ipstringyesO IP do usuário que está enviando a consulta. Obrigatório para verificação anti-spam.
urlstringyesA URL do anúncio no seu site. Pode ser igual ao referer.
namestringyesNome do usuário que está enviando a consulta.
emailstringorE-mail do usuário que está enviando a consulta. É necessário enviar e-mail ou telefone.
phonestringorTelefone do usuário que está enviando a consulta. É necessário enviar e-mail ou telefone.
messagestringyesTexto enviado pelo usuário sobre a consulta ou texto gerado automaticamente legível para a agência.

Exemplo de chamada

POST /api/action/portal-v2/messages HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}

propertyHash=32ojflsdfjasld-avC&
userAgent=Mozilla%2F5.0%20%28X11%3B%20Linux%20x86_64%29%20AppleWebKit%2F537.36%20%28KHTML%2C%20like%20Gecko%29%20Chrome%2F32.0.1700.77%20Safari%2F537.36
&referer=http%3A%2F%2Ftrovit.com%2Fad%3Fid%3D111
&ip=85.33.65.69&domain=someinmo.com&url=http%3A%2F%2Fsomeinmo.com%2Fad%3Fid%3D111
&name=John%20Doe&phone=6667117&message=Want%20to%20know%20more%20about%20this

Resposta

A resposta JSON indicará se a consulta foi enviada com sucesso. Caso contrário, informará o que aconteceu, se está na fila de moderação por suspeita de spam ou se há campos inválidos.

ObjetoCampoTipoObrigatórioDescrição
ResponsesuccessbooleanyesBooleano indicando se o envio foi bem-sucedido
errorstringnoTexto indicando o tipo de erro quando success == false

Exemplo de resposta

{
    "success": false,
    "error": "INVALID_EMAIL"
}