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 | メッセージ情報
|
reserveTime |
String | Optional | 予約日時
|
reserveTimeZone |
String | Optional | 予約タイムゾーン
|
参考
テンプレートに画像が登録されている場合、通知トークメッセージに画像が自動的に追加されます。
messages
messagesの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
countryCode |
String | Optional | 国コード
|
to |
String | Required | 受信番号
|
title |
String | Optional | 強調情報のタイトル
|
content |
String | Required | メッセージの内容 |
headerContent |
String | Optional | 通知トークヘッダ(Bytes)
|
itemHighlight |
Object | Optional | アイテムハイライト情報
|
itemHighlight.title |
String | Conditional | アイテムハイライトの件名
|
itemHighlight.description |
String | Conditional | アイテムハイライトの内容 |
item |
Object | Optional | アイテムリスト情報
|
item.list |
Array | Conditional | アイテムリスト
|
item.summary |
Object | Optional | アイテムサマリー情報
|
item.summary.title |
String | Conditional | アイテムサマリーの件名
|
item.summary.description |
String | Conditional | アイテムサマリー内容
|
buttons |
Array | Optional | メッセージボタン情報 |
useSmsFailover |
Boolean | Optional | SMS代替送信を使用するか
|
failoverConfig |
Object | Optional | 代替送信設定 |
failoverConfig.type |
String | Optional | メッセージのタイプ
|
failoverConfig.from |
String | Optional | 送信番号
|
failoverConfig.subject |
String | Optional | メッセージの件名
|
failoverConfig.content |
String | Optional | メッセージ内容
|
参考
content、buttonsは、登録および検収済みのテンプレートに合わせて入力してください。テンプレートの規格に合わない場合、送信が失敗する可能性があります。- SMS代替送信機能は、Biz Message受信結果コードに基づいて成功しなかった場合に動作し、「B」接頭辞が付いたコードの場合は動作しません。
- テンプレートに画像が登録されている場合、別途メッセージの送信時に、リクエストボディにその内容を入れなくても登録されている画像が送信されます。
- テンプレートの登録および検収の詳細は、AlimTalk Templateご利用ガイドをご参照ください。
item.list
item.listの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
title |
String | Required | アイテム名
|
description |
String | Required | アイテムの内容
|
buttons
buttonsの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
type |
String | Required | ボタンのタイプ
|
name |
String | Required | ボタン名
|
linkMobile |
String | Conditional | モバイルウェブリンク
|
linkPc |
String | Conditional | PCウェブリンク
|
schemeIos |
String | Conditional | iOSアプリリンク
|
schemeAndroid |
String | Conditional | Androidアプリリンク
|
参考
すべてのフィールドは、登録および検収済みのテンプレートに合わせて入力してください。テンプレートの規格に合わない場合、送信が失敗する可能性があります。
リクエスト例
リクエストのサンプルコードは次の通りです。
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 | リクエスト日時
|
statusCode |
String | Required | 状態コード
|
statusName |
String | Required | 状態
|
messages |
Array | Required | メッセージ情報
|
messages
messagesの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
messageId |
String | Required | メッセージ ID |
countryCode |
String | Optional | 国コード |
to |
String | Required | 受信番号 |
content |
String | Required | メッセージの内容 |
requestStatusCode |
String | Required | リクエストの状態コード
|
requestStatusName |
String | Required | リクエスト状態
|
requestStatusDesc |
String | Required | リクエスト状態の説明 |
useSmsFailover |
Boolean | Required | SMS代替送信を使用するか
|
レスポンスステータスコード
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 |
|
数字9~11桁 |
| 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 |
|
数字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 |
|
数字10桁または数字12桁または数字[4+4+4]桁
|
| CVSnetコンビニ宅配 |
|
数字10桁または数字12桁または数字[4+4+4]桁
|
| Handex | Handex | 数字10桁または数字14桁 |
| TNT Express |
|
数字8~9桁 |
| USPS | USPS | 数字10桁または数字22桁または[英大文字2桁 + 数字9桁 + 英大文字2桁]
|
| EMS | EMS | 英大文字2桁 + 数字9桁 + 英大文字2桁
|
| DHL | DHL | 数字10桁 |
| GOODSTOLUCK | GOODSTOLUCK | 数字[4+4+4]桁
|