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

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

これらのグループは、サブスクリプショングループページで使用できます。このエンドポイントからの応答には、外部ID と、API 呼び出しで要求された固有のサブスクリプショングループの配信登録済み、配信停止済み、または不明のいずれかが含まれます。これは、後続のAPI 呼び出しでサブスクリプショングループステートを更新したり、ホストWeb ページに表示したりするために使用できます。

例を見たり、このエンドポイントをテストしたりする場合は、メールサブスクリプショングループをご覧ください。

SMSサブスクリプショングループ用のこのエンドポイントをテストするか例を見たい場合:

このエンドポイントの例を見たり、WhatsAppグループをテストしたりする場合:

前提条件

このエンドポイントを使用するには、API キーとsubscription.status.getの権限が必要です。

レート制限

API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。

リクエストパラメーター

* ユーザーごとにexternal_id またはemail またはphone のいずれかが必要です。

• SMS およびWhatsApp サブスクリプショングループ s の場合、external_id またはphone のいずれかが必要です。 両方が送信されると、external_id のみがクエリに使用され、電話番号はそのユーザーに適用されます。
• メール サブスクリプショングループs の場合、external_id またはemail のいずれかが必要です。 両方が送信されると、external_id のみがクエリに使用され、メールアドレスはそのユーザーに適用されます。

例のリクエスト

• 複数のユーザー
• smsとwhatsapp
• メール

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 protected]' \
--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"
}