ユーザーのサブスクリプショングループをリストする
get
/subscription/user/status
このエンドポイントを使用して、特定のユーザーのサブスクリプショングループを一覧表示および取得します。
例を見たり、このエンドポイントをテストしたりする場合は、メールサブスクリプショングループをご覧ください。
SMSサブスクリプショングループ用のこのエンドポイントをテストするか例を見たい場合:
このエンドポイントの例を見たり、WhatsAppグループをテストしたりする場合:
前提条件
このエンドポイントを使用するには、API キーとsubscription.groups.getの権限が必要です。
レート制限
API レート制限で説明されているように、このエンドポイントにはデフォルトの1時間あたり25万リクエストのBraze レート 制限が適用されます。
リクエストパラメーター
| パラメータ | 必須 | データ型 | 説明 |
|---|---|---|---|
external_id |
必須 | 文字列 | ユーザーの external_id (少なくとも 1 つ、最大 50 の external_ids を含める必要があります)。 |
email |
必須* | 文字列 | ユーザーのメールアドレスは、文字列の配列として渡すことができます。少なくとも 1 件のメールアドレス (最大 50件 まで) を含める必要があります。 |
phone |
必須* | E.164形式の文字列 | ユーザーの電話番号。少なくとも1つの電話番号を含める必要があります（最大50まで）。 |
limit |
オプション | 整数 | 返される結果の最大数の制限。デフォルト (および最大) の limit は 100 です。 |
offset |
オプション | 整数 | 検索条件に一致するテンプレートの残りを返す前にスキップするテンプレートの数。 |
tip:
同じメールアドレスを共有する複数のユーザー（複数のexternal_ids）がいる場合、すべてのユーザーは別々のユーザーとして返されます（たとえ同じメールアドレスやサブスクリプショングループを持っていても）。
例のリクエスト
https://rest.iad-03.braze.com/subscription/user/status?external_id[]=1&external_id[]=2
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/user/status?external_id={{external_id}}&limit=100&offset=1&phone=+11112223333' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
1
2
curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/user/status?external_id={{external_id}}&[email protected]&limit=100&offset=0' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!