やりたいこと
Slackのchat.postMessageでメッセージを投稿する際、~Hello World!~というメッセージが 「Hello World!」 と表示されてしまいます。
QiitaのMarkdownのようにチルダ2つであれば意図せず使われる機会は少ないと思いますが、Slackで使われているmrkdwnはチルダ1つであり、「鴨のロースト ~オレンジソースを添えて~」のように副題として使われるケースがあります。
このような際に取り消し線として表示されるのを防ぎたいというのが本記事の目的です。
結論
結論から言うと、以下の2つの方法で取り消し線になるのを防ぐことができます。
-
blocksのtypeでsectionを選択し、plain_textとして書く -
blocksのtypeでrich_textを選択し、rich_text_sectionのelementとしてtextを選択する
詳しく解説していきます。
解説の前に
Slackでメッセージを投稿するには、Appを作成し chat.postMessage APIを使用する方法と、Incoming Webhooksを使用する方法があります。
本記事では、chat.postMessage APIを使用した方法を使いますが、Incoming Webhooksでも同様に可能です。
Appの作成方法やtokenの取得方法については割愛しますが、Your Apps から Create New Appを選んでアプリを作り、OAuth & Permissions から Bot User OAuth Token を生成してください。
tokenを取得すると、以下のようにメッセージを投稿できます。
curl -X POST \
-H "Authorization: Bearer <Bot User OAuth Token>" \
-H "Content-Type: application/json; charset=UTF-8" \
-d '{
"channel": "<Channel ID>",
"text": "鴨のロースト ~オレンジソースを添えて~",
}' \
https://slack.com/api/chat.postMessage
このように、ただメッセージを text に入れるだけだと、チルダで囲まれた部分は取り消し線になってしまいます。
sectionを使う場合
次のようにplain_textとして扱うことで、取り消し線にならずに投稿できます。
curl -X POST \
-H "Authorization: Bearer <Bot User OAuth Token>" \
-H "Content-Type: application/json; charset=UTF-8" \
-d '{
"channel": "<Channel ID>",
"blocks": [
{
"type": "section",
"text": {
"type": "plain_text",
"text": "鴨のロースト ~オレンジソースを添えて~"
}
}
]
}' \
https://slack.com/api/chat.postMessage
ただし、この方法には1つ欠点があります。
それは、同じメッセージにリンクを含めたい場合です。
Slackのmrkdwnでは <URL|Link Text> の形式でリンクを表現できます。
しかし、type に plain_text を指定した場合、当然ながらリンクにはなりません。
type: "mrkdwn"としたsectionに分けることでリンクにすることはできますが、sectionが別なので行間が空いてしまいます。
curl -X POST \
-H "Authorization: Bearer <Bot User OAuth Token>" \
-H "Content-Type: application/json; charset=UTF-8" \
-d '{
"channel": "<Channel ID>",
"blocks": [
{
"type": "section",
"text": {
"type": "plain_text",
"text": "鴨のロースト ~オレンジソースを添えて~"
}
},
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "<http://www.example.com|Link Text>"
}
}
]
}' \
https://slack.com/api/chat.postMessage
この問題を解決する方法が次のrich_textです。
rich_textを使う場合
rich_textを使うと、柔軟な記述が可能です。
以下のようにすることで、1つの section の中に複数の type を持つ element を定義できるため、先程の問題が解消できます。
curl -X POST \
-H "Authorization: Bearer <Bot User OAuth Token>" \
-H "Content-Type: application/json; charset=UTF-8" \
-d '{
"channel": "<Channel ID>",
"blocks": [
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"type": "text",
"text": "鴨のロースト ~オレンジソースを添えて~\n"
},
{
"type": "link",
"url": "http://www.example.com",
"text": "Link Text"
},
]
}
]
}
]
}' \
https://slack.com/api/chat.postMessage
リンクがmrkdwn形式ではなくなった点と、sectionが同じためテキストの後ろに \n が必要となった点に注意が必要です。
記述量が多くなりますが、sectionで要件を満たせない場合はrich_textを使うと良いでしょう。
また、このような複雑なメッセージを作成したい場合は、Slackが提供しているBlock Kit Builderを使うのが便利です。
参考リンク