Pessoas interessadas

O recurso /vis/users/$USER_ID/leads/seller permite ao vendedor obter dados de contato dos compradores interessados em suas publicações. Para receber notificações sobre os clientes interessados, você deve se inscrever no tópico VIS Leads, e após receber a notificação, consultar o recurso de /leads.

Consultar interessados nos itens do vendedor

Agora, o vendedor pode consultar todos os dados de contato dos interessados, com a possibilidade de fazer paginação utilizando o parâmetro offset, que indica a posição do primeiro elemento a ser obtido, e o parâmetro limit, que indica o número máximo de elementos a obter. Além disso, os dados podem ser filtrados por um período específico, utilizando os parâmetros date_from e date_to. Para uma pesquisa mais específica, pode utilizar o parâmetro contac_types, que representa o tipo de contato a devolver.

Chamada:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/vis/users/$USER_ID/leads/buyers?offset=$OFFSET&limit=$LIMIT&date_from=$DATE_FROM&date_to=$DATE_TO&contact_types=$CONTACT_TYPES

Exemplo:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/vis/users/806525693/leads/buyers?offset=0&limit=10&dateFrom=2023-06-15&dateTo=2023-06-22&contact_types=true&contac_types=credit,question,whatsap

Valores de entrada

Campos de la respuesta

• results: contém uma lista de resultados.
• results.id: identificador do comprador.
• results.item_id: identificador do item.
• results.name: nome do comprador. Apenas se o acesso for público.
• results.email: e-mail do comprador. Apenas se o acesso for público.
• results.phone: número de telefone do comprador. Apenas se o acesso for público.
• results.leads: contém uma lista do leads gerados pelo comprador.
• leads.uuid: deprecado (substituir por leads.id).
• leads.external_id: identificador externo do lead.
• leads.contact_type: tipo de lead.
• leads.item_id: identificador do item.
• leads.created_at: data de criação do lead.
• leads.status: estado do lead.
• paging: contém informações de paginação.
• paging.offset: posição do primeiro elemento a ser devolvido.
• paging.limit: número máximo de elementos por página.
• paging.total: número total de elementos.
• date_from: data inicial dos resultados.
• date_to: data final dos resultados.

Tipos de Leads Disponíveis (contact_types)

Importante:
Nem todos os tipos de contatos estarão disponíveis para todos os usuários. A disponibilidade de contatos pode variar de acordo com a vertical e o tipo de usuário.
• whatsapp: um comprador aperta o botão de WhatsApp.
• question: um comprador faz uma pergunta.
• whatsapp_intervention: intervenção de WhatsApp.
• call: um comprador aperta o botão de ligar.
• credit: simulação de crédito.
• quotation: cotação de real estate do imóvel.
• view: mostrar telefone no anúncio.
• schedule: agendamento em real estate.

Resposta:

{
  
    "results": [
        {
            "id": 2678328,
            "item_id": "MLA1430828018",
            "name": "John Doe",
            "email": "jhon@example.com",
            "phone": "+5491198765432",
            "leads": [
                {
                    "id": "6b4aebf8-5570-47b8-9224-c1c177621575",
                    "uuid": "6b4aebf8-5570-47b8-9224-c1c177621575",
                    "channel": "question",
                    "contact_type": "question",
                    "created_at": "2024-05-14T14:15:39Z",
                    "external_id": "12776297658",
                    "item_id": "MLA1430828018",
                    "buyer_id": 2678328,
                    "status": "active"
                }
            ]
        }
    ],
    "paging": {
        "offset": 0,
        "limit": 10,
        "total": 1
    },
    "date_from": "2024-05-14",
    "date_to": "2024-05-24"
}

Erros possíveis

Erros na busca de interessados.

Obter detalhes de um lead

Quando o Mercado Livre notifica a criação de um novo lead relacionado com os interessados, o faz mencionando o ID na mensagem, para obter o detalhe você deve utilizar este identificador no recurso /vis/leads/$LEAD_ID. O qual proporcionará o detalhe correspondente.

Chamada:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/vis/leads/$LEAD_ID

Exemplo:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/vis/leads/3f2dedf2-dfbd-4981-a726-40b13aa172ff

Valores de entrada

Campos de la respuesta

• id: identificador do contato.
• contact_type: tipo de contato.
• item_id: identificador do item.
• created_at: data em que o lead foi criado.
• external_id: identificador externo do lead.
• status: status do lead.
• buyer_id: identificador do comprador.
• name: nome do comprador. Apenas se o acesso for público.
• email: e-mail do comprador. Apenas se o acesso for público.
• phone: telefone do comprador. Apenas se o acesso for público.

Resposta: HTTP 200

{
    "id": "44115522",
    "item_id": "MLB4037459422",
    "created_at": "2024-02-14T00:00:00Z",
    "contact_type": "whatsapp",
    "external_id": "13864821",
    "status": "active",
    "buyer_id": 1091441589,
    "name": "Test Test",
    "email": "john@example.com",
    "phone": "+55 01 1111-1111"
}

Erros possíveis

Erros na pesquisa do detalhe do lead.