1 of 8

자동응답 메시지

이 문서는 자동응답에 대한 API 정보를 안내합니다.

자동응답 메시지 목록 조회

Request

Response

필드명

타입

길이

필수여부

기본값

설명

array<object>

자동응답메시지 기본 정보입니다.

code

string

20000000

status

integer

200

desc

string

object

전체 건수와 페이징 조건을 제공합니다.

object

이전/다음 페이지 링크를 제공합니다. offset을 0이 아닌 limit보다 작은 양수값으로 설정한 경우 prev 는 null로 응답됩니다.

result - array<object>

필드명

타입

길이

필수여부

기본값

설명

brandId

string

자동응답메시지 기본 정보입니다.

autoReplyMsgId

string

20000000

autoReplyMsgName

string

100

200

messagebaseId

string

approvalResult

string

registerDate

string

updateDate

string

registerId

string

updateId

string

pagination - object

필드명

타입

길이

필수여부

기본값

설명

total

integer

전체건수

offset

integer

조회 기준 위치

limit

integer

100

페이지 당 조회 건수

links - object

필드명

타입

길이

필수여부

기본값

설명

prev

string

이전페이지URL

next

string

다음페이지URL

❖ response body sample

{
    "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
}

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

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

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

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

자동응답 메시지 상세 조회

Request

Response

result - array<object>

buttons - array<object>

suggestions - array<object>, chipList - array<object>

❖ response body sample

자동응답 메시지 등록

Request

Response

{
    "autoReplyMsgName": "복권기금 안내",
    "messagebaseId": "SCS00000",
    "copyAllowed": true,
    "body": {
        "description": "이 복권은 복권 및 복권기금법 제4조에 의거 발행되며 조성된 자금은 동법 제23조에 따라 소외계층 지원사업등에 사용됩니다."
    }
}

{
    "autoReplyMsgName": "카드",
    "messagebaseId": "SCwThM00",
    "copyAllowed": true,
    "body": {
        "title": "카드제목",
        "description": "카드내용",
        "media": "BR.61hBmMP164-ARME1M6dN9c3l"
    },
    "buttons": [
        {
            "suggestions": [
                {
                    "action": {
                        "displayText": "RCS비즈센터",
                        "urlAction": {
                            "openUrl": {
                                "url": "https://www-qa.rcsbizcenter.com"
                            }
                        }
                    }
                }
            ]
        }
    ],
    "chipList": [
        {
            "action": {
                "dialerAction": {
                    "dialPhoneNumber": {
                        "phoneNumber": "07082245288"
                    }
                },
                "displayText": "고객센터"
            }
        }
    ]
}

{
    "autoReplyMsgName": "슬라이드",
    "messagebaseId": "CCwMhM0200",
    "copyAllowed": true,
    "body": {
        "title1": "슬라이드1",
        "description1": "슬라이드1",
        "media1": "BR.61hBmMP164-ARM6tE1T7nzwf",
        "title2": "슬라이드2",
        "description2": "슬라이드2",
        "media2": "BR.61hBmMP164-ARMsYgo2O538B"
    },
    "buttons": [
        {
            "suggestions": [
                {
                    "action": {
                        "dialerAction": {
                            "dialPhoneNumber": {
                                "phoneNumber": "119"
                            }
                        },
                        "displayText": "긴급연락119"
                    }
                }
            ]
        },
        {
            "suggestions": [
                {
                    "action": {
                        "displayText": "유튜브연결",
                        "urlAction": {
                            "openUrl": {
                                "url": "https://utube.com"
                            }
                        }
                    }
                }
            ]
        }
    ]
}

Response

필드명

타입

길이

필수여부

기본값

설명

array<object>

자동응답메시지 ID

code

string

20000000

status

integer

200

desc

string

result - array<object>

필드명

타입

길이

필수여부

기본값

설명

result

array<object>

자동응답메시지 ID

❖ response body sample

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "autoReplyMsgId": "ARMKlU2bCGpsV37"
        }
    ],
    "status": 200
}

{
    "error": {
        "code": "64336",
        "message": "required value: [autoReplyMsgName]"
    },
    "status": 400
}

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

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

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

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

자동응답 메시지 수정

Request

❖ request body sample

Response

result - array<object>

❖ response body sample

자동응답 메시지 삭제

Request

Response

필드명

타입

길이

필수여부

기본값

설명

array<object>

자동응답메시지 ID

code

string

20000000

status

integer

200

desc

string

result - array<object>

필드명

타입

길이

필수여부

기본값

설명

autoReplyMsgId

string

자동응답메시지 ID

❖ response body sample

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "autoReplyMsgId": "ARMKlU2bCGpsV37"
        }
    ],
    "status": 200
}

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

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

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

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

자동응답 메시지 이미지 상세 조회

Request

Response

필드명

타입

길이

필수여부

기본값

설명

array<object>

자동응답메시지용 파일 등록 정보입니다.

code

string

20000000

status

integer

200

desc

string

result - array<object>

필드명

타입

길이

필수여부

기본값

설명

fileId

string

등록된 파일의 ID 입니다.

url

string

128

등록된 파일의 URL 정보 입니다.

fileName

string

256

등록한 파일의 이름입니다.

❖ response body sample

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "fileId": "BR.61hBmMP164-ARMExJiCTJSzQ",
            "url": "https://file-qa.rcsbizcenter.com/brand/BR.61hBmMP164/autoreplymsg/BR.61hBmMP164-ARMExJiCTJSzQ_1.png",
            "fileName": "BR.275F8GY6nR-FD4DBi3W06i5.png"
        }
    ],
    "status": 200
}

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

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

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

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

자동응답 메시지 이미지 등록

Request

Response

result - array<object>

❖ response body sample

자동응답 메시지 등록

Request

Response

{
    "autoReplyMsgName": "복권기금 안내",
    "messagebaseId": "SCS00000",
    "copyAllowed": true,
    "body": {
        "description": "이 복권은 복권 및 복권기금법 제4조에 의거 발행되며 조성된 자금은 동법 제23조에 따라 소외계층 지원사업등에 사용됩니다."
    }
}

{
    "autoReplyMsgName": "카드",
    "messagebaseId": "SCwThM00",
    "copyAllowed": true,
    "body": {
        "title": "카드제목",
        "description": "카드내용",
        "media": "BR.61hBmMP164-ARME1M6dN9c3l"
    },
    "buttons": [
        {
            "suggestions": [
                {
                    "action": {
                        "displayText": "RCS비즈센터",
                        "urlAction": {
                            "openUrl": {
                                "url": "https://www-qa.rcsbizcenter.com"
                            }
                        }
                    }
                }
            ]
        }
    ],
    "chipList": [
        {
            "action": {
                "dialerAction": {
                    "dialPhoneNumber": {
                        "phoneNumber": "07082245288"
                    }
                },
                "displayText": "고객센터"
            }
        }
    ]
}

{
    "autoReplyMsgName": "슬라이드",
    "messagebaseId": "CCwMhM0200",
    "copyAllowed": true,
    "body": {
        "title1": "슬라이드1",
        "description1": "슬라이드1",
        "media1": "BR.61hBmMP164-ARM6tE1T7nzwf",
        "title2": "슬라이드2",
        "description2": "슬라이드2",
        "media2": "BR.61hBmMP164-ARMsYgo2O538B"
    },
    "buttons": [
        {
            "suggestions": [
                {
                    "action": {
                        "dialerAction": {
                            "dialPhoneNumber": {
                                "phoneNumber": "119"
                            }
                        },
                        "displayText": "긴급연락119"
                    }
                }
            ]
        },
        {
            "suggestions": [
                {
                    "action": {
                        "displayText": "유튜브연결",
                        "urlAction": {
                            "openUrl": {
                                "url": "https://utube.com"
                            }
                        }
                    }
                }
            ]
        }
    ]
}

Response

필드명

타입

길이

필수여부

기본값

설명

array<object>

자동응답메시지 ID

code

string

20000000

status

integer

200

desc

string

result - array<object>

필드명

타입

길이

필수여부

기본값

설명

result

array<object>

자동응답메시지 ID

❖ response body sample

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "autoReplyMsgId": "ARMKlU2bCGpsV37"
        }
    ],
    "status": 200
}

{
    "error": {
        "code": "64336",
        "message": "required value: [autoReplyMsgName]"
    },
    "status": 400
}

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

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

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

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

자동응답 메시지 목록 조회

Request

Response

필드명

타입

길이

필수여부

기본값

설명

array<object>

자동응답메시지 기본 정보입니다.

code

string

20000000

status

integer

200

desc

string

object

전체 건수와 페이징 조건을 제공합니다.

object

이전/다음 페이지 링크를 제공합니다. offset을 0이 아닌 limit보다 작은 양수값으로 설정한 경우 prev 는 null로 응답됩니다.

result - array<object>

필드명

타입

길이

필수여부

기본값

설명

brandId

string

자동응답메시지 기본 정보입니다.

autoReplyMsgId

string

20000000

autoReplyMsgName

string

100

200

messagebaseId

string

approvalResult

string

registerDate

string

updateDate

string

registerId

string

updateId

string

pagination - object

필드명

타입

길이

필수여부

기본값

설명

total

integer

전체건수

offset

integer

조회 기준 위치

limit

integer

100

페이지 당 조회 건수

links - object

필드명

타입

길이

필수여부

기본값

설명

prev

string

이전페이지URL

next

string

다음페이지URL

❖ response body sample

{
    "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
}

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

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

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

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

브랜드에 자동응답메시지를 등록합니다.

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

자동응답메시지에 등록 가능한 액션이 추가 되었습니다.

전화걸기
웹사이트(내부브라우져)
웹사이트(외부브라우져)
대화방연결(메시지작성)
캘린더(일정)
지도(좌표)
지도(키워드)
지도(현재위치)
<신규>자동응답메시지연결
<신규>챗봇연결

제공되는 productcode = chat 해당 messagebaseId를 지정하여 사용하며 다음과 같이 처리 됩니다.

기본 말풍선(SCS00000), 텍스트 카드(SCL00000)는 기본 말풍선(SCS00000)으로 처리
세로형_Meduim(SCwThM00), 세로형_Tall(SCwThT00)은 세로형_Meduim(SCwThM00)으로 처리
슬라이드형_Medium, 슬라이드형_Small은 슬라이드형_Medium으로 처리
- 슬라이드형 Medium ID: CCwMhM0200 ~ CCwMhM0600

따라서 지정된 messagebaseId에만 존재하는 필드가 전환되는 messagebaseId에 존재하지 않는 경우 무시됩니다.

예를 들어, 텍스트 카드로 등록 시 title을 입력하더라도 기본 말풍선은 title을 지원하지 않으므로 title이 적용되지 않습니다.

post

/brand/{brandId}/autoreplymsg

Authorizations

Path parameters

brandIdstring · max: 13required

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

Header parameters

X-RCS-Brandkeystring · max: 18

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

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

Body

autoReplyMsgNamestring · max: 100required

maxLength: 100 - 자동응답메시지 명을 지정합니다.

messagebaseIdstring · max: 40required

maxLength: 40 - 메시지 상품코드 chat에 속하는 messagebase ID를 지정합니다.

제공되는 productcode = chat 해당 messagebaseId를 지정하여 사용 가능하나 다음과 같이 처리됩니다.

기본 말풍선(SCS00000), 텍스트 카드(SCL00000)는 기본 말풍선(SCS00000)으로 처리
세로형_Meduim(SCwThM00), 세로형_Tall(SCwThT00)은 세로형_Meduim(SCwThM00)으로 처리
슬라이드형_Medium, 슬라이드형_Small은 슬라이드형_Medium으로 처리
- 슬라이드형 Medium ID: CCwMhM0200 ~ CCwMhM0600

지정된 ID에만 존재하는 필드가 전환되는 ID에 존재하지 않는 경우 무시됩니다.

예를 들어, 텍스트 카드로 등록시 title을 입력하더라도 기본 말풍선은 title을 지원하지 않으므로 title이 적용되지 않습니다.

copyAllowedboolean · default: true

단말에서 메시지 복사 가능 여부를 지정합니다.

true : 복사 가능
false : 복사 불가

bodyobjectrequired

이통 발송규격 중 /message API의 body object와 동일한 방식으로 값을 지정합니다.

buttonsobject[]

자동응답메시지에 버튼을 등록합니다.

지원하는 action 유형은 다음과 같습니다.

urlAction : 기본 브라우저에서 웹페이지 링크
localBrowserAction : 채팅+ 내부 브라우저에서 웹페이지 표시
mapAction : 지도 상의 특정 위치 표시 또는 현재 위치 공유
calendarAction : 캘린더에 일정 공유
clipboardAction : 클립보드로 복사
composeAction : 지정 대화방에 메시지 작성
dialerAction : 전화걸기
reply : 다른 자동응답메시지 연결, 챗봇응답

다른 자동응답메시지 연결 시에는 reply JSON object 내에 autoReplyMsgId 필드에 자동응답메시지ID를 지정하며, postback.data는 자동할당 됩니다.

chipListone of[]

자동응답메시지에 칩리스트를 지정합니다. 지원하는 action 유형은 다음과 같습니다.

urlAction : 기본 브라우저에서 웹페이지 링크
localBrowserAction : 채팅+ 내부 브라우저에서 웹페이지 표시
mapAction : 지도 상의 특정 위치 표시 또는 현재 위치 공유
calendarAction : 캘린더에 일정 공유
clipboardAction : 클립보드로 복사
composeAction : 지정 대화방에 메시지 작성
dialerAction : 전화걸기
reply : 다른 자동응답메시지 연결, 챗봇응답

다른 자동응답메시지 연결 시에는 reply JSON object 내에 autoReplyMsgId 필드에 자동응답메시지ID를 지정하며, postback.data는 자동할당 됩니다.

cURL

JavaScript

Python

HTTP