このページはAIにより自動翻訳されており、不正確な内容が含まれている可能性があります。翻訳の誤りを報告するには、ページ右側の目次の下にあるフィードバックをご利用ください。

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

get

/subscription/user/status

このエンドポイントを使用して、特定のユーザーの履歴を含むサブスクリプショングループを一覧表示し、取得します。

メールサブスクリプショングループの例を確認したり、このエンドポイントをテストしたりする場合:

See me in Postman

SMSサブスクリプショングループの例を確認したり、このエンドポイントをテストしたりする場合:

See me in Postman

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

See me in Postman

前提条件

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

レート制限

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

リクエストパラメーター

パラメーター	必須	データタイプ	説明
`external_id`	必須	文字列	ユーザーの `external_id`（少なくとも1つ、最大50の `external_ids` を含める必要があります）。
`email`	必須*	文字列	ユーザーのメールアドレス。文字列の配列として渡すことができます。少なくとも1件のメールアドレス（最大50件）を含める必要があります。
`phone`	必須*	E.164 形式の文字列	ユーザーの電話番号。少なくとも1つの電話番号（最大50）を含める必要があります。
`limit`	オプション	整数	返される結果の最大数の制限。デフォルト（および最大）の `limit` は100です。
`offset`	オプション	整数	検索条件に一致する残りのテンプレートを返す前にスキップするテンプレートの数。

ヒント

同じメールアドレスを共有する複数のユーザー（複数の external_ids）がいる場合、すべてのユーザーは別々のユーザーとして返されます（同じメールアドレスやサブスクリプショングループを持っていても同様です）。

リクエスト例

https://rest.iad-03.braze.com/subscription/user/status?external_id[]=1&external_id[]=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'

レスポンス例

ユーザーの履歴でサブスクリプションステータスが更新されたサブスクリプショングループのみが、成功レスポンスに含まれます。つまり、新しく作成されたサブスクリプショングループは一覧に表示されません。

{
    "users": [
        {
            "email": "[email protected]",
            "phone": "50505050",
            "external_id": "20500",
            "subscription_groups": [
                {
                  "id": "ec2fcc919fca",
                  "name": "ActivationGroup",
                  "channel": "email",
                  "status": "Subscribed"
                },
                {
                  "id": "7d7af9dd5556",
                  "name": "ReactivationGroup",
                  "channel": "email",
                  "status": "Subscribed"
                },
                {
                  "id": "a5e84fd16220",
                  "name": "MarketingGroup",
                  "channel": "sms",
                  "status": "Unsubscribed"
                },
                {
                  "id": "64d8cad9176c",
                  "name": "TransactionalGroup",
                  "channel": "sms",
                  "status": "Unsubscribed"
                },
                {
                  "id": "b2134cd63942",
                  "name": "BankerMarketingGroup",
                  "channel": "sms",
                  "status": "Subscribed"
                }
            ]
        }
    ],
    "total_count": 1,
    "message": "success"
}

New Stuff!