メッセージの送信

Prev Next

Classic/VPC環境で利用できます。

全ユーザーを対象に情報提供型友達トークメッセージを送信します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /alimtalk/v2/services/{serviceId}/messages

リクエストヘッダ

Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、Simple & Easy Notification Serviceのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
serviceId String Required Biz Messageサービス ID

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
plusFriendId String Required チャンネル ID
templateCode String Required テンプレートコード
messages Array Required メッセージ情報
  • 最大100件入力可能
reserveTime String Optional 予約日時
  • YYYY-MM-DD HH:mm形式
  • 予約送信する場合、入力
reserveTimeZone String Optional 予約タイムゾーン
参考

テンプレートに画像が登録されている場合、通知トークメッセージに画像が自動的に追加されます。

messages

messagesの説明は次の通りです。

フィールド タイプ 必須の有無 説明
countryCode String Optional 国コード
to String Required 受信番号
  • 数字のみ入力可能
title String Optional 強調情報のタイトル
  • 強調表記型のテンプレートでのみ使用可能
content String Required メッセージの内容
headerContent String Optional 通知トークヘッダ(Bytes)
  • 0~16
  • アイテムリスト型テンプレートでのみ使用可能
itemHighlight Object Optional アイテムハイライト情報
  • アイテムリスト型テンプレートでのみ使用可能
itemHighlight.title String Conditional アイテムハイライトの件名
  • 画像がない場合: 1行につき15文字、合計30文字まで入力可能
  • 画像がある場合: 1行につき10文字、合計21文字まで入力可能
  • 制限超過時は省略処理
itemHighlight.description String Conditional アイテムハイライトの内容
item Object Optional アイテムリスト情報
  • アイテムリスト型テンプレートでのみ使用可能
item.list Array Conditional アイテムリスト
  • 2~10個入力可能
item.summary Object Optional アイテムサマリー情報
  • アイテムリスト型テンプレートでのみ使用可能
item.summary.title String Conditional アイテムサマリーの件名
  • 1~6文字
  • アイテムリスト型テンプレートでのみ使用可能
item.summary.description String Conditional アイテムサマリー内容
  • 1~23文字
  • 使用可能な文字: 通貨記号(Unicode、ウォン、元、円)、通貨コード(ISO 4217)、数字、コンマ、スペース、小数点(第二位)
buttons Array Optional メッセージボタン情報
useSmsFailover Boolean Optional SMS代替送信を使用するか
  • true | false
    • true: 使用
    • false: 使用しない
  • デフォルト: カカオトークチャンネルの設定に準拠
  • 代替送信が設定されたカカオトークチャンネルでのみ使用可能
failoverConfig Object Optional 代替送信設定
failoverConfig.type String Optional メッセージのタイプ
  • SMS | LMS
    • SMS: SMSメッセージ
    • LMS: LMSメッセージ
  • 未入力時、メッセージ内容の長さに応じて自動適用
    • 90bytes以下: SMS
    • 90 bytes超過: LMS
failoverConfig.from String Optional 送信番号
failoverConfig.subject String Optional メッセージの件名
  • 未入力時、チャンネル名を適用
  • LMSでのみ使用可能
failoverConfig.content String Optional メッセージ内容
  • 未入力時、通知トークメッセージの内容を適用(ボタンを除く)
参考
  • contentbuttonsは、登録および検収済みのテンプレートに合わせて入力してください。テンプレートの規格に合わない場合、送信が失敗する可能性があります。
  • SMS代替送信機能は、Biz Message受信結果コードに基づいて成功しなかった場合に動作し、「B」接頭辞が付いたコードの場合は動作しません。
  • テンプレートに画像が登録されている場合、別途メッセージの送信時に、リクエストボディにその内容を入れなくても登録されている画像が送信されます。
  • テンプレートの登録および検収の詳細は、AlimTalk Templateご利用ガイドをご参照ください。

item.list

item.listの説明は次の通りです。

フィールド タイプ 必須の有無 説明
title String Required アイテム名
  • 1~6文字
description String Required アイテムの内容
  • 1~23文字

buttons

buttonsの説明は次の通りです。

フィールド タイプ 必須の有無 説明
type String Required ボタンのタイプ
  • DS | WL | AL | BK | MD | AC
    • DS: 配送状況追跡
    • WL: ウェブリンク
    • AL: アプリリンク
    • BK: ボットキーワード
    • MD: メッセージ伝達
    • AC: チャンネル追加
  • 配送に関するメッセージを送信する場合、WLで配送状況追跡可能な宅配業者はサポート宅配業者リストを参照
name String Required ボタン名
  • 最大20文字
  • typeACの場合、チャンネル追加と入力
linkMobile String Conditional モバイルウェブリンク
  • typeWLの場合、必ず入力
linkPc String Conditional PCウェブリンク
  • typeWLの場合、必ず入力
schemeIos String Conditional iOSアプリリンク
  • typeALの場合、必ず入力
schemeAndroid String Conditional Androidアプリリンク
  • typeALの場合、必ず入力
参考

すべてのフィールドは、登録および検収済みのテンプレートに合わせて入力してください。テンプレートの規格に合わない場合、送信が失敗する可能性があります。

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://sens.apigw.ntruss.com/alimtalk/v2/services/ncp:kkobizmsg:kr:27*********6:sens/messages' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "plusFriendId": "@******",
    "templateCode": "temp001",
    "messages": [
        {
            "countryCode": "82",
            "to": "010********",
            "content": "ホンギルドン様、\nご依頼の[PO394857]翻訳文書を本日18:00にメールでお送りする予定です。\n\nメール送信後、お知らせいたします。\n今しばらくお待ちください。",
            "useSmsFailover": true,
            "failoverConfig": {
                "type": "SMS",
                "from": "010********",
                "content": "ホンギルドン様、\nご依頼の[PO394857]翻訳文書を本日18:00にメールでお送りする予定です。\n\nメール送信後、お知らせいたします。\n今しばらくお待ちください。"
            }
        }
    ]
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
requestId String Required リクエスト ID
requestTime String Required リクエスト日時
  • YYYY-MM-DDTHH:mm:ss.sss形式
statusCode String Required 状態コード
  • HTTPステータスコード規格に準拠
    • 202: 成功
    • その他: 失敗
statusName String Required 状態
  • success | processing | reserved | fail
    • success: 成功
    • processing: 処理中
    • reserved: 予約
    • fail: 失敗
messages Array Required メッセージ情報
  • 即時送信の場合、表示

messages

messagesの説明は次の通りです。

フィールド タイプ 必須の有無 説明
messageId String Required メッセージ ID
countryCode String Optional 国コード
to String Required 受信番号
content String Required メッセージの内容
requestStatusCode String Required リクエストの状態コード
  • A000: 成功
  • その他: 失敗
requestStatusName String Required リクエスト状態
  • success | fail
    • success: 成功
    • fail: 失敗
requestStatusDesc String Required リクエスト状態の説明
useSmsFailover Boolean Required SMS代替送信を使用するか
  • true | false
    • true: 使用
    • false: 使用しない

レスポンスステータスコード

Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、Simple & Easy Notification Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "requestId": "RBAA-*************-****-********-zgrtzVEW",
    "requestTime": "2025-11-25T15:39:20.899",
    "statusCode": "202",
    "statusName": "processing",
    "messages": [
        {
            "messageId": "aa724ca6-****-****-****-66dfc1a700e7",
            "countryCode": "82",
            "to": "010********",
            "content": "ホンギルドン様、\nご依頼の[PO394857]翻訳文書を本日18:00にメールでお送りする予定です。\n\nメール送信後、お知らせいたします。\n今しばらくお待ちください。",
            "requestStatusCode": "A000",
            "requestStatusName": "success",
            "requestStatusDesc": "成功",
            "useSmsFailover": true
        }
    ]
}

サポート宅配業者のリスト

ウェブリンク(WL)ボタンを通じて配送状況追跡ページに接続できる宅配業者のリストは次の通りです。

参考

対応しない宅配業者の場合、ボタンは自動で追加されません。

宅配業者 宅配名 送り状番号
郵便局宅配 郵便局 数字13桁または数字[6+7]桁
  • 区切り文字: 「-」または「_」
Logen宅配 Logen 数字11桁または数字[3+4+4]桁
  • 区切り文字: 「-」または「_」
ILYANG Logis
  • ILYANG Logis宅配
  • ILYANG宅配
  • ILYANG Logis
数字9~11桁
FedEX
  • FedEx
  • FedEx
  • fedex
数字12桁
HANJIN TRANSPORTATION HANJIN TRANSPORTATION 数字10桁または数字12桁
KYOUNGDONG EXPRESS KYOUNGDONG EXPRESS 数字9~16桁または数字[4+3+6]桁
  • 区切り文字: 「-」
HAPDONG EXPRESS HAPDONG EXPRESS 数字9~16桁
LOTTE GLOBAL LOGISTICS
  • LOTTE GLOBAL LOGISTICS
  • LOTTE LOGISTICS
  • HANJIN TRANSPORTATION
  • Hyundai Logistics
数字12桁または数字[4+4+4]桁
  • 区切り文字: 「-」
Nonghyup Logis Nonghyup Logis 数字12桁
HONAM LOGISTICS HONAM LOGISTICS 数字10桁
CHUNIL PARCEL CHUNIL PARCEL 数字11桁
DAESIN PARCEL SERVICES DAESIN PARCEL SERVICES 数字13桁
KUNYONG EXPRESS KUNYONG EXPRESS 数字10桁
CUpost
  • CUpost
  • CUpost
数字10桁または数字12桁または数字[4+4+4]桁
  • 区切り文字: 「-」または「_」
CVSnetコンビニ宅配
  • GSPostbox宅配
  • GSコンビニ宅配
  • CVSnetコンビニ宅配
数字10桁または数字12桁または数字[4+4+4]桁
  • 区切り文字: 「-」または「_」
Handex Handex 数字10桁または数字14桁
TNT Express
  • TNTExpress
  • TNT Express
  • TNT Express
数字8~9桁
USPS USPS 数字10桁または数字22桁または[英大文字2桁 + 数字9桁 + 英大文字2桁]
  • 区切り文字なし
EMS EMS 英大文字2桁 + 数字9桁 + 英大文字2桁
  • 区切り文字なし
DHL DHL 数字10桁
GOODSTOLUCK GOODSTOLUCK 数字[4+4+4]桁
  • 区切り文字: 「-」