ログイン無料でお試し
すべてのAPIに戻る
このエンドポイントは廃止されました。

単一のプッシュ通知通知を送信する

このメソッドを使用して、1 つのプッシュ通知通知を 1 人または複数の受信者に送信します。

URLフルパスを表示するには ログイン してください。 詳細はこちら。
post
/push/2/message/single
権限付与:
API Key Header
Basic
IBSSO Token Header
OAuth 2
スコープ:
message:send
mobile-app-messaging:manage
mobile-app-messaging:send
Request Body schema:
application/json
すべて折りたたむ -
from
required
string [ 1 .. 80 ] characters

メッセージの送信に使用しているPUSHアプリケーションコード。アプリケーションコードは、モバイルアプリケーションをInfobipプラットフォームで作成されたアプリケーションプロファイルにリンクするアプリケーション識別子です。アプリケーションコードをモバイルアプリケーションに実装したら、Mobile Messaging SDK 設定に挿入する必要があります。

to
required
object

受信者の宛先アドレス。確認例 受信者との連携方法

property name*
object

受信者の宛先アドレス。確認例 受信者との連携方法

text
required
string [ 1 .. 4000 ] characters

送信されるメッセージのテキスト。

validityPeriod
integer <int64> >= 0

メッセージの有効期間。validityPeriodTimeUnit で特に指定しない限り、時間単位で表されます。この期間が終了すると、Infobip プラットフォームまたはクラウド (APNS または FCM) を離れていないメッセージはキャンセルされ、配信されなくなります。デフォルト値は 48h です。最小値は 30 秒です。最大値は 72h です。

validityPeriodTimeUnit
string
Enum: "SECONDS" "MINUTES" "HOURS"

有効期間の時間単位既定値は時間です。

sendAt
string <date-time>

スケジュールされたプッシュ通知通知に使用されます。メッセージはスケジュールされた時間に送信されます。メッセージを送信する日時。形式は yyyy-MM-dd'T'HH:mm:ss です。SSSZ、遅くとも 180 日前までにのみスケジュールできます。

customPayload
object

プッシュ通知メッセージで配信できる追加データ。customPayload は JSON オブジェクトとしてフォーマットする必要があります。

property name*
object

プッシュ通知メッセージで配信できる追加データ。customPayload は JSON オブジェクトとしてフォーマットする必要があります。

notificationOptions
object

通知オプションを含む JSON オブジェクト。

title
string [ 0 .. 45 ] characters

通知内に表示される通知のタイトル。iOS 10+またはAndroid 4.1+が必要(Androidカスタムファームウェアに依存する場合があります)

soundEnabled
boolean

デバイスに通知が届いたときの音。

soundName
string

デバイスに通知が届いたときに再生されるカスタムサウンドの名前。オーディオファイルは、最大30秒の長さでアプリに配置する必要があります。ファイル拡張子はiOSでは必須、Androidでは任意です。(例:notification_sound.wav)。AndroidとiOSの使用状況の詳細を確認します。カスタム サウンドを再生するには、soundEnabled を true に設定する必要があります。

vibrationEnabled
boolean

通知のバイブレーション(Androidのみ)。

isSilent
boolean

true に設定すると、サイレントプッシュメッセージが送信されます。このようなメッセージは、デバイスのロック画面や通知センターには表示されません。サイレントメッセージを使用して、モバイルアプリケーションにカスタムデータを配信したり、アプリ内通知をトリガーしたりできます。

badge
integer <int32>

バッジカウンター(iOSのみ)。

contentUrl
string

通知に表示される画像の URL。リッチプッシュ通知は、iOS 10 および Android 4.1.+ のデバイスで利用できます。MM SDK バージョン 2.5.8 以降の iOS でサポートされています。Android では MM SDK バージョン 1.6.4 以降でサポートされています。

category
string

アクション可能な通知のカテゴリ ID。MM SDK バージョン 1.6.16 以降の Android でサポートされています。MM SDK バージョン 2.6.9 以降の iOS でサポートされています。定義済みのカテゴリ ID: mm_accept_decline - [Accept & Decline] ボタン アクション。

showInApp
boolean

アプリケーションに通知を表示します。

inAppStyle
string
Enum: "MODAL" "BANNER"

アクション可能なメッセージのアプリ ダイアログで使用するには MODAL に設定し、標準のバナー ビューを表示するには BANNER に設定します。MODAL は、iOS では 3.6.0、Android では 1.13.0、Cordova では 0.7.0 からサポートされています。BANNERは、iOS 5.0.0、Android 2.0.0、Cordova 1.0.0からサポートされています。

inAppExpirationPeriod
integer <int64> >= 0

アプリ内通知の有効期間を設定します。ユーザーは、送信時刻から始まる有効期間内にデバイスに受信した場合にのみアプリ内に表示されます。このパラメーターの時間単位は、inAppExpirationTimeUnit のプロパティによって設定されます。デフォルト値は 48h です。Android ではバージョン 3.4.0 以降、iOS ではバージョン 8.2.1 以降でサポート

inAppExpirationTimeUnit
string
Enum: "MINUTES" "HOURS"

アプリ内の有効期限の時間単位。

inAppDismissTitle
string

「閉じる」ボタンのカスタムタイトルを指定します。Androidではバージョン3.4.0以降、iOSではバージョン8.2.1以降でサポートされています。

inAppOpenTitle
string

「開く」ボタンのカスタムタイトルを指定します。Androidではバージョン3.4.0以降、iOSではバージョン8.2.1以降でサポートされています。

primaryButtonAction
object

通知タップまたはアプリ内通知のプライマリボタンタップ時に実行するアクションを定義します。Android, iOS, コルドバ, React Native です。

resource
string

開く URL またはパスを定義します。

type
string
Enum: "WEB_VIEW_URL" "DEEP_LINK" "OPEN_URL_IN_BROWSER"

WEB_VIEW_URL - webView での外部 Web コンテンツのオープン、 OPEN_URL_IN_BROWSER - デバイス ブラウザーでの外部 Web コンテンツのオープン、 DEEP_LINK - ディープ リンクを介した特定のモバイル アプリ画面のオープン。

inboxTopic
string

メッセージを受信トレイに保存するための大文字と小文字を区別するトピック名。指定したアカウントのトピック名が存在しない場合、メッセージの送信は拒否されます。

notifyUrl
string

配信レポートの送信先となるコールバック サーバーの URL。URL が使用できなくなった場合の再試行サイクルでは、「1 分 + (1 分 * 再試行番号 * 再試行番号)」という式が使用されます。

notifyContentType
string

優先配信レポートのコンテンツタイプ。サポートされているコンテンツ タイプ: application/json、application/xml。

callbackData
string

notifyUrlに送信される追加のクライアントデータ。最大値は 200 文字です。

targetOnlyPrimaryDevices
boolean

プライマリデバイスとしてマークされているプッシュデバイスにのみメッセージを送信するには、true に設定します。デフォルトでは、メッセージはプライマリと非プライマリの両方を含むすべてのターゲットデバイスに送信されます。

レスポンス

200

OK

400

Bad request

401

Unauthorized

403

Forbidden

500

Internal Server Error

サンプルをリクエストする

コンテンツタイプ
application/json
コピー
 すべて折りたたむ
{
  • "from": "d417d38814740a23f50b5c876e226445-0f700564-abbf-4b5b-beae-86a4ef410904",
  • "to":
    {
    • "externalUserId": "customer_21234"
    },
  • "text": "This Message was sent by targeting exact externalUserId.",
  • "validityPeriod": 30,
  • "validityPeriodTimeUnit": "MINUTES",
  • "customPayload":
    {
    • "someData": "someData",
    • "targetUrl": "www.someDomain.com"
    },
  • "notificationOptions":
    {
    • "soundEnabled": false,
    • "badge": 1,
    • "contentUrl": "https://www.example.com/images/image1.jpg",
    • "category": "mm_accept_decline",
    • "showInApp": true,
    • "inAppExpirationPeriod": 6,
    • "inAppExpirationTimeUnit": "MINUTES",
    • "inAppDismissTitle": "Close",
    • "inAppOpenTitle": "Show",
    • "primaryButtonAction":
      {},
    • "inboxTopic": "Promotion"
    },
  • "notifyUrl": "https://example.com",
  • "notifyContentType": "application/json",
  • "callbackData": "DLR callback data"
}

レスポンス例

コンテンツタイプ
application/json
コピー
 すべて折りたたむ
{
  • "bulks":
    [
    • {
      • "to":
        {
        • "externalUserId": "customer_21234"
        },
      • "status":
        {
        • "groupId": 1,
        • "groupName": "PENDING",
        • "id": 26,
        • "name": "PENDING_ACCEPTED",
        • "description": "Message accepted, pending for delivery"
        },
      • "messageCount": 1,
      • "bulkId": "oungulj9xm9b3hixkupu"
      },
    • {
      • "to":
        {
        • "externalUserId": "customer_113456"
        },
      • "status":
        {
        • "groupId": 1,
        • "groupName": "PENDING",
        • "id": 26,
        • "name": "PENDING_ACCEPTED",
        • "description": "Message accepted, pending for delivery"
        },
      • "messageCount": 1,
      • "bulkId": "gby7cz3x6m244n2e4vzb"
      }
    ]
}

ご不明点は

サポートまでお問い合わせ

ください

© NTTCom Online Marketing Solutions Corporation