Skip to content

ユーザーのサブスクリプショングループをリストする

get

/subscription/user/status

このエンドポイントを使用して、特定のユーザーの履歴を持つサブスクリプショングループをリストアップし、取得する。

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

See me in Postman

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

See me in Postman

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

See me in Postman

前提条件

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

レート制限

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

リクエストパラメーター

例のリクエスト

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
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

{
    "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"
}
Github   GitHub でこのページを編集
New Stuff!