브랜드 소식 등록

Request

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

post

/brand/{brandId}/feed

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

브랜드 소식에 등록 가능한 소식 유형에는 Gallery, Share 2가지 유형이 있습니다. 추후 Slide 유형을 추가로 제공할 예정입니다.

Gallery 유형 소식 등록 시 포함되는 이미지는 파일 업로드 API를 이용하여 사전 등록해야 합니다.

이미지 파일 등록 시 발급되는 ID를 이용하여야 소식에 이미지를 표시할 수 있습니다.

Authorizations

AuthorizationstringRequired

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

Path parameters

brandIdstringRequired

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

Header parameters

X-RCS-BrandkeystringOptional

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

Body

브랜드 소식 등록 정보 객체입니다.

브랜드 소식 등록 시 gallery, share 유형 또는 두 가지 모두 사용 가능한 slide 유형 중 하나을 지정할 수 있습니다.

각각의 유형은 buttons를 이용하여 소식 내 버튼을 지정할 수 있습니다.

titlestringRequired

maxLength: 40 - 브랜드 소식 제목

descriptionstringRequired

maxLength: 2000 - 브랜드 소식 내용

typestring · enumRequired

브랜드 소식 카드 유형

Possible values:

statusstring · enumRequired

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

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

Possible values:

publishTypestring · enumRequired

소식의 게시 유형

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

Possible values:

publishDatestringOptional

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

pinYnstringRequired

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

Default: N

Responses

200

페이지 내 Response 섹션 참조

No content

post

/brand/{brandId}/feed

POST /bfapi/1.0/brand/{brandId}/feed HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 232

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

200

페이지 내 Response 섹션 참조

No content

❖ request body sample

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

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

피드ID

code

string

20000000

리턴코드값

status

integer

200

상태값

desc

string

처리메시지

result - array<object>

필드명

타입

길이

필수여부

기본값

설명

feedId

string

피드ID

❖ response body sample

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

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

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

{
  "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 참조

Previous브랜드 소식 상세 조회 Next브랜드 소식 수정

Last updated 5 months ago

Was this helpful?