API do LINE

createLineMessage

Usado para enviar mensagens do LINE para os usuários

POST https://api.pushwoosh.com/json/1.3/createLineMessage

Enviar uma mensagem de texto

Mensagens simples do LINE que consistem apenas em texto simples, sem imagens ou botões. Saiba mais

Dica: Para formatação avançada e rich media, use modelos de mensagem como Flex, imagem ou carrossel.

Corpo da solicitação

Parâmetro	Tipo	Obrigatório	Descrição
`application`	string	Sim	Código do aplicativo Pushwoosh
`auth`	string	Sim	Token de acesso à API para autenticar a solicitação.
`notifications`	array de objetos	Sim	Lista de objetos de mensagem do LINE a serem enviados.
`content`	string	Sim	Texto da mensagem do LINE a ser enviada. Limite máximo de caracteres: 5000. Nota: Se ambos `preset` e `content` forem incluídos, o valor da solicitação substitui o `preset`.
`preset`	string	Não	Código do preset do LINE que você criou no Painel de Controle da Pushwoosh. Nota: Se ambos `preset` e `content` forem incluídos, o valor da solicitação substitui o `preset`.
`send_date`	string	Sim	Data e hora para enviar a mensagem. Use o formato `AAAA-MM-DD HH:mm` ou `now` para enviar imediatamente.
`devices`	array de strings	Sim	Lista de códigos de dispositivo (IDs de usuário) para os quais a mensagem do LINE será enviada.

{
    "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
        "notifications": [
            {
                "content": "test",
                "preset": "preset_code",
                "send_date":"now",
                "devices": ["XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"]
            }
        ]
    }
}

Enviar uma mensagem de imagem

Você pode enviar uma mensagem de imagem para os usuários do LINE especificando um objeto de imagem no campo de modelo da sua solicitação.

Cada mensagem de imagem requer duas URLs de imagem: uma para a imagem em tamanho real (image_url) e outra para a visualização (preview_image_url). Quando os usuários tocam na visualização, a imagem em tamanho real é aberta. Certifique-se de que ambas as URLs usem HTTPS (TLS 1.2 ou posterior) e apontem para arquivos de imagem publicamente acessíveis.

Para mais detalhes, consulte a seção Image Message na documentação da API de Mensagens do LINE.

Corpo da solicitação

Parâmetro	Tipo	Obrigatório	Descrição
`application`	string	Sim	Código do aplicativo Pushwoosh
`auth`	string	Sim	Token de acesso à API usado para autenticar a solicitação.
`notifications`	array de objetos	Sim	Lista de mensagens a serem enviadas.
`content`	string	Sim	Usado como texto alternativo ou de visualização para a mensagem. Código do preset do LINE que você criou no Painel de Controle da Pushwoosh. Nota: Se ambos `preset` e `template` forem incluídos, o `template` da solicitação é usado. Se ambos `preset` e `content` forem incluídos, o `content` da solicitação substitui o preset.
`send_date`	string	Sim	Data e hora para enviar a mensagem. Use o formato `AAAA-MM-DD HH:mm` ou `now` para enviar imediatamente.
`devices`	array de strings	Sim	Lista de códigos de dispositivo (IDs de usuário) para os quais a mensagem do LINE será enviada.
`preset`	string	Não	Código do preset do LINE que você criou no Painel de Controle da Pushwoosh. Nota: Se ambos os parâmetros `preset` e `template` forem incluídos na solicitação, os valores do `template` substituirão os definidos no preset. Se ambos `preset` e `content` forem incluídos na mesma solicitação, o `content` fornecido diretamente na solicitação substituirá o conteúdo do `preset`.
`template`	object	Sim	Modelo de layout da mensagem. Suporta múltiplos tipos de mensagem. Veja detalhes abaixo.

Parâmetros do modelo

Tipo: image

Parâmetro	Tipo	Obrigatório	Descrição
`image_url`	string	Sim	URL para a imagem em tamanho real (deve usar HTTPS). Comprimento máximo: 2000 caracteres. Formato: JPEG, PNG. Tamanho máximo: 10 MB.
`preview_image_url`	string	Sim	URL para a imagem de visualização exibida no chat (deve usar HTTPS). Comprimento máximo: 2000 caracteres. Formato: JPEG, PNG. Tamanho máximo: 1 MB.

Exemplo de solicitação

{
  "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
    "notifications": [
      {
        "content": "test",
        "send_date": "now",
        "devices": [
          "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        ],
        "preset": "preset_code",
        "template": {
          "en": {
            "image": {
              "alt_text": "some text",
              "image_url": "https://images.com/1.jpg",
              "preview_image_url": "https://images.com/1.png"
            }
          }
        }
      }
    ]
  }
}

Enviar uma mensagem de carrossel de imagens

Mensagens de carrossel de imagens permitem exibir várias imagens em um formato rolável horizontalmente. Cada imagem aparece como uma coluna separada e não clicável que os usuários podem deslizar na interface de chat do LINE.

Este formato é ideal para exibir itens, promoções ou seleções visuais de forma envolvente.

Para detalhes, consulte a seção Image Carousel Template na documentação da API de Mensagens do LINE.

Corpo da solicitação

Parâmetro	Tipo	Obrigatório	Descrição
`application`	string	Sim	Código do aplicativo Pushwoosh
`auth`	string	Sim	Token de acesso à API usado para autenticar a solicitação.
`notifications`	array de objetos	Sim	Lista de mensagens a serem enviadas.
`content`	string	Sim	Usado como texto alternativo ou de visualização para a mensagem. Nota: Se ambos `content` e `template` forem definidos, o `template` é usado. Se ambos `preset` e `content` forem incluídos na mesma solicitação, o `content` fornecido diretamente na solicitação substituirá o conteúdo do `preset`.
`send_date`	string	Sim	Data e hora para enviar a mensagem. Use o formato `AAAA-MM-DD HH:mm` ou `"now"`.
`devices`	array de strings	Sim	Lista de códigos de dispositivo (IDs de usuário) para os quais a mensagem do LINE será enviada.
`preset`	string	Não	Código do preset do LINE que você criou no Painel de Controle da Pushwoosh. Nota: Se ambos os parâmetros `preset` e `template` forem incluídos na solicitação, os valores do `template` substituirão os definidos no `preset`. Se ambos `preset` e `content` forem incluídos na mesma solicitação, o `content` fornecido diretamente na solicitação substituirá o conteúdo do `preset`.
`template`	object	Sim	Modelo de layout da mensagem. Suporta múltiplos tipos de mensagem. Veja detalhes abaixo.

Parâmetros do modelo

Tipo: image_carousel

Parâmetro	Tipo	Obrigatório	Descrição
`alt_text`	string	Sim	Texto alternativo exibido nas visualizações de push e em dispositivos não suportados. Máximo de 400 caracteres.
`columns`	array de objetos	Sim	Array de colunas de imagem (suporta de 1 a 10). Cada coluna inclui uma imagem.
`image_url`	string	Sim	URL para a imagem exibida em cada coluna do carrossel, apontando para um arquivo JPEG ou PNG publicamente acessível. Deve usar HTTPS.

Exemplo de solicitação

{
  "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
    "notifications": [
      {
        "content": "test",
        "send_date": "now",
        "devices": [
          "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        ],
        "preset": "preset_code",
        "template": {
          "en": {
            "image_carousel": {
              "alt_text": "some text",
              "columns": [
                { "image_url": "https://images.com/1.jpg" },
                { "image_url": "https://images.com/2.jpg" },
                { "image_url": "https://images.com/3.jpg" }
              ]
            }
          }
        }
      }
    ]
  }
}

Enviar uma mensagem Flex

Mensagens Flex são tipos de mensagem poderosos e personalizáveis que permitem criar layouts estruturados usando texto, imagens, botões e outros componentes. São ideais para casos de uso como recibos, cartões de produtos, menus ou qualquer conteúdo que se beneficie de uma estruturação visual.

Para enviar uma Mensagem Flex, inclua um objeto template com um payload raw dentro da sua solicitação. O layout da mensagem deve seguir a especificação de Mensagem Flex do LINE.

Dica: Você pode projetar e visualizar Mensagens Flex usando o Simulador de Mensagens Flex do LINE.

Corpo da solicitação

Parâmetro	Tipo	Obrigatório	Descrição
`application`	string	Sim	Código do aplicativo Pushwoosh
`auth`	string	Sim	Token de acesso à API usado para autenticar a solicitação.
`notifications`	array de objetos	Sim	Lista de mensagens a serem enviadas.
`content`	string	Sim	Usado como texto alternativo ou de visualização para a mensagem. Nota: Se ambos `content` e `template` forem definidos, o template é usado. Se ambos `preset` e `content` forem incluídos, o conteúdo da solicitação substitui o preset.
`send_date`	string	Sim	Quando enviar a mensagem. Use o formato `"now"` ou `AAAA-MM-DD HH:mm`.
`devices`	array de strings	Sim	Lista de tokens de dispositivo LINE (IDs de usuário) para receber a mensagem.
`preset`	string	Não	Código do preset do LINE que você criou no Painel de Controle da Pushwoosh. Nota: Se ambos `preset` e `template` forem incluídos, o template substitui o preset. Se ambos `preset` e `content` forem incluídos, o conteúdo da solicitação substitui o preset.
`template`	object	Sim	Modelo de layout da mensagem. Suporta múltiplos tipos de mensagem. Veja detalhes abaixo.

Parâmetros do modelo

Para uma Mensagem Flex, use a estrutura raw.
Tipo: raw (Flex)

Parâmetro	Tipo	Obrigatório	Descrição
`alt_text`	string	Sim	Texto alternativo exibido em notificações, visualizações de chat e citações. Máximo de 400 caracteres.
`content`	object	Sim	Layout da Mensagem Flex, estruturado usando `bubble`, `box`, `text` e outros componentes conforme a especificação Flex do LINE.

Exemplo de solicitação

{
  "request": {
    "application": "XXXXXX-XXXXXX",
    "auth": "**************************************",
    "notifications": [
      {
        "content": "test",
        "send_date": "now",
        "devices": ["XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"],
        "preset": "preset_code",
        "template": {
          "en": {
            "raw": {
              "alt_text": "My raw template",
              "content": {
                "type": "bubble",
                "body": {
                  "type": "box",
                  "layout": "vertical",
                  "contents": [
                    {
                      "type": "text",
                      "text": "RECEIPT",
                      "weight": "bold",
                      "color": "#1DB446",
                      "size": "sm"
                    }
                    // Additional components...
                  ]
                }
              }
            }
          }
        }
      }
    ]
  }
}