브랜드 소식 등록

Request

브랜드 소식을 등록합니다.

브랜드 소식을 등록합니다. 브랜드 소식에 등록 가능한 소식 유형에는 Gallery, Share 2가지 유형이 있습니다. 추후 Slide 유형을 추가로 제공할 예정입니다. Gallery 유형 소식 등록 시 포함되는 이미지는 파일 업로드 API를 이용하여 사전 등록해야 합니다. 이미지 파일 등록 시 발급되는 ID를 이용하여야 소식에 이미지를 표시할 수 있습니다.

post

/brand/{brandId}/feed

Authorizations

Path parameters

brandIdstringrequired

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

Header parameters

X-RCS-Brandkeystring

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

Body

titlestringrequired

maxLength: 40 - 브랜드 소식 제목

descriptionstringrequired

maxLength: 2000 - 브랜드 소식 내용

typestring · enumrequired

브랜드 소식 카드 유형

Options: gallery, share

shareobject

Share 유형은 SNS 제공처에서 제공하는 오픈그래프 meta 정보를 추출하여 등록해야 합니다. share 유형의 객체입니다.

mediaobject[]

gallery 유형을 구성하는 이미지 정보 객체입니다.

buttonsobject[]

소식 카드에 지정할 수 있는 버튼 정보 객체입니다.

statusstring · enumrequired

등록 시 지정할 소식의 상태값

• save: 저장(최종 등록되지 않은 임시저장 상태)
• ok: 등록
• hide: 비공개

Options: save, ok, hide

publishTypestring · enumrequired

소식의 게시 유형

• publish: 즉시게시
• reservation: 예약 - 지정한 일자에 소식목록에 표시되도록 예약된 소식
• internet: 숨김게시 - 소식목록에 표시되지 않지만 URL을 통해 접근 가능한 소식

Options: publish, reservation, internet

publishDatestring

게시 일자. publishType이 reservation 인 경우 반드시 지정(형식 - YYYYMMDDhhmmss)

pinYnstring · default: Nrequired

소식 메인 상단 고정여부. 이미 고정된 소식 존재하는 경우 신규 지정 건으로 대체됨

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api-qa.rcsbizcenter.com/bfapi/1.0/brand/{brandId}/feed' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "text",
    "description": "text",
    "type": "gallery",
    "share": {
      "snsLink": "text",
      "title": "text",
      "description": "text",
      "imageUrl": "text"
    },
    "media": [],
    "buttons": [],
    "status": "save",
    "publishType": "publish",
    "publishDate": "text",
    "pinYn": "N"
  }'

❖ request body sample

gallery 유형

{
  "title": "gallery feed title",
  "description": "gallery feed discription",
  "type": "gallery",
  "media": [
    {
      "orderNo": 1,
      "fileId": "BR.61hBmMP164-FDcoZeqOY0W7"
    },
    {
      "orderNo": 2,
      "fileId": "BR.61hBmMP164-FDcoZeqOY0W7"
    }
  ],
  "buttons": [
    {
      "title": "전화걸기",
      "type": "call",
      "orderNo": 1,
      "link": "15884741"
    },
    {
      "title": "앱 다운로드",    
      "type": "app",
      "orderNo": 2,
      "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"
      }
    }
  ],
  "status": "save",
  "publishType": "publish",
  "publishDate": "201210181411",
  "pinYn": "N"
}

share 유형

{
  "title": "share feed title",
  "description": "share feed discription",
  "type": "share",
  "share": {
      "snsLink": "https://www.youtube.com/watch?v=S3Ali_M8tE8",
      "title" : "SNL 코리아 레전드 모음",
      "description" : "",
      "imageUri" : "https://biz-dev.chatplus.co.kr/brand/BR.61hBmMP164/feed/20240704/BR.61hBmMP164-FDcoZeqOY0W7.jpg"
  },
  "buttons": [
    {
      "title": "전화걸기",
      "type": "call",
      "orderNo": 1,
      "name": "전화걸기",
      "link": "15884741"
    },
    {
      "title": "앱 다운로드",
      "type": "app",
      "orderNo": 2,
      "name": "앱 다운로드",
      "appLink": {
        "packageName": "com.android.mobile.cs",
        "action": "android.intent.action.VIEW",
        "uri": "abc://gizmos/foo/bar",
        "scheme": "intent://byunhost#Intent;scheme=byunscheme;action=android.intent.action.VIEW;category=android.intent.category.BROWSABLE;package=com.example.myapplication;end"
      }
    }
  ],
  "status": "save",
  "publishType": "publish",
  "publishDate": "201210181411",
  "pinYn": "N"
}

Response

필드명	타입	길이	필수여부	기본값	설명
result	array<object>		O		피드ID
code	string	5	O	20000000	리턴코드값
status	integer	3	O	200	상태값
desc	string		O		처리메시지

result - array<object>

필드명	타입	길이	필수여부	기본값	설명
feedId	string		O		피드ID

❖ response body sample

200

{
    "code": "20000000",
    "desc": null,
    "result": {
        "feedId": "BR.i3gC1762pT.QgrKlJz3Va"
    },
    "status": 200
}

400

{
    "error": {
        "code": "64701",
        "message": "parameter required [buttons[title]]"
    },
    "status": 400
}

{
    "error": {
        "code": "64702",
        "message": "parameter invalid [share[snsLink]]"
    },
    "status": 400
}

401

{
  "status": "401",
  "error": {
    "code": "61001",
    "message": "Missing Authorization header"
  }
}

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

{
    "error": {
        "code": "64713",
        "message": "No File Permission [BR.Q63creSjku-FDRwSMvksa5P]"
    },
    "status": 401
}

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