대화방 메뉴 사용 차단

Request

중계사만 사용이 가능하며, 양방향 대화방의 대화방메뉴 사용을 중지 또는 재개합니다.

양방향 대화방에 대화방메뉴 사용을 중지 또는 재개합니다.
양방향 대화방에 등록된 중계사만 사용이 가능합니다.
과금 미납 발생 등 특이사항이 발생한 경우 사용하며 대화방메뉴 중지에 대한 정보가 사용자에게 RBC 홈페이지에서 표시됩니다.

put

/brand/{brandId}/bidirectional/chatbot/{chatbotId}/persistentmenu/pause

Authorizations

Path parameters

brandIdstring · max: 13required

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

chatbotIdstringrequired

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

Header parameters

X-RCS-Brandkeystring · max: 18

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

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

Body

isPauseboolean · default: true

대화방메뉴 중지 여부

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api-qa.rcsbizcenter.com/api/1.1/brand/{brandId}/bidirectional/chatbot/{chatbotId}/persistentmenu/pause' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "isPause": true
  }'

❖ request body sample

대화방메뉴 중지 여부

  "isPause": true
}

Response

필드명	타입	길이	필수여부	기본값	설명
result	array<object>		O		대화방메뉴 사용을 중지여부
code	string	5	O	20000000
status	integer	3	O	200
desc	string		O

result - array<object>

필드명	타입	길이	필수여부	기본값	설명
chatbotId	string				대화방ID
isPause	boolean				중지여부
pausedDate	integer				isPause true 인 경우, 중지일시
resumeDate	string				isPause false인 경우, 재개일시

❖ response body sample

200

{
    "code": "20000000",
    "desc": null
    "result": [
        {
            "chatbotId": "bot-aljr02btgnh",
            "isPause": true,
            "pausedDate": "2024-06-13T00:27:38.648Z",
            "resumeDate": "2024-06-13T00:27:38.648Z"
        }
    ],
    "status": 200
}

400

{
    "error": {
        "code": "64002",
        "message": "Invalid Brand Key"
    },
    "status": 400
}

{
    "error": {
        "code": "64360",
        "message": "chatbot is not bidirectional(twoway)"
    },
    "status": 400
}

{
    "error": {
        "code": "64385",
        "message": "This Menu dose not regist"
    },
    "status": 400
}

401

{
    "error": {
        "code": "61003",
        "message": "Invalid token"
    },
    "status": 401
}

403

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

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