Loading...

お知らせ:

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

プッシュ通知

プッシュ通知は、アプリケーションがユーザーのデバイスでアクティブに実行されていない場合でも、アプリケーションプロバイダーがアプリケーションのユーザーに送信できるリモート通知です。Catalystは、CatalystのWebおよびiOSアプリケーションにプッシュ通知を簡単に統合する方法を提供します。

Webプッシュ通知の送信

説明

このAPIは、プッシュ通知を有効にした後に、Webアプリケーションのユーザーにテスト用のテキストプッシュ通知を送信するために使用されます。このWeb SDKヘルプページに記載されているWebスクリプトを実装することで、プッシュ通知を有効にし、プッシュ通知を受信するためのクライアントデバイスを登録することもできます。その後、このAPIを使用してプッシュ通知を送信できます。

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

リクエスト詳細

リクエストURL

POST

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

copy

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

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

リクエストヘッダー

Content-Type: application/json

オプションヘッダー

CATALYST-ORG: {org_id}

Environment: Development

注意: CatalystはこのAPIリクエストを認証しません。そのため、OAuthトークンを渡す必要はありません。

スコープ

ZohoCatalyst.notifications.web.CUSTOM

リクエストJSONプロパティ

recipients string
mandatory
プッシュ通知を送信するユーザーのメールアドレスまたはユーザーID
message string
mandatory
テキスト形式のプッシュ通知のメッセージコンテンツ

レスポンス詳細

レスポンスは、送信された通知のステータスをsuccessまたはfailedとして返します。

リクエスト例
copy

curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/3000000002001/project-user/notify
-H “Content-Type: application/json”
-d ‘{ “recipients”:[“rhonda.wilkins@zylker.com”,“isabella.j@zylker.com”,“harry.sandman@zylker.com”], “message”:“Attention, new employees! Update your profile information in Zylker team app” }’

レスポンス例
copy
{
"status": "success",
"data": true
}