Skip to content

사용자의 구독 그룹 상태 나열

get

/subscription/status/get

이 엔드포인트를 사용하여 구독 그룹에 속한 사용자의 구독 상태를 가져오세요.

이러한 그룹은 정기구독 그룹 페이지에서 사용할 수 있습니다. 이 엔드포인트의 응답에는 API 호출에서 요청한 특정 구독 그룹에 대한 외부 ID와 구독 중, 구독 취소 또는 알 수 없음이 포함됩니다. 이는 후속 API 호출에서 구독 그룹 상태를 업데이트하거나 호스팅된 웹 페이지에 표시하는 데 사용할 수 있습니다.

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

See me in Postman

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

See me in Postman

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

See me in Postman

필수 구성 요소

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

사용량 제한

요청 매개변수

매개변수 필수 데이터 유형 설명
subscription_group_id 필수 문자열 구독 그룹의 id.
external_id 필수* 문자열 사용자의 external_id (최소 1개, 최대 50개 external_ids)를 포함해야 합니다.

external_id 및 email/phone 을 모두 제출한 경우, 제공된 external_id 만 결과 쿼리에 적용됩니다.
email 필수* 문자열 사용자의 이메일 주소입니다. 최대 50개의 문자열 배열로 전달할 수 있습니다.

이메일 주소와 전화번호를 모두 제출하면( external_id 없이) 오류가 발생합니다.
phone 필수* 문자열의 E.164 형식 사용자의 전화번호입니다. 이메일이 포함되지 않은 경우 전화번호를 하나 이상 포함해야 합니다(최대 50개).

이메일 주소와 전화번호를 모두 제출하면( external_id 없이) 오류가 발생합니다.

요청 예시

1

https://rest.iad-03.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&external_id[]=1&external_id[]=2

1
2

curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&phone=+11112223333' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

1
2

curl --location -g --request GET 'https://rest.iad-01.braze.com/subscription/status/get?subscription_group_id={{subscription_group_id}}&email=example@braze.com' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

응답

모든 성공적인 응답은 구독 그룹의 상태 및 사용자 기록에 따라 Subscribed, Unsubscribed 또는 Unknown으로 반환됩니다.

1
2
3
4
5
6
7
8
9

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "status": {
    "1": "Unsubscribed",
    "2": "Subscribed"
  },
  "message": "success"
}
Github   GitHub 에서 이 페이지를 편집합니다.
이 페이지가 얼마나 도움이 되었나요?
New Stuff!