Ajuda

Você poderá criar modelos para envios pelo WhatsApp de forma programática utilizando a nossa API de gestão de contatos e campanhas, utilize os métodos abaixo para começar a criar conteúdo em nossa plataforma de envio de WhatsApp Marketing.

Para se integrar à API é necessário que você esteja autenticado e para isso é importante que você tenha acesso ao artigo "Como se integrar a API da MailerWeb?"

Passo 1 - Criando um Modelo de Mensagens para WhatsApp

Com esse método você poderá criar modelos de mensagens, inclusive com variáveis personalizadas. Para criar variáveis personalizadas consulte "Como criar um Campo Personalizado".

Para interagir com o Modelo de Mensagem para WhatsApp, vamos criar o objeto com o seguinte endpoint e parâmetros:

• Campo "name" é utilizado para apenas identificar o nome da mensagem, não será exibido ao destinatário
• Campo "content" é utilizado para colocar o conteúdo da mensagem a ser enviada, podendo inclusive contendo variáveis personalizadas.
• Campo "media" é utilizado para inserir media a ser enviada, nesse caso imagens até 250 kb, PDF ou vídeos até 1,5 MB. Se colocado o envio de arquivos de PDF o conteúdo da mensagem será ignorado.

Os campos personalizados sempre conterão o formato {{variavel}} e podem ser incluidos tanto no assunto como no corpo da mensagem.

POST: /api/v1/campaigns/whatsapp_template/

data = {
   'name': 'Isso é um teste',
   'content': 'Olá {{name}} isso é um teste',
   'media': 'https://www.seusite.com.br/suaimagem.gif'
}

curl --dump-header - -H "Content-Type: application/json" \ -H "Authorization: ApiKey username:API_KEY"\ -X POST --data data https://painel.mailerweb.com.br/api/v1/campaigns/whatsapp_template/ 

O resultado esperado será semelhante ao JSON abaixo:

{
    "date_created": "2020-10-27",
    "content": 'Olá {{name}} isso é um teste',
    "id": id-do-modelo-de-mensagem, 
    "last_updated": "2020-10-27", 
    "name": "Isso é um teste", 
    "resource_uri": "/api/v1/campaigns/whatsapp_template/id-do-modelo-de-mensagem/", 
    "media": 'https://www.seusite.com.br/suaimagem.gif'
}

Repare que o ID da Modelo de Mensagem está no atributo ID e no atributo resource_url, onde você poderá acessar os detalhes da lista a partir do endpoint entregue por esse parâmetro. A partir de agora, grave esse ID, ele será utilizado para você relacionar as campanhas no momento que for criar uma.

Abaixo segue as variações de erros que podem acontecer ao tentar incluir um modelo de e-mail:

• O campo content é obrigatório e não pode estar em branco
• Caso coloque um content superior a 2000 caracteres, ao iniciar uma campanha, esta será cancelada
• O criar um modelo com um arquivo PDF, o campo content será ignorado quado enviada a mensagem.

Agora que você está de posse do ID da do Modelo de E-mail, vamos ao Passo 2

Passo 2 - Listando os Modelos de Mensagens para WhatsApp

Para visualizar todos os modelos de e-mails criados em sua conta, utilize o método abaixo:

GET: /api/v1/campaigns/whatsapp_template/

curl --dump-header - -H "Content-Type: application/json" \ -H "Authorization: ApiKey username:API_KEY"\ -X GET --data data https://painel.mailerweb.com.br/api/v1/campaigns/whatsapp_template/ 

O resultado será semelhante a esse

{
    "meta": {
        "limit": 10,
        "next": "/api/v1/campaigns/email_template/?limit=10&offset=10",
        "offset": 0,
        "previous": null,
        "total_count": 1
    },
    "objects": [
        {
           "date_created": "2020-10-27",
           "content": 'Olá {{name}} isso é um teste',
           "id": id-do-modelo-de-mensagem, 
           "last_updated": "2020-10-27", 
           "name": "Isso é um teste", 
           "resource_uri": "/api/v1/campaigns/whatsapp_template/id-do-modelo-de-mensagem/", 
           "media": 'https://www.seusite.com.br/suaimagem.gif'
        }
    ]
}   

Importante notar que será exibido um objeto no formato JSON, onde virão 2 dicionários: meta e objects, a saber:

• Em "meta" você terá uma visão geral de quantos objetos você possui e ainda o link da próxima página do objeto, isso estará no atributo "next" do dicionário;
• Em objects, você terá um detalhe completo do objeto carregado no campo resource_uri, terá o link para chamar para a atualização desse objeto.

Você também poderá consultar objetos de acordo com os atributos existentes nesse formulário, por exemplo:

Listando os modelos por nome:

GET: /api/v1/campaigns/whatsapp_template/?name=teste

curl --dump-header - -H "Content-Type: application/json" \ -H "Authorization: ApiKey username:API_KEY"\ -X GET --data data https://painel.mailerweb.com.br/api/v1/campaigns/whatsapp_template/?name=teste 

Passo 3 - Atualizando um Modelo de Mensagem para WhatsApp

Para atualizar o modelo de mensagem para WhatsApp, basta procurar o modelo por ID e realizar o seguinte post:

PATCH: /api/v1/campaigns/whatsapp_template/XXX58/

data = {
   'content': 'Olá {{name}} isso é NÃO um teste',  # Nesse caso vamos atualizar apenas um campo
}

curl --dump-header - -H "Content-Type: application/json" \ -H "Authorization: ApiKey username:API_KEY"\ -X PATCH --data data https://painel.mailerweb.com.br/api/v1/campaigns/email_template/XXX58/ 

O resultado entregue será algo semelhante:

{
    "date_created": "2020-10-27",
    "content": 'Olá {{name}} isso é NÃO um teste'
    "id": id-do-modelo-de-mensagem, 
    "last_updated": "2020-10-27", 
    "name": "Isso é um teste", 
    "resource_uri": "/api/v1/campaigns/whatsapp_template/XXXX58/", 
    "media": 'https://www.seusite.com.br/suaimagem.gif'
}

Através de nossa API você conseguirá criar modelos de e-mail direto de sua aplicação sem a necessidade de utilizar o nosso painel de controle.