Skip to content

사용자의 구독 그룹 나열

get

/subscription/user/status

이 엔드포인트를 사용하여 특정 사용자의 기록이 있는 구독 그룹을 나열하고 가져올 수 있습니다.

이메일 구독 그룹에 대한 이 엔드포인트의 예제를 보거나 테스트하려면 다음을 참조하세요:

See me in Postman

SMS 구독 그룹에 대한 이 엔드포인트의 예제를 보거나 테스트하려면 다음을 참조하세요:

See me in Postman

WhatsApp 그룹에 대한 이 엔드포인트의 예제를 보거나 테스트하려면 다음을 참조하세요:

See me in Postman

필수 조건

이 엔드포인트를 사용하려면 subscription.groups.get 권한이 있는 API 키가 필요합니다.

사용량 제한

이 엔드포인트에는 API 사용량 제한 설명서에 명시된 대로 기본 Braze 사용량 제한인 시간당 250,000건의 요청이 적용됩니다.

요청 매개변수

매개변수 필수 데이터 유형 설명
external_id 필수 문자열 사용자의 external_id입니다(최소 1개, 최대 50개의 external_ids를 포함해야 합니다).
email 필수* 문자열 사용자의 이메일 주소이며, 문자열 배열로 전달할 수 있습니다. 이메일 주소를 하나 이상(최대 50개) 포함해야 합니다.
phone 필수* E.164 형식의 문자열 사용자의 전화번호입니다. 전화번호를 하나 이상(최대 50개) 포함해야 합니다.
limit 선택 사항 정수 반환되는 최대 결과 수에 대한 제한입니다. 기본값(및 최대값) limit은 100입니다.
offset 선택 사항 정수 검색 기준에 맞는 나머지 템플릿을 반환하기 전에 건너뛸 템플릿의 수입니다.

요청 예시

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'

응답 예시

사용자 기록에서 구독 상태 업데이트가 있었던 구독 그룹만 성공적인 응답에 포함됩니다. 즉, 새로 생성된 구독 그룹은 나열되지 않습니다.

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"
}
New Stuff!