メッセージ送信 (link)

トーク Bot を使ってリンクメッセージを送信します。

リンクメッセージは多言語に対応しており、メンバーの言語設定に合わせて表示を切り替えることができます。

API の種類

サーバー API

Request URL

https://apis.worksmobile.com/r/{API ID}/message/v1/bot/{botNo}/message/push

HTTP Method

POST(Content-Type: application/json; charset=UTF-8)

Request Content

common

パラメーター	タイプ	必須	説明
type	string	Y	"link"
contentText	string	Y	本文のテキスト 最大 1,000 字
linkText	string	Y	リンクのテキスト 最大 1,000 字
link	string	Y	linkText クリック時の遷移先 URL 最大 1,000 字

multi language

パラメーター	タイプ	必須	説明
i18nContentTexts[]	array	N	多言語の本文リスト
i18nContentTexts[].language	string	Y	言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US
i18nContentTexts[].contentText	string	Y	本文のテキスト 最大 1,000 字
i18nLinkTexts[]	array	N	多言語のリンクリスト
i18nLinkTexts[].language	string	Y	言語コード ●ja_JP ●ko_KR ●zh_CN ●zh_TW ●en_US
i18nLinkTexts[].linkText	string	Y	リンクのテキスト 最大 1,000 字

Request Example

simple

{
  "accountId": "admin@example.com",    
  "content": {
    "type": "link",
    "contentText": "content text",
    "linkText": "link text",
    "link": "http://www.worksmobile.com"
  }
}

detail

{
  "accountId": "admin@example.com",    
  "content": {
    "type": "link",
    "contentText": "content text",
    "i18nContentTexts": [{
      "language": "ja_JP",
      "contentText": "コンテンツテキスト"
    },{
      "language": "ko_KR",
      "contentText": "컨텐츠 텍스트"
    }],
    "linkText": "link area",
    "i18nLinkTexts": [{
      "language": "ja_JP",
      "linkText": "リンクテキスト"
    },{
      "language": "ko_KR",
      "linkText": "링크 텍스트"
    }],
    "link": "http://www.worksmobile.com"
  }
}

Response

呼び出しに成功すると HTTP 200 コードを返します。

Error Code

呼び出しに失敗するとエラーコードとエラーメッセージを返します。
エラーコードはトーク Bot REST API エラーコードを参照してください。