Preguntas frecuentes API

Con este artículo podrás resolver la gran mayoría de tus dudas sobre la API de Zenvia Conversion. En este link encontrarás una colección de Postman con los request disponibles en la API de Zenvia Conversion.

1 - Cómo cargar leads por medio de la API:

Al cargar un lead por la API, Zenvia Conversion devuelve un prospectId, por lo tanto ese lead pasa a ser un prospecto dentro de Zenvia Conversion.

Método: POST

Endpoint: https://api.getsirena.com/v1/lead/{industry}?api-key=XXXXXXXXXXXXX

Haz clic en cualquiera de las opciones de abajo para obtener la documentación por industria:

Ejemplo de Body para lead de Retail:

Nota: el único campo obligatorio es utmSource y algún dato de contacto (e-mail o teléfono). El resto son optativos.

{
"priority": 0,
"provider": "Webmotors",
"providerLeadId": "string",
"utmSource": "google, newsletter4, billboard, ford, bmw",
"utmMedium": "referral, organic, cpc, email, social, video",
"utmCampaign": "Christmas / New Year campaign",
"firstName": "Jorge",
"lastName": "Letona",
"phones": [
"+54 9 11 4552 0371"
],
"emails": [
"jorge.letona@example.com"
],
"category": "used",
"nin": [
{
"type": "DNI",
"number": "23345223"
}
],
"address": "Jujuy 986, 1er piso, depto. \"A\"",
"subLocality": "La Perla",
"locality": "Mar del Plata",
"region": "Buenos Aires",
"country": "Argentina",
"zipCode": "7600",
"listingTitle": "MLA 641645231 Ferrari F430 F1 Spyder Cabriolet",
"listingUrl": "https://auto.mercadolibre.com.ar/MLA-641645231-ferrari-f430-f1-spyder-cabriolet-2006-roja-excelente-permuto-JM",
"comments": "I am interested in the Honda Civic. I will like to receive information about financing. I also have a Fiat Punto as trade in vehicle. Thanks!'",
"company": "Southern Group",
"store": "Freedom Branch",
"agent": "Marcos García",
"leadId": "string",
"source": "google, newsletter4, billboard, ford, bmw",
"medium": "cpc, banner, email newsletter, form.",
"campaign": "Christmas / New Year campaign",
"product": {
"make": "Apple",
"model": "MQD32LL/A",
"detail": "13-inch MacBook Air\n1.8GHz dual-core Intel Core i5 processor\nTurbo Boost up to 2.9GHz\n8GB 1600MHz LPDDR3 memory\n128GB SSD storage1\nIntel HD Graphics 6000\n",
"sku": 6443034,
"price": {
"amount": 0,
"currency": "usd"
}
}
}

2 - Cómo suscribirse a nuestro Webhook:

Accede a la sección Integraciones, busca WebHooks Access y configura la aplicación:

Aquí podrás encontrar más info sobre webhook.

3 - Cómo enviar mensajes transaccionales a través de la API:

Accede aquí a la documentación.

En el siguiente endpoint podrás consultar los templates que puedes enviarle a un prospecto para iniciar una conversación por WhatsApp.

Método: GET

Endpoint: https://api.getsirena.com/v1/prospect/{prospectId}/messaging/channels

Documentación:

https://api.getsirena.com/docs/#operation/sendTemplateMessage

Con el siguiente endpoint podrás enviar un template para iniciar una conversación a un prospecto en Zenvia Conversion.

Método: POST

Endpoint:

https://api.getsirena.com/v1/prospect/{prospectId}/messaging/whatsapp/notification

Body:

{
"key": "string",
"parameters": {
"prospect.firstName": "Jonathan"
}
}

4 - Cómo enviar mensajes conversacionales a través de la API:

Haz click aquí para acceder a la documentación.

Con el siguiente endpoint podrás enviar un mensaje libre a un prospecto que tiene la conversación abierta o que le habló al número de WhatsApp hace menos de 24 horas.

Endpoint: https://api.getsirena.com/v1/prospect/{prospectId}/messaging/{channel}

Body:

{
"content": "Hola este es un mensaje de prueba para la documentación de Zenvia Conversion"
}

5 - Cómo transferir un cliente por API:

Accede aquí a la documentación

Con el siguiente endpoint podrás transferir un prospecto a un grupo o a otro usuario dentro de Zenvia Conversion. En el body es necesario detallar el grupo o el usuario destino.

Endpoint: https://api.getsirena.com/v1/prospect/{prospectId}/transfer

Body:

{
"group": "string",
"user": "string"
}

Los users disponibles dentro de una cuenta se consiguen haciendo un GET a este endpoint.