사용자의 구독 그룹 나열
get
/subscription/user/status
이 엔드포인트를 사용하여 특정 사용자의 구독 그룹을 나열하고 가져옵니다.
이메일 구독 그룹에 대한 이 엔드포인트의 예제를 보거나 테스트하려면 다음과 같이 하세요:
예제를 보거나 SMS 구독 그룹에 대한 이 엔드포인트를 테스트하려면 다음과 같이 하세요:
WhatsApp 그룹에 대한 이 엔드포인트의 예시를 보거나 테스트하려면 다음과 같이 하세요:
전제 조건
이 엔드포인트를 사용하려면 subscription.groups.get 권한이 있는 API 키가 필요합니다.
사용량 제한
요청 매개변수
| 매개변수 | 필수 | 데이터 유형 | 설명 |
|---|---|---|---|
external_id |
필수 | 문자열 | 사용자의 external_id (최소 1개, 최대 50개 external_ids)를 포함해야 합니다. |
email |
필수* | 문자열 | 사용자의 이메일 주소는 문자열 배열로 전달할 수 있습니다. 이메일 주소를 하나 이상(최대 50개) 포함해야 합니다. |
phone |
필수* | 문자열의 E.164 형식 | 사용자의 전화번호입니다. 전화번호를 하나 이상 포함해야 합니다(최대 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=example@braze.com&limit=100&offset=0' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'
GitHub 에서 이 페이지를 편집합니다.
이 페이지가 얼마나 도움이 되었나요?
New Stuff!