브랜드 소식 상세 조회

Request

브랜드 소식의 소식 상세 내용을 조회합니다.

get

https://api-qa.rcsbizcenter.com/bfapi/1.0https://api.rcsbizcenter.com/bfapi/1.0

/brand/{brandId}/feed/{feedId}

브랜드 소식의 소식 상세 내용을 조회합니다.

Authorizations

jwtAuth

AuthorizationstringRequired

인증방식은 JWT인증을 사용합니다. 토큰의 갱신은 없으며 토큰 만료 시 항상 재발급 받아야 합니다.

Path parameters

brandIdstringRequired

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

feedIdstringRequired

브랜드 소식 내 개별 소식 ID 입니다.

Header parameters

X-RCS-BrandkeystringOptional

maxLength: 36 - RCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key 입니다. 대행사가 브랜드 소식 API 연동 시 Header에 반드시 설정하여야 합니다.

Responses

200

페이지 내 Response 섹션 참조

get

/brand/{brandId}/feed/{feedId}

HTTPcURLJavaScriptPython

GET /bfapi/1.0/brand/{brandId}/feed/{feedId} HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

페이지 내 Response 섹션 참조

No content

Response

필드명	타입	길이	필수여부	기본값	설명
result	array<BrandFeedDetail>		O		브랜드소식상세정보
code	string	5	O	20000000	리턴코드값
status	integer	3	O	200	상태값
desc	string		O		처리메시지

result - array<BrandFeedDetail>

필드명	타입	길이	필수여부	기본값	설명
brandId	string	13	O		브랜드 ID
feedId	string	10	O		소식 ID
title	integer	40	O		브랜드 소식 제목
description	string	2000	O		브랜드 소식 내용
type	string				브랜드 소식 카드 유형(gallery, share)
status	string		O		소식의 상태값 save: 저장(최종 등록되지 않은 임시저장 상태) ok: 등록 hide: 비공개 - 숨김처리되어 목록에 비노출 delete: 논리 삭제(삭제된 소식은 수정 불가)
publishType	string		O		소식의 게시 유형 publish: 게시 - 정상 게시됨 reservation: 예약 - 지정한 일자에 소식목록에 표시되도록 예약된 소식 internet: 숨김게시 - 소식목록에 표시되지 않지만 URL을 통해 접근 가능한 소식
publishDate	string				게시 일자.
pinYn	string		O	N	소식 메인 상단 고정여부.
registerDate	string				등록 일시
updateDate	string				수정 일시
registerId	string				등록 계정 ID
updateId	string				수정 계정 ID
share	ShareType				Share 유형은 SNS 제공처에서 제공하는 오픈그래프 meta 정보를 추출하여 등록해야 합니다. share 유형의 객체입니다.
media	array<MediaType>				gallery 유형을 구성하는 이미지 정보 객체입니다.
buttons	array<Buttons>				소식 카드에 지정할 수 있는 버튼 정보 객체입니다.
feedUrl	string				status가 save가 아닌 경우 소식 URL 제공

share - ShareType

필드명	타입	길이	필수여부	기본값	설명
snsLink	string		O		소식 유형이 [share] 타입일때 의 SNS URL
title	string		O		snsLink에서 추출한 open graph tag의 title 값
description	string				snsLink에서 추출한 open graph tag의 description 값
imageUrl	string				snsLink에서 추출한 open graph tag의 image 값

media - MediaType

필드명	타입	길이	필수여부	기본값	설명
orderNo	string		O		정렬 순서
fileId	string		O		이미지 파일 ID
url	string		O		이미지 URL(파일 등록 결과로 제공됨)

buttons - Buttons

필드명	타입	길이	필수여부	기본값	설명
type	string		O		버튼 유형 (app, url, call, chat)
orderNo	string		O		정렬 순서
title	sting		O		버튼명
applink	AppLink				APP 버튼 정보 객체입니다.
link	string				버튼 유형에 따른 입력 데이터 형식은 다음과 같습니다. url 인 경우, web URL(http:// or https://로 시작하는 문자열) call 인 경우, 전화번호(숫자만 허용) chat 인 경우, 대화방ID

applink - AppLink

필드명	타입	길이	필수여부	기본값	설명
packageName	string		O		App 실행을 위한 package name
scheme	string				App 실행을 위한 scheme
uri	sting		O		App 실행을 위한 URI

❖ response body sample

200

{
    "code": "20000000",
    "desc": null,
    "result": {
        "brandId": "BR.61hBmMP164",
        "feedId": "BR.61hBmMP164.oQ6ay6aiZd",
        "publishDate": "201210181411",
        "type": "gallery",
        "title": "gallery feed title",
        "description": "gallery feed discription",
        "chType": "API",
        "media": [
            {
                "orderNo": 1,
                "fileId": "BR.61hBmMP164-FDcoZeqOY0W7",
                "url": "https://biz-dev.chatplus.co.kr/brand/BR.61hBmMP164/feed/20240704/BR.61hBmMP164-FDcoZeqOY0W7.jpg"
            },
            {
                "orderNo": 2,
                "fileId": "BR.61hBmMP164-FDcoZeqOY0W7",
                "url": "https://biz-dev.chatplus.co.kr/brand/BR.61hBmMP164/feed/20240704/BR.61hBmMP164-FDcoZeqOY0W7.jpg"
            }
        ],
        "buttons": [
            {
                "type": "call",
                "orderNo": 1,
                "title": "전화걸기",
                "link": "15884741"
            },
            {
                "type": "app",
                "orderNo": 2,
                "title": "앱 다운로드",
                "appLink": {
                    "packageName": "com.nhn.android.search",
                    "scheme": "naversearchapp",
                    "uri": "http://naverapp.naver.com/inappbrowser/?url=http%3A%2F%2Fm.naver.com&target=new&version=6"
                }
            }
        ],
        "publishType": "publish",
        "status": "save",
        "pinYn": "N",
        "registerId": "swjeong75",
        "registerDate": "2024-07-04T10:44:21.000+09",
        "updateId": "swjeong75",
        "updateDate": "2024-07-04T10:44:21.000+09"
    },
    "status": 200
}

401

error code는 브랜드소식 - Response body error code 참조