Skip to content

ユーザーの購読グループステータスを一覧表示する

get

/subscription/status/get

このエンドポイントを使用して、購読グループ内のユーザーの購読ステートを取得します。

これらのグループは、購読グループページで利用できます。このエンドポイントからのレスポンスには、external IDと、API呼び出しでリクエストされた特定の購読グループに対する購読中、購読解除、または不明のいずれかが含まれます。これは、後続のAPI呼び出しで購読グループステートを更新したり、ホストされたWebページに表示したりするために使用できます。

メール購読グループの例を確認したり、このエンドポイントをテストしたりする場合:

See me in Postman

SMS購読グループの例を確認したり、このエンドポイントをテストしたりする場合:

See me in Postman

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

See me in Postman

前提条件

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

レート制限

APIレート制限に記載されているように、このエンドポイントにはBrazeのデフォルトのレート制限（1時間あたり250,000リクエスト）が適用されます。

リクエストパラメーター

パラメーター 必須 データタイプ 説明
subscription_group_id 必須 文字列 購読グループのid。
external_id 必須* 文字列 ユーザーのexternal_id（少なくとも1つ、最大50のexternal_idsを含める必要があります）。

external_idとemail/phoneの両方が送信された場合、指定されたexternal_idのみが結果クエリに適用されます。
email 必須* 文字列 ユーザーのメールアドレス。最大50個の文字列の配列として渡すことができます。

メールアドレスと電話番号の両方を送信した場合（external_idなし）、エラーが発生します。
phone 必須* E.164 形式の文字列 ユーザーの電話番号。メールが含まれていない場合は、少なくとも1つの電話番号を含める必要があります（最大50）。

メールアドレスと電話番号の両方を送信した場合（external_idなし）、エラーが発生します。

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

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

リクエスト例

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'

レスポンス

すべての成功したレスポンスは、購読グループのステータスとユーザー履歴に応じて、Subscribed、Unsubscribed、またはUnknownを返します。

1
2
3
4
5
6
7

{
  "status": {
    "1": "Unsubscribed",
    "2": "Subscribed"
  },
  "message": "success"
}
New Stuff!