Com este artigo você poderá resolver a grande maioria de suas dúvidas sobre o API sereia.

Neste link você encontrará uma coleção de Postman com as request disponíveis no API de Sirena.



1. Como carregar leads usando o API

Quando você carrega um lead pelo API, Sirena retorna um prospectId, de modo que esse lead se torna uma prospecto dentro de Sirena.

Método: POST

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

Clique em qualquer uma das opções abaixo para obter documentação por indústria:

· Retail

· Insurance

· Automotive

· SavingPlan

· Real Estate

Exemplo de Body para lead: de Retail:

Nota: O único campo necessário é utmSource e algum dado de contato (e-mail ou telefone). O resto é opcional.

{
"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. Como se inscrever a nosso Webhook

Aqui você poderá encontrar mais informações sobre webhook:

Método: POST

Endpoint: https://api.getsirena.com/v1/notifications/subscriptions?api-key=XXXXXXXX

Exemplo:

Body:
{
"topics":[
"quotes",
"prospects",
"interactions"
],
"callbackUrl": "DetallarURL",
"format": "application/json"
}

3. Como enviar mensagens transacionais através do API:

Acesse aquí a documentação.

No próximo endpoint você poderá verificar os modelos que você pode enviar a um prospecto para iniciar uma conversa pelo WhatsApp.

Método: GET

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

Documentação:

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

Com o próximo endpoint, você poderá enviar um modelo para iniciar uma conversa a um prospecto em Sirena.

Método: POST

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

Body:

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

4. Como enviar mensagens conversacionais através do API

Clique aqui para acessar a documentação.

Com o seguinte endpoint você poderá enviar uma mensagem livre a um prospecto que tem a conversa aberta ou que falou com você pelo número de WhatsApp há 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 Sirena"
}

5. Como transferir um cliente pelo API

Acesse aqui a documentação.

Com o seguinte endpoint, você poderá transferir um prospecto a um grupo ou a outro usuário dentro de Sirena. No body é necessário detalhar o grupo ou o usuário de destino.

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

Body:

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

Os usuários disponíveis dentro de uma conta são alcançados realizando um GET neste endpoint.

Acesse aqui a documentação aqui.

Encontrou a sua resposta?