API docs by Redocly

MEEQ ビジネスツールズ SMS送信 API仕様書 (1.0)

MEEQ ビジネスツールズ SMS送信サービスのAPI仕様書仕様書です。
本APIはBASIC認証です。送信元電話番号に応じて、契約時に払い出されたアカウント情報が必要になります。

メッセージ送信

SMSを送信するためのリクエスト内容を受け付けます。SMS送信は非同期にて実施されます。

Request Body schema: application/json
message
required
string <byte> <= 4096 characters

メッセージ文面
Base64エンコード形式の文字列を指定してください。
送信先ごとに変更可能な項目を埋め込むことができます。メッセージ文面の {v001} ～ {v010} 部分を、可変項目に設定した文字列に置き換えます。

required
Array of objects [ 1 .. 10 ] items

送信先リスト

Responses

Request samples

Content type
application/json
{
  • "message": "e3YwMDF95qeYDQrjgZPjgozjga97djAwMn3lubR7djAwM33mnIh7djAwNH3ml6Xjga7jg4bjgrnjg4jjg6Hjg4Pjgrvjg7zjgrjjgafjgZnjgII=",
  • "deliveryList": [
    • {
      • "tel": "09000000001",
      • "variable": {
        • "v001": "44OG44K544OIMQ==",
        • "v002": "77yS77yQ77yS77yU",
        • "v003": "77yR",
        • "v004": "77yR"
        }
      },
    • {
      • "tel": "09000000002",
      • "variable": {
        • "v001": "44OG44K544OIMg==",
        • "v002": "77yS77yQ77yS77yU",
        • "v003": "77yR",
        • "v004": "77yS"
        }
      }
    ]
}

Response samples

Content type
application/json
{
  • "resultList": [
    • {
      • "tel": "09000000001",
      • "messageId": "500000000797",
      • "status": "000"
      },
    • {
      • "tel": "09000000002",
      • "messageId": "500000000798",
      • "status": "000"
      }
    ]
}

メッセージ送達確認

SMSの送達状況を返却します。

path Parameters
messageId
required
string = 12 characters 半角英数記号
Example: 500000000797

メッセージ送信ID
メッセージ送信APIにて返却したIDをご指定ください。

Responses

Response samples

Content type
application/json
{
  • "messageId": "500000000797",
  • "status": "OK",
  • "tel": "09000000001",
  • "carrier": "docomo"
}