Skip to content

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

get

/subscription/status/get

이 엔드포인트를 사용하여 구독 그룹에 속한 사용자의 구독 상태를 가져올 수 있습니다.

이러한 그룹은 구독 그룹 페이지에서 확인할 수 있습니다. 이 엔드포인트의 응답에는 API 호출에서 요청한 특정 구독 그룹에 대한 외부 ID와 가입됨(subscribed), 탈퇴(unsubscribed) 또는 알 수 없음(unknown) 상태가 포함됩니다. 이를 통해 후속 API 호출에서 구독 그룹 상태를 업데이트하거나 호스팅된 웹 페이지에 표시할 수 있습니다.

커스텀 양식을 통해 이메일을 수집한 후 REST API를 통해 구독 그룹 멤버십을 설정하는 경우, 먼저 이 엔드포인트를 호출하여 프로필이 이미 존재하는지 확인하세요. 일치하는 프로필이 없으면 사용자의 구독 그룹 상태 업데이트 엔드포인트를 사용하여 사용자를 생성하거나 구독시키세요. 그렇지 않으면 중복 생성 대신 기존 프로필을 업데이트하세요. 기타 수집 패턴에 대해서는 수집 모범 사례를 참조하세요.

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

See me in Postman

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

See me in Postman

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

See me in Postman

필수 조건

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

사용량 제한

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

요청 매개변수

매개변수 필수 데이터 유형 설명
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 없이) 오류가 발생합니다.

*각 사용자에 대해 external_id 또는 email 또는 phone 중 하나가 필요합니다.

  • SMS 및 WhatsApp 구독 그룹의 경우 external_id 또는 phone이 필요합니다. 둘 다 제출하면 external_id만 쿼리에 사용되며 해당 사용자에게 전화번호가 적용됩니다.
  • 이메일 구독 그룹의 경우 external_id 또는 email이 필요합니다. 둘 다 제출하면 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'

응답

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

1
2
3
4
5
6
7

{
  "status": {
    "1": "Unsubscribed",
    "2": "Subscribed"
  },
  "message": "success"
}
New Stuff!