API LINE

Note

Avant d’envoyer des messages LINE, assurez-vous que la plateforme Line est correctement configurée. En savoir plus

createLineMessage

Utilisé pour envoyer des messages LINE aux utilisateurs

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

Envoyer un message texte

Messages LINE simples qui ne contiennent que du texte brut, sans images ni boutons. En savoir plus

Conseil : Pour une mise en forme avancée et des médias riches, utilisez des modèles de message comme Flex, image ou carrousel.

Corps de la requête

Paramètre	Type	Requis	Description
application	string	Oui	Code d’application Pushwoosh
auth	string	Oui	Jeton d’accès à l’API pour authentifier la requête.
notifications	array of objects	Oui	Liste des objets de message LINE à envoyer.
content	string	Oui	Texte du message LINE à envoyer. Limite maximale de caractères : 5000. Remarque : Si preset et content sont tous deux inclus, la valeur de la requête remplace le preset.
preset	string	Non	Code du preset LINE que vous avez créé dans le Panneau de Contrôle Pushwoosh. Remarque : Si preset et content sont tous deux inclus, la valeur de la requête remplace le preset.
send_date	string	Oui	Date et heure d’envoi du message. Utilisez le format AAAA-MM-JJ HH:mm ou now pour un envoi immédiat.
devices	array of strings	Oui	Liste des codes d’appareil (ID utilisateur) auxquels envoyer le message LINE.

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

Envoyer un message image

Vous pouvez envoyer un message image aux utilisateurs de LINE en spécifiant un objet image dans le champ template de votre requête.

Chaque message image nécessite deux URL d’image : une pour l’image en taille réelle (image_url) et une autre pour l’aperçu (preview_image_url). Lorsque les utilisateurs appuient sur l’aperçu, l’image en taille réelle s’ouvre. Assurez-vous que les deux URL utilisent le protocole HTTPS (TLS 1.2 ou version ultérieure) et pointent vers des fichiers image accessibles au public.

Pour plus de détails, consultez la section Message Image dans la documentation de l’API de messagerie LINE.

Corps de la requête

Paramètre	Type	Requis	Description
application	string	Oui	Code d’application Pushwoosh
auth	string	Oui	Jeton d’accès à l’API utilisé pour authentifier la requête.
notifications	array of objects	Oui	Liste des messages à envoyer.
content	string	Oui	Utilisé comme texte de repli ou d’aperçu pour le message. Code du preset LINE que vous avez créé dans le Panneau de Contrôle Pushwoosh. Remarque : Si preset et template sont tous deux inclus, le template de la requête est utilisé. Si preset et content sont tous deux inclus, le content de la requête remplace le preset.
send_date	string	Oui	Date et heure d’envoi du message. Utilisez le format AAAA-MM-JJ HH:mm ou now pour un envoi immédiat.
devices	array of strings	Oui	Liste des codes d’appareil (ID utilisateur) auxquels envoyer le message LINE.
preset	string	Non	Code du preset LINE que vous avez créé dans le Panneau de Contrôle Pushwoosh. Remarque : Si les paramètres preset et template sont tous deux inclus dans la requête, les valeurs du template remplaceront celles définies dans le preset. Si preset et content sont tous deux inclus dans la même requête, le content fourni directement dans la requête remplacera le contenu du preset.
template	object	Oui	Modèle de mise en page du message. Prend en charge plusieurs types de messages. Voir les détails ci-dessous.

Paramètres du modèle

Type : image

Paramètre	Type	Requis	Description
image_url	string	Oui	URL de l’image en taille réelle (doit utiliser HTTPS). Longueur max : 2000 caractères. Format : JPEG, PNG. Taille max : 10 Mo.
preview_image_url	string	Oui	URL de l’image d’aperçu affichée dans le chat (doit utiliser HTTPS). Longueur max : 2000 caractères. Format : JPEG, PNG. Taille max : 1 Mo.

Exemple de requête

{
  "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"
            }
          }
        }
      }
    ]
  }
}

Envoyer un message carrousel d’images

Les messages carrousel d’images vous permettent d’afficher plusieurs images dans un format à défilement horizontal. Chaque image apparaît comme une colonne distincte non cliquable que les utilisateurs peuvent faire défiler dans l’interface de chat LINE.

Ce format est idéal pour présenter des articles, des promotions ou des sélections visuelles de manière engageante.

Pour plus de détails, consultez la section Modèle de carrousel d’images dans la documentation de l’API de messagerie LINE.

Corps de la requête

Paramètre	Type	Requis	Description
application	string	Oui	Code d’application Pushwoosh
auth	string	Oui	Jeton d’accès à l’API utilisé pour authentifier la requête.
notifications	array of objects	Oui	Liste des messages à envoyer.
content	string	Oui	Utilisé comme texte de repli ou d’aperçu pour le message. Remarque : Si content et template sont tous deux définis, le template est utilisé. Si un preset et un content sont tous deux inclus dans la même requête, le content fourni directement dans la requête remplacera le contenu du preset.
send_date	string	Oui	Date et heure d’envoi du message. Utilisez le format AAAA-MM-JJ HH:mm ou "now".
devices	array of strings	Oui	Liste des codes d’appareil (ID utilisateur) auxquels envoyer le message LINE.
preset	string	Non	Code du preset LINE que vous avez créé dans le Panneau de Contrôle Pushwoosh. Remarque : Si les paramètres preset et template sont tous deux inclus dans la requête, les valeurs du template remplaceront celles définies dans le preset. Si un preset et un content sont tous deux inclus dans la même requête, le content fourni directement dans la requête remplacera le contenu du preset.
template	object	Oui	Modèle de mise en page du message. Prend en charge plusieurs types de messages. Voir les détails ci-dessous.

Paramètres du modèle

Type : image_carousel

Paramètre	Type	Requis	Description
alt_text	string	Oui	Texte de repli affiché dans les aperçus des notifications push et sur les appareils non pris en charge. 400 caractères maximum.
columns	array of objects	Oui	Tableau de colonnes d’images (1 à 10 prises en charge). Chaque colonne inclut une image.
image_url	string	Oui	URL de l’image affichée dans chaque colonne du carrousel pointant vers un fichier JPEG ou PNG accessible au public. Doit utiliser HTTPS.

Exemple de requête

{
  "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" }
              ]
            }
          }
        }
      }
    ]
  }
}

Envoyer un message Flex

Les messages Flex sont des types de messages puissants et personnalisables qui vous permettent de créer des mises en page structurées à l’aide de texte, d’images, de boutons et d’autres composants. Ils sont idéaux pour des cas d’utilisation tels que les reçus, les fiches produits, les menus ou tout contenu qui bénéficie d’une structuration visuelle.

Pour envoyer un message Flex, incluez un objet template avec une charge utile raw dans votre requête. La mise en page du message doit suivre la spécification des messages Flex de LINE.

Conseil : Vous pouvez concevoir et prévisualiser les messages Flex à l’aide du Simulateur de messages Flex de LINE.

Corps de la requête

Paramètre	Type	Requis	Description
application	string	Oui	Code d’application Pushwoosh
auth	string	Oui	Jeton d’accès à l’API utilisé pour authentifier la requête.
notifications	array of objects	Oui	Liste des messages à envoyer.
content	string	Oui	Utilisé comme texte de repli ou d’aperçu pour le message. Remarque : Si content et template sont tous deux définis, le modèle est utilisé. Si preset et content sont tous deux inclus, le contenu de la requête remplace le preset.
send_date	string	Oui	Quand envoyer le message. Utilisez le format "now" ou AAAA-MM-JJ HH:mm.
devices	array of strings	Oui	Liste des jetons d’appareil LINE (ID utilisateur) pour recevoir le message.
preset	string	Non	Code du preset LINE que vous avez créé dans le Panneau de Contrôle Pushwoosh. Remarque : Si preset et template sont tous deux inclus, le modèle remplace le preset. Si preset et content sont tous deux inclus, le contenu de la requête remplace le preset.
template	object	Oui	Modèle de mise en page du message. Prend en charge plusieurs types de messages. Voir les détails ci-dessous.

Paramètres du modèle

Pour un message Flex, utilisez la structure brute.
Type : raw (Flex)

Paramètre	Type	Requis	Description
alt_text	string	Oui	Texte de repli affiché dans les notifications, les aperçus de chat et les citations. 400 caractères maximum.
content	object	Oui	Mise en page du message Flex, structurée à l’aide de bubble, box, text et d’autres composants conformément à la spécification Flex de LINE.

Exemple de requête

{
  "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...
                  ]
                }
              }
            }
          }
        }
      }
    ]
  }
}