자동응답 메시지 등록

Request

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

post

https://api-qa.rcsbizcenter.com/api/1.1https://api.rcsbizcenter.com/api/1.1

/brand/{brandId}/autoreplymsg

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

• 계정 권한: 마스터, 매니저, 대행사

• 브랜드 권한: 브랜드 대표운영자, 운영자

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

• 전화걸기

• 웹사이트(내부브라우져)

• 웹사이트(외부브라우져)

• 대화방연결(메시지작성)

• 캘린더(일정)

• 지도(좌표)

• 지도(키워드)

• 지도(현재위치)

• <신규>자동응답메시지연결

• <신규>챗봇연결

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

• 기본 말풍선(SCS00000), 텍스트 카드(SCL00000)는 기본 말풍선(SCS00000)으로 처리

• 세로형_Meduim(SCwThM00), 세로형_Tall(SCwThT00)은 세로형_Meduim(SCwThM00)으로 처리

• 슬라이드형_Medium, 슬라이드형_Small은 슬라이드형_Medium으로 처리

  • 슬라이드형 Medium ID: CCwMhM0200 ~ CCwMhM0600

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

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

Authorizations

jwtAuth

AuthorizationstringRequired

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

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

application/json

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

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이 적용되지 않습니다.

copyAllowedbooleanOptional

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

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

Default: true

bodyobjectRequired

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

Responses

200

페이지 내 Response 섹션 참조

No content

post

/brand/{brandId}/autoreplymsg

HTTPcURLJavaScriptPython

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

{
  "autoReplyMsgName": "text",
  "messagebaseId": "text",
  "copyAllowed": true,
  "body": {},
  "buttons": [
    {
      "suggestions": [
        {
          "action": {
            "displayText": "text",
            "postback": {
              "data": "text"
            },
            "urlAction": {
              "openUrl": {
                "url": "https://example.com"
              }
            }
          }
        }
      ]
    }
  ],
  "chipList": [
    {
      "action": {
        "displayText": "text",
        "postback": {
          "data": "text"
        },
        "urlAction": {
          "openUrl": {
            "url": "https://example.com"
          }
        }
      }
    }
  ]
}

200

페이지 내 Response 섹션 참조

No content

Response

말풍선

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

카드

슬라이드

Response

필드명	타입	길이	필수여부	기본값	설명
result	array<object>		O		자동응답메시지 ID
code	string	5	O	20000000
status	integer	3	O	200
desc	string		O

result - array<object>

필드명	타입	길이	필수여부	기본값	설명
result	array<object>				자동응답메시지 ID

❖ response body sample

200

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

400

401

403

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