Este webservice se utiliza para enviar una consulta al cliente. Se solicitan y validan los datos básicos y se realiza una verificación antispam.
La consulta ingresa al Inbox de Mapaprop de la inmobiliaria (la cuenta dueña del token) como un lead, igual que una consulta enviada desde su propio sitio web. El destinatario se resuelve del token, no se envía como parámetro.
| Información del recurso | |
|---|---|
| Autenticación | Requerida (Token de API, Bearer) |
| Scope | express-base |
| HTTP Method | POST |
| Response | JSON |
| Version | 1 |
URL del recurso
https://mapaprop.app/api/action/express-v1/messages
Parámetros
| Key | Type | Required | Descripción |
|---|---|---|---|
| propertyHash | string | yes | El hash ID de la propiedad. Obtené los IDs en los servicios GET /api/action/express-v1/properties o GET /api/action/express-v1/properties/{propertyHash} |
| userAgent | string | yes | El string real del userAgent del browser. Requerido para la verificación antispam |
| referer | string | yes | El string referer de la solicitud de envío de consulta. Requerido para la verificación antispam. |
| ip | string | yes | La IP del usuario que envía la consulta. Requerida para la verificación antispam. |
| url | string | yes | La URL del aviso en tu sitio. Puede ser igual al referer. |
| name | string | yes | Nombre del usuario que envía la consulta. |
| string | or | Email del usuario que envía la consulta. Se debe enviar email o teléfono. | |
| phone | string | or | Teléfono del usuario que envía la consulta. Se debe enviar email o teléfono. |
| message | string | yes | Texto enviado por el usuario respecto a la consulta o un texto generado automáticamente legible para la agencia |
Código de ejemplo
POST /api/action/express-v1/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
Respuesta
La respuesta JSON indica si la consulta fue enviada correctamente. En caso de error, informa el motivo: la consulta está en cola de moderación por parecer spam o tiene campos inválidos.
| Objeto | Campo | Tipo | Requerido | Descripción |
|---|---|---|---|---|
| Response | success | boolean | yes | Booleano que indica si el envío fue exitoso o no |
| error | string | no | Texto que indica el tipo de error si success == false |
Ejemplo de respuesta
{
"success": false,
"error": "INVALID_EMAIL"
}