뉴스레터 구독자 목록 가져오기

뉴스레터 구독자 목록을 가져오는 API입니다.

매뉴얼웍스 6.0.21 버전부터 지원합니다.

API 만들기

<도구 | API> 메뉴에서 “NEWSLETTER” 유형 API를 만듭니다.

API 요청

GET 형식으로 요청해야 합니다.

/r/api/${uuid}?action=NEWSLETTER_LIST&page=${page}&status=${status}
URL 파라미터

이름

유형

설명

필수 여부

예

uuid

UUID

API UUID

예

5b969d63e97cfec7

action

문자열

작업 유형

예

NEWSLETTER_LIST

page

숫자

가져올 쪽 번호. 1부터 시작

아니오

1

status

문자열

가져올 구독 상태

아니오

SUBSCRIBED | UNSUBSCRIBED

구독자 목록을 가져오는 예제입니다.

/r/api/5b969d63e97cfec7?action=NEWSLETTER_LIST&page=1&status=SUBSCRIBED

다음을 참고합니다.

API 응답

NEWSLETTER_LIST 응답

JSON 형식의 응답은 다음과 같습니다.

NEWSLETTER_LIST 응답

이름

유형

설명

필수 여부

예

status

문자열

상태

예

success | fail

subscribers

구독자 목록 객체

구독자 목록

아니오


errors

Error 객체 배열

예외

아니오


구독자 목록 객체는 다음과 같습니다.

구독자 목록 객체

이름

유형

설명

예

page

숫자

가져온 쪽 번호

1

totalPage

숫자

전체 쪽 수

5

totalCount

숫자

전체 구독자 수

87

countOfOnePage

숫자

한 쪽에 담는 구독자 수

20

values

구독자 객체 배열

구독자 목록


예외 항목

예외 항목은 다음과 같습니다.

NEWSLETTER_LIST 예외 항목

예외

설명

INVALID_PARAMETER

status 값이 구독 상태가 아닐 때

page가 숫자가 아니거나 1보다 작을 때

예제

예제입니다.

{
    "status": "success",
    "subscribers": {
        "page": 1,
        "totalPage": 5,
        "totalCount": 87,
        "countOfOnePage": 20,
        "values": [
            {
                "id": "5b969d63e97cfec7",
                "email": "support@3rabbitz.com",
                "name": "쓰리래빗츠",
                "status": "SUBSCRIBED",
                "createTime": 1785203527087,
                "updateTime": 1785203527087
            }
        ]
    }
}