Loading...

お知らせ:

当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

iOSプッシュ通知の送信

説明

このAPIは、Appleにアプリを登録し、Catalystプッシュ通知に登録し、デバイスを登録した後に、iOSアプリからユーザーデバイスにテスト用のテキストプッシュ通知を送信するために使用されます。デバイスにプッシュ通知を送信する前に、プッシュ通知 - iOSヘルプセクションで説明されている6つのステップを実装する必要があります。

Catalystでは、それぞれの環境の設定ファイルからappID値を渡すことで、登録済みのテストデバイスまたは本番デバイスにプッシュ通知を送信できます。テストデバイスへのプッシュ通知送信と本番デバイスへのプッシュ通知送信では、リクエストURLが異なります。これらはリクエスト詳細セクションに記載されています。

プッシュ通知メッセージと送信先の受信者を、サンプルリクエストに示すようにAPIリクエストで他の詳細とともに渡すことができます。

リクエスト詳細

テスト通知を送信するリクエストURL

POST

{api-domain}/baas/v1/project/{project_id}/push-notification/{app_id}/test

copy

本番通知を送信するリクエストURL

POST

{api-domain}/baas/v1/project/{project_id}/push-notification/{app_id}/project-user/notify

copy

api-domain
URL
Catalyst APIにアクセスするためのDC固有のドメイン

project_id
Numerical
プロジェクトの一意のID

app_id
Numerical
適切な環境のAppConfigurationDevelopment.plist/ AppConfigurationProduction.plistファイルから取得したnotificationAppID

リクエストヘッダー

Content-Type: application/json

オプションヘッダー

CATALYST-ORG: {org_id}

Environment: Development

スコープ

ZohoCatalyst.notifications.mobile.CUSTOM

リクエストJSONプロパティ

recipient string
mandatory
プッシュ通知を送信するユーザーのメールアドレス。1回のAPI呼び出しで1人のユーザーにのみ送信できます。
push_details json
mandatory

プッシュ通知のコンテンツとメタデータの詳細を含むJSON

message string
mandatory
プッシュ通知のテキストコンテンツ
最大サイズ: 100文字

additional_info json
optional
*“sample_key” : “sample_value”*の形式で送信する必要がある追加情報
最大サイズ: 100文字

badge_count integer
optional
アプリのアイコン上に表示されるカウント

reference_id string
optional
参照用のID

expiry_time integer
optional
通知の有効期限(時間単位)

レスポンス詳細

レスポンスは、送信された通知のステータスをsuccessまたはfailedとして返し、messageやexpiry_timeを含む渡されたデータを返します。

リクエスト例: 本番デバイス
copy

curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/204000000024010/push-notification/204000000036005/project-user/notify
-H “Content-Type: application/json”
-d ‘{ “recipients”:“amanda.boyle@zylker.com”, “push_details”:{ “message”:“Welcome to Zylker App!”, “badge_count”:10, “expiry_time”:12, “additional_info”:{ “sample_key” : “sample_value” } } }’

レスポンス例
copy
{
"status": "success",
"data": {
    "recipients": "amanda.boyle@zylker.com",
    "push_details": {
        "message": "Welcome to Zylker App!",
        "additional_info": {
            "sample_key": "sample_value"
        },
        "badge_count": 10,
        "reference_id": null,
        "expiry_time": 12
    }
}
}