1 of 3

양방향 중계사

이 문서는 중계사가 양방향 대화방의 대화 메뉴에 대한 API 정보를 안내합니다.

양방향 대화방 사용 중지 재개

Request

❖ request body sample

  "isPause": true
}

Response

필드명

타입

길이

필수여부

기본값

설명

array<object>

대화방메뉴 사용을 중지여부

code

string

20000000

status

integer

200

desc

string

result - array<object>

필드명

타입

길이

필수여부

기본값

설명

chatbotId

string

대화방ID

isPause

boolean

중지여부

pausedDate

integer

isPause true 인 경우, 중지일시

resumeDate

string

isPause false인 경우, 재개일시

❖ response body sample

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

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

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

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

양방향 중계사_webhookUri

Request

❖ request body sample

{
    "notiType": "appointment",
    "value": {
        "agencyCorpRegNum": "1148196221"
    }
}

{
    "notiType": "registration",
    "value": {
        "agencyId": "noagency",
        "brandId": "BR.Q63creSjku",
        "brandKey": "BK.SD8X63r9uJaApN9",
        "chatbotId": "bd_chatbot_v1",
        "corpRegNum": "1148196221"
    }
}

{
    "notiType": "subscription",
    "value": {
        "agencyId": "noagency",
        "brandId": "BR.Q63creSjku",
        "brandKey": "BK.SD8X63r9uJaApN9",
        "chatbotId": "bd_chatbot_v1",
        "corpRegNum": "1148196221"
    }
}

{
    "notiType": "persistentmenu",
    "value": {
        "agencyId": "noagency",
        "brandId": "BR.Q63creSjku",
        "brandKey": "BK.SD8X63r9uJaApN9",
        "chatbotId": "bd_chatbot_v1",
        "corpRegNum": "1148196221"
    }
}

Response

필드명

타입

길이

필수여부

기본값

설명

status

string

200 : 성공적으로 알림을 수신하였을 경우 응답합니다. 400 : 대행사 측 청약이 우선 처리되지 않은 상태에서 'contract'가 전달된 경우 필히 응답되어야 합니다.

error

object

error - object

필드명

타입

길이

필수여부

기본값

설명

code

string

message

string

❖ response body sample

{
  "status": "200",
  "error": {
    "code": "",
    "message": ""
  }
}

{
  "status": "400",
  "error": {
    "code": "69999",
    "message": "No Subscription"
  }
}

양방향 중계사_webhookUri

Request

❖ request body sample

{
    "notiType": "appointment",
    "value": {
        "agencyCorpRegNum": "1148196221"
    }
}

{
    "notiType": "registration",
    "value": {
        "agencyId": "noagency",
        "brandId": "BR.Q63creSjku",
        "brandKey": "BK.SD8X63r9uJaApN9",
        "chatbotId": "bd_chatbot_v1",
        "corpRegNum": "1148196221"
    }
}

{
    "notiType": "subscription",
    "value": {
        "agencyId": "noagency",
        "brandId": "BR.Q63creSjku",
        "brandKey": "BK.SD8X63r9uJaApN9",
        "chatbotId": "bd_chatbot_v1",
        "corpRegNum": "1148196221"
    }
}

{
    "notiType": "persistentmenu",
    "value": {
        "agencyId": "noagency",
        "brandId": "BR.Q63creSjku",
        "brandKey": "BK.SD8X63r9uJaApN9",
        "chatbotId": "bd_chatbot_v1",
        "corpRegNum": "1148196221"
    }
}

Response

필드명

타입

길이

필수여부

기본값

설명

status

string

error

object

error - object

필드명

타입

길이

필수여부

기본값

설명

code

string

message

string

❖ response body sample

{
  "status": "200",
  "error": {
    "code": "",
    "message": ""
  }
}

{
  "status": "400",
  "error": {
    "code": "69999",
    "message": "No Subscription"
  }
}

error code는 참조

양방향 대화방 사용 중지 재개

Request

❖ request body sample

  "isPause": true
}

Response

필드명

타입

길이

필수여부

기본값

설명

array<object>

대화방메뉴 사용을 중지여부

code

string

20000000

status

integer

200

desc

string

result - array<object>

필드명

타입

길이

필수여부

기본값

설명

chatbotId

string

대화방ID

isPause

boolean

중지여부

pausedDate

integer

isPause true 인 경우, 중지일시

resumeDate

string

isPause false인 경우, 재개일시

❖ response body sample

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

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

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

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

error code는 참조

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

put

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

Authorizations

Path parameters

brandIdstring · max: 13Required

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

chatbotIdstringRequired

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

Header parameters

X-RCS-Brandkeystring · max: 18Optional

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

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

Body

isPausebooleanOptional

대화방메뉴 중지 여부

Default: true

put

PUT /api/1.1/brand/{brandId}/bidirectional/chatbot/{chatbotId}/persistentmenu/pause HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "isPause": true
}

양방향 서비스 제공 중계사에서 구현해야 하는 Webhook URI 입니다.

post

양방향 서비스 제공 중계사에서 구현해야 하는 Webhook URI 입니다.

RBC 대행사 정보의 수신서버 URL하위에 bidirctional 경로를 구현 제공해야 합니다.

양방향 서비스 제공 중계사는 RBC에 등록되는 대행사의 양방향 메시지 중계사 지정, 양방향 대화방 등록, 대화방 메뉴 사용 시 청약 여부와 같이 양방향 서비스 제공을 위해 필수 정보 연동이 필요합니다.

Authorizations

Path parameters

webhookUrlstringRequired

RBC에 등록된 대행사 계정 정보 상에 대행사가 직접 등록한 수신서버(Webhook) URL 정보입니다.

Body

notiTypestring · enumRequired

appointment: 일반 대행사가 양방향 서비스 중계사 지정 알림
registration: 양방향 대화방 등록 알림
subscription: 대화방메뉴 사용 청약 확인 요청
persistentmenu: 대화방메뉴 등록 알림

Possible values:

post

POST /{webhookUrl}/bidirectional HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "notiType": "appointment",
  "value": {
    "agencyCorpRegNum": "text",
    "agencyId": "text",
    "brandId": "text",
    "brandKey": "text",
    "chatbotId": "text",
    "corpRegNum": "text"
  }
}