자동응답 메시지 목록 조회

Request

브랜드 내에 등록된 자동응답메시지 목록을 조회합니다.

브랜드 내에 등록된 자동응답메시지 목록을 조회합니다.

• 계정 권한: 마스터, 매니저, 대행사
• 브랜드 권한: 브랜드 대표운영자, 운영자

get

/brand/{brandId}/autoreplymsg

Authorizations

Path parameters

brandIdstring · max: 13required

maxLength: 13 - 브랜드 내 정보 접근시 사용되는 브랜드ID Path Parameter 입니다.

Query parameters

offsetinteger · default: 0

시작 offset 번호(default: 0) 입니다.

limitinteger · min: 100 · max: 1000 · default: 100

조회 최대 건수(default: 100, maximum: 1000) 입니다.

Header parameters

X-RCS-Brandkeystring · max: 18

maxLength: 18 - RCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key 입니다.

대행사가 해당 브랜드에 대한 권한 여부를 판단하는데 사용됩니다. 따라서, 대행사 계정으로 브랜드 내 정보를 조회/등록/수정 API 연동 시 Header에 설정되어야 합니다.

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api-qa.rcsbizcenter.com/api/1.1/brand/{brandId}/autoreplymsg' \
  --header 'Authorization: Bearer JWT'

Response

필드명	타입	길이	필수여부	기본값	설명
result	array<object>		O		자동응답메시지 기본 정보입니다.
code	string	5	O	20000000
status	integer	3	O	200
desc	string		O
pagination	object		O		전체 건수와 페이징 조건을 제공합니다.
links	object		O		이전/다음 페이지 링크를 제공합니다. offset을 0이 아닌 limit보다 작은 양수값으로 설정한 경우 prev 는 null로 응답됩니다.

result - array<object>

필드명	타입	길이	필수여부	기본값	설명
brandId	string	13	O		자동응답메시지 기본 정보입니다.
autoReplyMsgId	string	40	O	20000000
autoReplyMsgName	string	100	O	200
messagebaseId	string	40	O
approvalResult	string
registerDate	string
updateDate	string
registerId	string
updateId	string

pagination - object

필드명	타입	길이	필수여부	기본값	설명
total	integer		O		전체건수
offset	integer		O	0	조회 기준 위치
limit	integer		O	100	페이지 당 조회 건수

links - object

필드명	타입	길이	필수여부	기본값	설명
prev	string		O		이전페이지URL
next	string		O		다음페이지URL

❖ response body sample

200

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "brandId": "BR.61hBmMP164",
            "autoReplyMsgId": "ARMc6oQEOjni1CP",
            "autoReplyMsgName": "슬라이드",
            "messagebaseId": "CCwMhM0200",
            "approvalResult": "등록완료",
            "registerDate": "2024-06-26T17:53:53.000+09",
            "updateDate": "2024-06-26T17:53:53.000+09",
            "registerId": "hong",
            "updateId": "hong"
        },
        {
            "brandId": "BR.61hBmMP164",
            "autoReplyMsgId": "ARMkGval9jAEuTZ",
            "autoReplyMsgName": "카드1장",
            "messagebaseId": "SCwThM00",
            "approvalResult": "등록완료",
            "registerDate": "2024-06-26T17:51:21.000+09",
            "updateDate": "2024-06-26T17:51:21.000+09",
            "registerId": "hong",
            "updateId": "hong"
        },
        {
            "brandId": "BR.61hBmMP164",
            "autoReplyMsgId": "ARM4SI1M9gAu0fl",
            "autoReplyMsgName": "말풍선",
            "messagebaseId": "SCS00000",
            "approvalResult": "등록완료",
            "registerDate": "2024-06-26T16:02:18.000+09",
            "updateDate": "2024-06-26T16:02:18.000+09",
            "registerId": "hong",
            "updateId": "hong"
        }
    ],
    "pagination": {
        "offset": 0,
        "limit": 100,
        "total": 3
    },
    "links": {
        "prev": null,
        "next": null
    },
    "status": 200
}

400

{
    "error": {
        "code": "64002",
        "message": "Invalid Brand Key"
    },
    "status": 400
}

401

{
    "error": {
        "code": "61003",
        "message": "Invalid token"
    },
    "status": 401
}

403

{
    "error": {
        "code": "63001",
        "message": "No Brand Permission"
    },
    "status": 403
}

error code는 RCS Biz Center - Response body error code 참조