템플릿 등록_V2

Request

브랜드 내에서 사용할 템플릿을 등록합니다. 모든 템플릿 등록이 가능합니다.

post

브랜드 내에서 사용할 템플릿을 등록합니다.

모든 템플릿 등록이 가능하며, 템플릿 등록 시 사용되는 messagebaseformId의 params의 각 항목 중 템플릿에 표시될 내용을 입력하여 원하는 템플릿을 등록할 수 있습니다.

등록된 템플릿은 RCS Biz Center 운영자의 승인이 필요합니다.

  • 계정 권한: 마스터, 매니저, 대행사
  • 브랜드 권한: 브랜드 대표운영자, 운영자
  • 지원 범위: 텍스트 템플릿(타이틀 선택형 / 타이틀 자유형), 이미지 템플릿, LMS 템플릿
Authorizations
Path parameters
brandIdstring · max: 13Required

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

Header parameters
X-RCS-Brandkeystring · max: 18Optional

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

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

Body

템플릿 등록 시 사용되는 Object 입니다.

brandIdstring · max: 13Required

maxLength: 13 - 브랜드ID

messagebaseformIdstring · max: 10Required

maxLength: 10 - 템플릿 양식 ID

custTmpltIdstring · max: 25Required

maxLength: 25 - 사용자 지정 템플릿ID로 영문/숫자 25자 이내만 가능

tmpltNamestring · max: 40Required

maxLength: 40 - 템플릿명

agencyIdstring · max: 20Optional

maxLength: 20 - 대행사ID

post
POST /api/1.1/brand/{brandId}/v2/messagebase HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 388

{
  "brandId": "text",
  "messagebaseformId": "text",
  "custTmpltId": "text",
  "tmpltName": "text",
  "agencyId": "text",
  "body": [
    {
      "param": "text",
      "value": "text",
      "decoration": {
        "textSize": "text",
        "textAlignment": "textStart",
        "textStyle": "bold",
        "textColor": "text"
      }
    }
  ],
  "buttons": [
    {
      "suggestions": [
        {
          "action": {
            "displayText": "text",
            "postback": {
              "data": "text"
            },
            "urlAction": {
              "openUrl": {
                "url": "https://example.com"
              }
            }
          }
        }
      ]
    }
  ]
}

❖ request body sample

{
  "brandId": "BR.u720xwadx0",
  "custTmpltId": "test2024062105",
  "messagebaseformId": "TATA001C",
  "tmpltName": "타이틀자유형-스타일",
  "agencyId": "",
  "body": [
    {
      "param": "title1",
      "value": "제목",
      "decoration": {
        "textStyle": "bold",
        "textSize": "18dp",
        "textAlignment": "textStart",
        "textColor": "#232329"
      }
    },
    {
        "param": "title2",
        "value": "{{2}}",
        "decoration": {
            "textStyle": "bold",
            "textSize": "18dp",
            "textAlignment": "textStart",
            "textColor": "#232329"
        }
    },
    {
      "param": "cell1",
      "value": "{{1}}"
    },
    {
      "param": "cell2",
      "value": "{{2}}"
    },
    {
      "param": "cell3",
      "value": "{{3}}"
    },
    {
      "param": "cell4",
      "value": "{{4}}"
    },      
    {
      "lineIndex": 2
    }
  ],
  "buttons": [
    {
      "suggestions": [
        {
          "action": {
            "dialerAction": {
              "dialPhoneNumber": {
                "phoneNumber": "1522{{지점번호}}"
              }
            },
            "displayText": "고객센터",
            "postback": {
              "data": "set_by_chatbot_dial_phone_number"
            }
          }
        },
        {}
      ]
    }
  ]
}

Response

필드명
타입
길이
필수여부
기본값
설명

array<object>

O

등록된 템플릿ID(= messagebaseId)

code

string

5

O

20000000

status

integer

3

O

200

desc

string

O

result - array<object>

필드명
타입
길이
필수여부
기본값
설명

messagebaseId

string

O

등록된 템플릿ID(= messagebaseId)

❖ response body sample

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "messagebaseId": "UBR.u720xwadx0-test202406182"
        }
    ],
    "status": 200
}

Last updated