[PYTHON] Aide-mémoire sur les pièces jointes de l'API Slack

Que sont les pièces jointes

Une décoration pour le message de Slack. Il est efficace pour enrichir les messages postés par notification de type Bot. L'image suivante est une comparaison entre sans pièce jointe et avec pièce jointe.

Pas d'attachement

avec pièce jointe

Paramètres

fallback

Commentaire

Un résumé en texte brut pour la pièce jointe. Selon le document, il est affiché sur un client qui n'affiche pas le texte formaté, mais je n'ai pas encore rencontré de client ou de scène affiché. Comme son nom l'indique, il est judicieux de spécifier un texte récapitulatif des pièces jointes au cas où.

Exemple de spécification

"fallback": "This is test attachment",

color

Commentaire

Spécifiez la couleur des pièces jointes. Il existe 3 types de préréglages, et il est également possible de spécifier par code couleur.

préréglé

• good
• warning
• danger

Les couleurs du signal, telles que le bleu, le jaune et le rouge, respectivement.

Désignation par code couleur

Il est également possible de spécifier n'importe quelle couleur avec le code couleur.

Défaut

Les pièces jointes sans couleur spécifiée sont affichées comme suit.

Exemple de spécification

préréglé

"color": "good",

Code couleur

"color": "#FFC0CB",

pretext

Commentaire

Spécifie le texte devant apparaître au-dessus du bloc des pièces jointes (la zone qui apparaît à côté de la couleur ↑). Si vous avez «texte» dans le corps du message comme dans la capture ci-dessous, il sera impossible de le distinguer.

Il est efficace lors de l'ajout de plusieurs pièces jointes.

Exemple de spécification

"pretext": "C'est prétexte",

author parameters

Commentaire

Un ensemble de paramètres qui spécifient les informations sur l'auteur (commençant par ʻauthor_`).

• author_name
  Le nom de l'auteur
• author_link
  Lien auteur (nom_auteur devient le texte du lien)
• author_icon
  Icône de l'auteur (spécifiez l'URL de l'image)

Exemple de spécification

"author_name": "daikiojm",
"author_link": "http://qiita.com/daikiojm",
"author_icon": "https://avatars1.githubusercontent.com/u/10055293?v=3&u=1d1491fc3c27e10e93cc364ee0556a3b768c29b2&s=100"

title

Commentaire

Le titre de la pièce jointe.

Exemple de spécification

"title": "TEST",

title_link

Commentaire

Le lien du titre.

Exemple de spécification

"title_link": "http://qiita.com/daikiojm",

text

Commentaire

Le corps de l'attachement.

Exemple de spécification

"text": "test:goode",

Sauts de ligne\à n

"text": "test:goode\ntest2",

fields

Commentaire

Utilisez cette option lorsque vous souhaitez afficher plusieurs groupes dans une seule pièce jointe. Une image qui imbrique les pièces jointes dans les pièces jointes.

Champs côte à côte (lorsque short est spécifié)

• title
  Titre du groupe
• value
  Contenu du groupe
• short
  Drapeau à afficher avec la moitié de la largeur de la pièce jointe

Exemple de spécification

"fields": [
    {
        "title": "fields attachment1",
        "value": "fields test",
    },
    {
        "title": "fields attachment2",
        "value": "fields test",
    }
]

short

"fields": [
    {
        "title": "fields attachment1",
        "value": "fields test",
        "short": "true"
    },
    {
        "title": "fields attachment2",
        "value": "fields test",
        "short": "true"
    }
]

image_url

Commentaire

Spécifiez l'URL de l'image à intégrer dans la pièce jointe. Les formats pris en charge sont GIF, JPEG, PNG, BMP

Exemple de spécification

"image_url": "https://qiita-image-store.s3.amazonaws.com/0/79414/ea00d65c-b9b7-3b97-df98-11d5b2fc6bfa.png ",

thumb_url

Commentaire

Spécifiez l'URL de l'image miniature à intégrer dans la pièce jointe. Les formats pris en charge sont GIF, JPEG, PNG, BMP La façon dont l'image est affichée est différente de ʻurl_image`.

Exemple de spécification

"thumb_url": "https://qiita-image-store.s3.amazonaws.com/0/79414/741aebb5-d320-4eb1-f765-59d462f32515.png ",

footer

Commentaire

Un ensemble de paramètres pour les informations de pied de page à intégrer dans la pièce jointe.

• footer
  Spécifiez les informations de pied de page. Le nombre maximum de caractères est de 300
• footer_icon
  Spécifiez l'URL de l'image de l'icône du pied de page.
• ts
  Spécifiez l'horodatage (horodatage UNIX) des informations à joindre à la pièce jointe. Cela peut être pratique lors de la mise en œuvre d'un bot de notification de type journal, etc. (?)

Exemple de spécification

"footer": "Send from Python",
"footer_icon": "https://avatars1.githubusercontent.com/u/10055293?v=3&u=1d1491fc3c27e10e93cc364ee0556a3b768c29b2&s=100",
"ts": "1498894191",

La source

slack API: Attaching content