Vendemas Lead Api

La siguiente documentación explica como registrar un lead en la base de datos de Vendemás y como poder registrar las interacciones (llamadas) realizadas a dicho lead, para indicar si se pudo obtener comunicación con éste La ruta del ambiente de pruebas es http://leads.vendemasdev.pe/vm-leads-ws/rest/leads/save Credenciales (Basic Autentication) Usuario : usr_test Clave : rdsf31

Registro de Lead

POST /rest/leads/save

Conversion de Lead

POST /rest/leads/conversion

POST /rest/leads/save

Registra un Nuevo Lead en Base de Datos.

Request body

application/json

lead

WSRegistroLeadRequest

Responses

200 200

Ejecución completa.

Body

application/json;charset=UTF-8

WSRegistroLeadResponse

201 201

Created

application/json;charset=UTF-8

401 401

No permitido.

application/json;charset=UTF-8

403 403

Forbidden

application/json;charset=UTF-8

404 404

Not Found

application/json;charset=UTF-8

POST /rest/leads/conversion

Registra la conversión del Lead a [S] en caso se haya realizado y además registra los intentos de conversión (llamadas)

Request body

application/json

WSConversionRequest

Responses

200 200

Ejecución completa.

Body

application/json;charset=UTF-8

WSConversionResponse

201 201

Created

application/json;charset=UTF-8

401 401

No permitido.

application/json;charset=UTF-8

403 403

Forbidden

application/json;charset=UTF-8

404 404

Not Found

application/json;charset=UTF-8

Estructura de la respuesta de registro de conversion

Object

string required

Código de la respuesta, sera el id de lead en la base de datos de VendeMas, o -1 si no se pudo actualizar el lead

message

string required

Descripcion del resultado de la operacion

Estructura principal de la Conversión

Object

fechaHoraLlamada

string required

Fecha y hora de la llamada realizada al lead, debe ser enviada con el siguiente formato: dd/MM/yyyy HH:mm, las horas en formato 24 horas, en caso sea nulo o vacio se registra la fecha y hora del sistema.

flagContestado

string required

Indicador si el lead contesto la llamada telefónica, puede tomar los valores [S] Si - [N] No

Enumeration:

flagConversion

string required

Indicador si se realizó la conversión del lead, puede tomar los valores [S] Si el lead se convirtió en cliente - [N] cuando el lead no acepto la conversión - [P] cuando el lead acepta la llamada pero pospone la conversión

Enumeration:

idLead

string required

Código del Lead en la base de datos de VendeMás

Estructura principal de un Lead

Object

aceptarPoliticas

string

SI / NO

adCampaign

string

Campaña

adContent

string

Contenido del Lead

adSource

string

Fuente del Lead

adTerm

string

Terminos del Lead

apellidos

string

Apellidos del Lead

celular

string required

Celular del Lead

ciudad

string

Ciudad del Lead

dataSource

string

DataSource del Lead

descripcion

string

Descripción del Lead

dni

string

Número de Documento de Identidad del Lead

string required

Email del Lead

fechaLead

string required

Fecha del Lead

idCanal

string

Identificador del medio por donde viene el lead, si no se especifica al registrar tomara el valor del medio principal indicado por Vendemas

string

Dirección IP del Lead

nombres

string required

Nombres del Lead

recibirNovedades

string

SI / NO

ruc

string

RUC del lead

tipoDocPersona

string

Tipo de documento de la persona

tipoPersona

string

Tipo persona (Natural o empresa)

tipoProducto

string

Poket, Poket Pro, Vendemas Full

variante

string

Variante del Lead

Estructura de respuesta de registro de lead

Object

string required

Código de la respuesta, sera el id de lead en la base de datos de VendeMas, o -1 si no se pudo registrar

message

string required

Descripcion del resultado de la operacion