[例]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" https://api-alimtalk.cloud.toast.com/alimtalk/v2.1/appkeys/{appkey}/raw-messages -d '{"senderKey":"{発信キー}","templateCode":"{テンプレートコード}","requestDate":"2018-10-01 00:00","recipientList":[{"recipientNo":"{受信番号}","content":"{内容}","buttons":[{"ordering":"{ボタン順序}","type":"{ボタンタイプ}","name":"{ボタン名}","linkMo":"{モバイルWebリンク}"}]}]}'

レスポンス

{
  "header": {
    "resultCode": Integer,
    "resultMessage": String,
    "isSuccessful": boolean
  },
  "message": {
    "requestId": String,
    "senderGroupingKey": String,
    "sendResults": [
      {
        "recipientSeq": Integer,
        "recipientNo": String,
        "resultCode": Integer,
        "resultMessage": String,
        "recipientGroupingKey": String
      }
    ]
  }
}

メッセージリストの照会

リクエスト

[URL]

GET  /alimtalk/v2.1/appkeys/{appkey}/messages
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

[Query parameter] 1番or(2番、 3番)の条件は必須

• 90日以上前の送信リクエストデータは照会されません。
• 送信リクエスト日時の範囲は最大30日です。

レスポンス

{
  "header":{
      "resultCode": Integer,
      "resultMessage": String,
      "isSuccessful": boolean
  },
  "messageSearchResultResponse":{
    "messages":[
    {
      "requestId": String,
      "recipientSeq":Integer,
      "plusFriendId": String,
      "senderKey"   : String,
      "templateCode": String,
      "recipientNo": String,
      "content": String,
      "requestDate": String,
      "createDate":String,
      "receiveDate":String,
      "resendStatus": String,
      "resendStatusName": String,
      "messageStatus": String,
      "resultCode": String,
      "resultCodeName":String,
      "createUser":String,
      "buttons":[
        {
          "ordering": Integer,
          "type": String,
          "name": String,
          "linkMo": String,
          "linkPc": String,
          "schemeIos": String,
          "schemeAndroid": String
        }
      ],
      "senderGroupingKey": String,
      "recipientGroupingKey": String
    }
    ],
    "totalCount": Integer
  }
}

[例]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" "https://api-alimtalk.cloud.toast.com/alimtalk/v2.1/appkeys/{appkey}/messages?startRequestDate=2018-05-01%20:00&endRequestDate=2018-05-30%20:59"

SMS/LMS再送信ステータス

メッセージ単件照会

リクエスト

[URL]

GET  /alimtalk/v2.1/appkeys/{appkey}/messages/{requestId}/{recipientSeq}
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

[例]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" "https://api-alimtalk.cloud.toast.com/alimtalk/v2.1/appkeys/{appkey}/messages/{requestId}/{recipientSeq}"

レスポンス

{
  "header":{
      "resultCode": Integer,
      "resultMessage": String,
      "isSuccessful": boolean
  },
  "message":{
      "requestId": String,
      "recipientSeq":Integer,
      "plusFriendId": String,
      "senderKey"   : String,
      "templateCode": String,
      "recipientNo": String,
      "content": String,
      "templateTitle":String,
      "templateSubtitle":String,
      "templateExtra":String,
      "templateAd":String,
      "requestDate": String,
      "receiveDate":String,
      "createDate":String,
      "resendStatus": String,
      "resendStatusName": String,
      "resendResultCode":String,
      "resendRequestId":String,
      "messageStatus": String,
      "resultCode": String,
      "resultCodeName":String,
      "createUser":String,
      "buttons":[
        {
          "ordering": Integer,
          "type": String,
          "name": String,
          "linkMo": String,
          "linkPc": String,
          "schemeIos": String,
          "schemeAndroid": String
        }
      ],
      "messageOption": {
        "price": Integer,
        "currencyType": String
      },
      "senderGroupingKey": String,
      "recipientGroupingKey": String
  }
}

認証メッセージ

1. 認証メッセージの送信時、含まれる必要がある認証文言案内

• 例1)認証メッセージAPI送信リクエストした時、全文(テンプレート日本語識別子含む)に認証文言が含まれていない場合は、送信に失敗します。
• 例2)認証文言が英文の場合、大文字/小文字の区別なしで有効性チェックが行われます。

メッセージ置換送信リクエスト

[URL]

POST  /alimtalk/v2.1/appkeys/{appkey}/auth/messages
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

[Request body]

{
    "senderKey": String,
    "templateCode": String,
    "requestDate": String,
    "senderGroupingKey": String,
    "createUser":String,
    "recipientList": [{
        "recipientNo": String,
        "templateParameter": {
            String: String
        },
        "resendParameter": {
          "isResend":boolean,
          "resendType":String,
          "resendTitle":String,
          "resendContent":String,
          "resendSendNo":String
        },
        "recipientGroupingKey": String
    }],
    "messageOption": {
      "price": Integer,
      "currencyType": String
    }
}

• リクエスト日時は呼び出す時点から60日後まで設定可能です。
• SMSサービスで代替送信されるため、SMSサービスの送信APIの仕様に応じてフィールドを入力する必要があります。(SMSサービスに登録された発信番号、各種フィールドの長さ制限など)
• 指定した代替送信タイプのバイト制限を超える代替送信のタイトルや内容は、途中で切れて代替送信されることがあります。([SMS注意事項]参考)

[例]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" https://api-alimtalk.cloud.toast.com/alimtalk/v2.1/appkeys/{appkey}/auth/messages -d '{"senderKey":"{発信キー}","templateCode":"{テンプレートコード}","requestDate":"2018-10-01 00:00","recipientList":[{"recipientNo":"{受信番号}","templateParameter":{"{日本語識別子フィールド}":"{置換データ}"}}]}'

レスポンス

{
  "header": {
    "resultCode": Integer,
    "resultMessage": String,
    "isSuccessful": boolean
  },
  "message": {
    "requestId": String,
    "senderGroupingKey": String,
    "sendResults": [
      {
        "recipientSeq": Integer,
        "recipientNo": String,
        "resultCode": Integer,
        "resultMessage": String,
        "recipientGroupingKey": String
      }
    ]
  }
}

メッセージ全文送信リクエスト

[URL]

POST  /alimtalk/v2.1/appkeys/{appkey}/auth/raw-messages
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

[Request body]

{
    "senderKey": String,
    "templateCode": String,
    "requestDate": String,
    "senderGroupingKey": String,
    "createUser": String,
    "recipientList": [
        {
            "recipientNo": String,
            "content": String,
            "templateTitle":String,
            "buttons": [
                {
                    "ordering": Integer,
                    "type": String,
                    "name": String,
                    "linkMo": String,
                    "linkPc": String,
                    "schemeIos": String,
                    "schemeAndroid": String
                }
            ],
            "resendParameter": {
              "isResend":boolean,
              "resendType":String,
              "resendTitle":String,
              "resendContent":String,
              "resendSendNo":String
            },
            "recipientGroupingKey": String
        }
    ],
    "messageOption": {
      "price": Integer,
      "currencyType": String
    }
}

• 本文とボタンに置換が完了したデータを入れてください。
• リクエスト日時は呼び出す時点から60日後まで設定可能です。

[例]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" https://api-alimtalk.cloud.toast.com/alimtalk/v2.1/appkeys/{appkey}/auth/raw-messages -d '{"senderKey":"{発信キー}","templateCode":"{テンプレートコード}","requestDate":"2018-10-01 00:00","recipientList":[{"recipientNo":"{受信番号}","content":"{内容}","buttons":[{"ordering":"{ボタン順序}","type":"{ボタンタイプ}","name":"{ボタン名}","linkMo":"{モバイルWebリンク}"}]}]}'

レスポンス

{
  "header": {
    "resultCode": Integer,
    "resultMessage": String,
    "isSuccessful": boolean
  },
  "message": {
    "requestId": String,
    "senderGroupingKey": String,
    "sendResults": [
      {
        "recipientSeq": Integer,
        "recipientNo": String,
        "resultCode": Integer,
        "resultMessage": String,
        "recipientGroupingKey": String
      }
    ]
  }
}

メッセージリストの照会

リクエスト

[URL]

GET  /alimtalk/v2.1/appkeys/{appkey}/auth/messages
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

[Query parameter] 1番or(2番、 3番)の条件は必須

• 90日以上前の送信リクエストデータは照会されません。
• 送信リクエスト日時の範囲は最大30日です。

レスポンス

{
  "header":{
      "resultCode": Integer,
      "resultMessage": String,
      "isSuccessful": boolean
  },
  "messageSearchResultResponse":{
    "messages":[
    {
      "requestId": String,
      "recipientSeq":Integer,
      "plusFriendId": String,
      "senderKey"   : String,
      "templateCode": String,
      "recipientNo": String,
      "content": String,
      "requestDate": String,
      "createDate":String,
      "receiveDate":String,
      "resendStatus": String,
      "resendStatusName": String,
      "messageStatus": String,
      "resultCode": String,
      "resultCodeName":String,
      "createUser":String,
      "buttons":[
        {
          "ordering": Integer,
          "type": String,
          "name": String,
          "linkMo": String,
          "linkPc": String,
          "schemeIos": String,
          "schemeAndroid": String
        }
      ],
      "senderGroupingKey": String,
      "recipientGroupingKey": String
    }
    ],
    "totalCount": Integer
  }
}

[例]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" "https://api-alimtalk.cloud.toast.com/alimtalk/v2.1/appkeys/{appkey}/auth/messages?startRequestDate=2018-05-01%20:00&endRequestDate=2018-05-30%20:59"

SMS/LMS再送信ステータス

メッセージ単件照会

リクエスト

[URL]

GET  /alimtalk/v2.1/appkeys/{appkey}/auth/messages/{requestId}/{recipientSeq}
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

[例]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" "https://api-alimtalk.cloud.toast.com/alimtalk/v2.1/appkeys/{appkey}/auth/messages/{requestId}/{recipientSeq}"

レスポンス

{
  "header":{
      "resultCode": Integer,
      "resultMessage": String,
      "isSuccessful": boolean
  },
  "message":{
      "requestId": String,
      "recipientSeq":Integer,
      "plusFriendId": String,
      "senderKey"   : String,
      "templateCode": String,
      "recipientNo": String,
      "content": String,
      "templateTitle":String,
      "templateSubtitle":String,
      "templateExtra":String,
      "templateAd":String,
      "requestDate": String,
      "createDate":String,
      "receiveDate":String,
      "resendStatus": String,
      "resendStatusName": String,
      "resendResultCode":String,
      "resendRequestId":String,
      "messageStatus": String,
      "resultCode": String,
      "resultCodeName":String,
      "createUser":String,
      "buttons":[
        {
          "ordering": Integer,
          "type": String,
          "name": String,
          "linkMo": String,
          "linkPc": String,
          "schemeIos": String,
          "schemeAndroid": String
        }
      ],
      "messageOption": {
        "price": Integer,
        "currencyType": String
      },
      "senderGroupingKey": String,
      "recipientGroupingKey": String
  }
}

メッセージ

メッセージ送信取消

リクエスト

[URL]

DELETE  /alimtalk/v2.1/appkeys/{appkey}/messages/{requestId}
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

[Query parameter]

• 一般/認証メッセージは同じAPIでキャンセルできます。

レスポンス

{
  "header":{
      "resultCode": Integer,
      "resultMessage": String,
      "isSuccessful": boolean
  }
}

[例]

curl -X DELETE -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" "https://api-alimtalk.cloud.toast.com/alimtalk/v2.1/appkeys/{appkey}/messages/{requestId}?recipientSeq=1,2,3"

メッセージ結果アップデートの照会

リクエスト

[URL]

GET  /alimtalk/v2.1/appkeys/{appkey}/message-results
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

[Query parameter]

レスポンス

{
  "header":{
      "resultCode": Integer,
      "resultMessage": String,
      "isSuccessful": boolean
  },
  "messages":[
    {
      "requestId": String,
      "recipientSeq":Integer,
      "requestDate": String,
      "createDate": String,
      "receiveDate":String,
      "resendStatus": String,
      "resendStatusName": String,
      "resendResultCode": String,
      "resendRequestId": String,
      "messageStatus": String,
      "resultCode": String,
      "resultCodeName":String
    }
  ]
}

[例]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" "https://api-alimtalk.cloud.toast.com/alimtalk/v2.1/appkeys/{appkey}/message-results?startUpdateDate=2018-05-01%20:00&endUpdateDate=2018-05-30%20:59"

テンプレート

テンプレートカテゴリー照会

リクエスト

[URL]

GET  /alimtalk/v2.1/appkeys/{appkey}/template/categories
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

レスポンス

{
  "header":{
      "resultCode": Integer,
      "resultMessage": String,
      "isSuccessful": boolean
  },
  "categories": [
    {
      "name": String,
      "subCategories": [
        {
          "code": String,
          "name": String,
          "groupName": String,
          "inclusion": String,
          "exclusion": String
        }
      ]
    }
  ]
}

テンプレートの登録

リクエスト

[URL]

POST  /alimtalk/v2.1/appkeys/{appkey}/plus-friends/{plusFriendId}/templates
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

[Request body]

{
  "templateCode":String,
  "templateName":String,
  "templateContent":String,
  "templateMessageType": String,
  "templateEmphasizeType":String,
  "templateExtra": String,
  "templateTitle":String,
  "templateSubtitle":String,
  "templateImageName":String,
  "templateImageUrl":String,
  "securityFlag": Boolean,
  "categoryCode": String,
  "buttons":[
    {
      "ordering":Integer,
      "type":String,
      "name":String,
      "linkMo":String,
      "linkPc":String,
      "schemeIos":String,
      "schemeAndroid":String
    }
  ]
}

レスポンス

{
  "header":{
    "resultCode": Integer,
    "resultMessage": String,
    "isSuccessful": boolean
  }
}

テンプレートの修正

リクエスト

[URL]

PUT  /alimtalk/v2.1/appkeys/{appkey}/plus-friends/{plusFriendId}/templates/{templateCode}
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

[Request body]

{
  "templateName":String,
  "templateContent":String,
  "templateMessageType": String,
  "templateEmphasizeType":String,
  "templateExtra": String,
  "templateTitle":String,
  "templateSubtitle":String,
  "templateImageName":String,
  "templateImageUrl":String,
  "securityFlag": Boolean,
  "categoryCode": String,
  "buttons":[
    {
      "ordering":Integer,
      "type":String,
      "name":String,
      "linkMo":String,
      "linkPc":String,
      "schemeIos":String,
      "schemeAndroid":String
    }
  ]
}

レスポンス

{
  "header":{
    "resultCode": Integer,
    "resultMessage": String,
    "isSuccessful": boolean
  }
}

テンプレートの削除

リクエスト

[URL]

DELETE  /alimtalk/v2.1/appkeys/{appkey}/plus-friends/{plusFriendId}/templates/{templateCode}
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

レスポンス

{
  "header":{
    "resultCode": Integer,
    "resultMessage": String,
    "isSuccessful": boolean
  }
}

テンプレートの問い合わせをする

リクエスト

[URL]

PUT  /alimtalk/v2.1/appkeys/{appkey}/plus-friends/{plusFriendId}/templates/{templateCode}/comments
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

[Request body]

{
  "comment":String
}

レスポンス

{
  "header":{
    "resultCode": Integer,
    "resultMessage": String,
    "isSuccessful": boolean
  }
}

ファイルを添付してテンプレートお問い合わせ

リクエスト

[URL]

POST  /alimtalk/v2.1/appkeys/{appkey}/plus-friends/{plusFriendId}/templates/{templateCode}/comments_file
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

[Request Body]

{
  "comment":String,
  "attachments":File
}

レスポンス

{
  "header":{
    "resultCode": Integer,
    "resultMessage": String,
    "isSuccessful": boolean
  }
}

テンプレートリストの照会

リクエスト

[URL]

GET  /alimtalk/v2.1/appkeys/{appkey}/templates
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

[Query parameter]

[例]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" "https://api-alimtalk.cloud.toast.com/alimtalk/v2.1/appkeys/{appkey}/templates?plusFriendId={発信キー}&templateStatus={テンプレートステータスコード}"

レスポンス

{
  "header":{
      "resultCode": Integer,
      "resultMessage": String,
      "isSuccessful": boolean
  },
  "templateListResponse": {
      "templates": [
          {
              "plusFriendId": String,
              "plusFriendType": String,
              "templateCode": String,
              "templateName": String,
              "templateContent": String,
              "templateEmphasizeType": String,
              "templateTitle":String,
              "templateSubtitle":String,
              "templateImageName":String,
              "templateImageUrl":String,
              "templateMessageType":String,
              "templateExtra":String,
              "templateAd":String,
              "buttons": [
                {
                    "ordering":Integer,
                    "type": String,
                    "name": String,
                    "linkMo": String,
                    "linkPc": String,
                    "schemeIos": String,
                    "schemeAndroid": String
                }
                ],
                "comments": [
                  {
                      "id": Integer,
                      "content": String,
                      "userName": String,
                      "createdAt": String,
                      "attachment": [{
                        "originalFileName": String,
                        "filePath": String
                      }],
                      "status": String
                    }  
                ],
                "status": String,
                "statusName": String,
                "createDate": String
            }
        ],
        "totalCount": Integer
    }
}

テンプレートの修正リスト照会

リクエスト

[URL]

GET  /alimtalk/v2.1/appkeys/{appkey}/plus-friends/{plusFriendId}/templates/{templateCode}/modifications
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

[例]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" "https://api-alimtalk.cloud.toast.com/alimtalk/v2.1/appkeys/{appkey}/plus-friends/{plusFriendId}/templates/{templateCode}/modifications"

レスポンス

{
  "header":{
      "resultCode": Integer,
      "resultMessage": String,
      "isSuccessful": boolean
  },
  "templateModificationsResponse": {
      "templates": [
          {
              "plusFriendId": String,
              "plusFriendType": String,
              "templateCode": String,
              "templateName": String,
              "templateContent": String,
              "templateEmphasizeType": String,
              "templateTitle":String,
              "templateSubtitle":String,
              "templateImageName":String,
              "templateImageUrl":String,
              "templateMessageType":String,
              "templateExtra":String,
              "templateAd":String,
              "buttons": [
                {
                    "ordering":Integer,
                    "type": String,
                    "name": String,
                    "linkMo": String,
                    "linkPc": String,
                    "schemeIos": String,
                    "schemeAndroid": String
                }
                ],
                "comments": [
                  {
                      "id": Integer,
                      "content": String,
                      "userName": String,
                      "createdAt": String,
                      "attachment": [{
                        "originalFileName": String,
                        "filePath": String
                      }],
                      "status": String
                    }  
                ],
                "status": String,
                "statusName": String,
                "activated": boolean,
                "createDate": String
            }
        ],
        "totalCount": Integer
    }
}

テンプレート画像の登録

リクエスト

[URL]

POST  /alimtalk/v2.1/appkeys/{appkey}/template-image
Content-Type: multipart/form-data

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

[Request parameter]

[例]

curl -X POST -H "Content-Type: multipart/form-data" -H "X-Secret-Key:{secretkey}" "https://api-alimtalk.cloud.toast.com/alimtalk/v2.1/appkeys/{appkey}/template-image" -F "file=@alimtalk-template-image.jpeg"

レスポンス

{
  "header":{
    "resultCode": Integer,
    "resultMessage": String,
    "isSuccessful": boolean
  },
  "templateImage" {
    "templateImageName": String,
    "templateImageUrl": String
  }
}

代替送信管理

SMS AppKey登録

[URL]

POST  /alimtalk/v2.1/appkeys/{appkey}/failback/appkey
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

[Request body]

{
    "resendAppKey": String
}

[例]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" https://api-alimtalk.cloud.toast.com/alimtalk/v2.1/appkeys/{appkey}/failback/appkey -d '{"resendAppKey": "smsAppKey"}

レスポンス

{
  "header":{
      "resultCode": Integer,
      "resultMessage": String,
      "isSuccessful": boolean
  }
}

代替送信設定登録

[URL]

POST  /alimtalk/v2.1/appkeys/{appkey}/failback
Content-Type: application/json;charset=UTF-8

[Path parameter]

[Header]

{
  "X-Secret-Key": String
}

[Request body]

{  
   "plusFriendId": String,
   "isResend": Boolean,
   "resendSendNo": String
}

[例]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" -H "X-Secret-Key:{secretkey}" https://api-alimtalk.cloud.toast.com/alimtalk/v2.1/appkeys/{appkey}/failback/appkey -d '{"plusFriendId": "@プラスフレンド","isResend": true,"resendSendNo": "01012341234" }

レスポンス

{
  "header":{
      "resultCode": Integer,
      "resultMessage": String,
      "isSuccessful": boolean
  }
}