Leads Api

Conjunto de APIs para registrar Leads en la base de datos de Vendemás y a su vez medir las interracciones (llamadas) realizadas por lead a fin de medir la calidad de éstos
Operaciones

Las operaciones que podemos realizar en el API de Leads tienen la siguiente ruta base

https://api-leads.qa.vmas.com.pe

La autenticacion es a traves de Basic Autentication

Usuario : usr_test
Clave : rdsf31

POST /v1/registrar
POST /v1/conversion
Registro de Lead
POST /v1/registrar

Registra un nuevo lead en base de datos, la ruta del api es :

https://api-leads.qa.vmas.com.pe/v1/registrar

Request body

application/json

Estructura de petición de registro

Examples

Ejemplo de lead

{
    "aceptarPoliticas": "S",
    "adCampaign": "Conversion+-+Stories+-+Landing+-+Promo149+0319",
    "adContent": "cpospromo-fimagen-d290319",
    "adSource": "facebook",
    "adTerm": "Leads+VendeMas+no+convertidos",
    "apellidos": "Perez",
    "celular": "999999999",
    "ciudad": "Lima",
    "dataSource": "LandingVendeMas",
    "descripcion": "Registro de prueba",
    "dni": "12345678",
    "email": "correo@gmail.com",
    "fechaLead": "25/05/19 02:09PM",
    "idCanal": "1",
    "ip": "127.0.0.1",
    "nombres": "Jose",
    "recibirNovedades": "S",
    "ruc": "10123456781",
    "tipoDocPersona": "DNI",
    "tipoPersona": "N",
    "tipoProducto": "2",
    "variante": "Vendemás GIF TARJETAS"
    "nroCuenta": "2233423422",
    "nombreBanco": "Interbank",
    "nombreEjecutivo": "Miguel Salazar",
    "nroTransaccion": "3242345231"
}

Responses

200 200

Ejecución completa.

Body
application/json;charset=UTF-8

Estructura de respuesta de registro

Examples

Lead registrado satisfactoriamente

{
    "id": "32378",
    "message": "Registrado en BD"
}
401 401

No permitido.

Body
application/json;charset=UTF-8

Credenciales no válias

Conversion de Lead
POST /v1/conversion

Registra la conversión del lead a [S] en caso se haya realizado y además registra los intentos de conversión (llamadas), la ruta del api es :

https://api-leads.qa.vmas.com.pe/v1/conversion

Request body

application/json

Estructura de petición de conversión

Examples

Llamada no contestada

{
    "idLead": "122341",
    "fechaHoraLlamada": "05/02/2021 14:06",
    "flagContestado": "N",
    "flagConversion": "N",
    "idDescripcion": "29"
}

Llamada contestada con flagConversion de “NO CONVIRTIÓ”

{
    "idLead": "122341",
    "fechaHoraLlamada": "05/02/2021 14:06",
    "flagContestado": "S",
    "flagConversion": "N",
    "idDescripcion": "13"
}

Llamada contestado con flagConversion de “POSPUSO”

{
    "idLead": "122341",
    "fechaHoraLlamada": "05/02/2021 14:06",
    "flagContestado": "N",
    "flagConversion": "p",
    "idDescripcion": "30"
}

Llamada contestada con flagConversion de “SI”

{
    "idLead": "122341",
    "fechaHoraLlamada": "05/02/2021 14:06",
    "flagContestado": "S",
    "flagConversion": "S",
    "idDescripcion": "2"
}

Llamada de lead que no corresponde

{
    "idLead": "122341",
    "fechaHoraLlamada": "05/02/2021 14:06",
    "flagContestado": "S",
    "flagConversion": "Y",
    "idDescripcion": "33"
}

Responses

200 200

Ejecución completa.

Body
application/json;charset=UTF-8

Estructura de respuesta de conversión

Examples

Llamada no contestada

{
    "id": "619",
    "message": "Llamada no contestada"
}

Llamada contestada con flagConversion de “NO CONVIRTIÓ”

{
    "id": "619",
    "message": "Llamada Contestada - Lead rechazó la conversión"
}

Llamada contestado con flagConversion de “POSPUSO”

{
    "id": "619",
    "message": "Llamada Contestada - Lead pospuso la conversión"
}

Llamada contestada con flagConversion de “SI”

{
    "id": "619",
    "message": "Llamada Contestada - Lead se convirtió en Cliente"
}

Llamada con flag de conversión “No corresponde”

{
    "id": "130",
    "message": "Llamada Contestada - Lead no corresponde"
}
401 401

No permitido.

Body
application/json;charset=UTF-8

Credenciales incorrectas

Estructuras de Entrada y Salida

Las estructuras a enviar y recibir son las siguientes

WSRegistroRequest

Estructura principal de un Lead

Object
aceptarPoliticas
string

Decide aceptar politicas

Enumeration:
S

SI

N

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

email
string required

Email del Lead

fechaLead
string required

Fecha del Lead

Pattern: dd/MM/yyyy HH:mm(Am/pm)
Example:
25/05/19 02:09PM
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, para el desarrollo usar “idCanal” : 1

Enumeration:
1

Manya-Masivo

2

Attach-Masivo

3

Attach-Corporativo

4

Attach-Genérico

5

Attach-Banco

6

Cleverclick

7

Facebook Lead Ad

8

CPGoogle

9

LeadGenLinkedin

ip
string

Dirección IP del Lead

nombres
string required

Nombres del Lead

recibirNovedades
string

Decide recibir novedades

Enumeration:
S

SI

N

NO

ruc
string

RUC del lead

tipoDocPersona
string

Tipo de documento de la persona :DNI,CE

Enumeration:
DNI

Documento Nacional de Identidad de Perú

CE

Carnet de Extranjeria

tipoPersona
string

Tipo persona

Enumeration:
N

Natural

E

Empresa

tipoProducto
string

Productos vendidos por Vendemás

Enumeration:
1

Poket

2

Poket Pro

4

Vendemás Full

variante
string

Variante del Lead

nroCuenta
string

Nro de cuenta bancaria

Example:
2233423422
nombreBanco
string

Nombre del banco

Example:
Interbank
nombreEjecutivo
string

Nombre del ejecutivo

Example:
Miguel Salazar
nroTransaccion
string

Numero de transaccion

Example:
3242345231
WSRegistroResponse

Estructura de respuesta de registro de lead

Object
id
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

WSConversionRequest

Estructura principal de la Conversión

Object
idLead
string required

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

Example:
122341
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.

Example:
05/02/2021 14:06
flagContestado
string required

Indicador si el lead contesto la llamada telefónica, puede tomar los valores:

Enumeration:
S

SI

N

NO

flagConversion
string required

Indicador si se realizó la conversión del lead, puede tomar los valores

Enumeration:
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

Y

No Corresponde

idDescripcion
string

Descripcion de la tipificacion

Enumeration:
1

Poket

2

Poket Pro

4

Vendemas Full

5

Pago Link

6

Pago Web

7

Pago App

8

Pos

9

Pago Programado

10

QR Niubiz

11

Otros Productos

12

Productos Digitales

13

Cliente volver a llamar / evalua costo

14

Cliente solo desea informacion/beneficios

15

Afiliado por otro canal

16

Desconfianza en el producto

17

Desconfianza en el medio de pago

18

Solicita prestamo vendemas

19

Equipo a menor precio en redes

20

Condiciones tecnicas

21

Sin cobertura delivery

22

RUC Inactivo / Sin ruc / sin dni / sin negocio

23

Consulta con tercero

24

Cliente lo comprará en tienda fisica

25

Contratará con otra empresa

26

Se afiliará por web

27

Desea poket en dolares

28

Tiene producto Izipay

29

No responde

30

No contactó sistema

31

Teléfono no existe

32

Cliente no quiere que lo llamen

33

Cliente no ingresó a pagina web

100

Prueba/otros

WSConversionResponse

Estructura de la respuesta de registro de conversion

Object
id
string required

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

message
string required

Descripcion del resultado de la operacion