ユーザーのサブスクリプション グループのステータスを一覧表示する

このエンドポイントを使用して、サブスクリプション グループ内のユーザーのサブスクリプション状態を取得します。

これらのグループは 、サブスクリプション グループ ページで利用できるようになります。このエンドポイントからの応答には、API 呼び出しで要求された特定のサブスクリプション グループの外部 ID と、サブスクライブ済み、サブスクライブ解除済み、または不明のいずれかが含まれます。これを使用して、後続の API 呼び出しでサブスクリプション グループの状態を更新したり、ホストされた Web ページに表示したりできます。

電子メールサブスクリプショングループの例を確認したり、このエンドポイントをテストしたりする場合は、次の手順に従ってください。

SMS サブスクリプション グループの例を確認したり、このエンドポイントをテストしたりする場合は、次の手順に従ってください。

WhatsApp グループの例を確認したり、このエンドポイントをテストしたりする場合は、次の手順に従ってください。

前提条件

このエンドポイント を 使用するには、 subscription.status.get 許可。

レート制限

We apply the default Braze rate limit of 250,000 requests per hour to this endpoint, as documented in API rate limits.

リクエストパラメータ

*の一つ external_id または email または phone 各ユーザーごとに必要です。

• SMSおよびWhatsAppサブスクリプショングループの場合、 external_id または phone が必要です。 両方提出した場合、 external_id クエリに使用され、電話番号がそのユーザーに適用されます。
• メール購読グループの場合、 external_id または email が必要です。 両方提出した場合、 external_id クエリに使用され、そのユーザーに電子メール アドレスが適用されます。

リクエスト例

• multiple users
• sms and whatsapp
• email

1
https://rest.iad-03.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&external_id[]=1&external_id[]=2

1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&phone=+11112223333' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&email=example@braze.com' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

応答

成功した応答はすべて返されます Subscribed、 Unsubscribed、 または Unknown サブスクリプション グループのステータスとユーザー履歴に応じて異なります。

1
2
3
4
5
6
7
8
9
Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "status": {
    "1": "Unsubscribed",
    "2": "Subscribed"
  },
  "message": "success"
}