양방향 중계사_webhookUri

Request

양방향 서비스 제공 중계사에서 구현해야 하는 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

HTTPcURLJavaScriptPython

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

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

error - object

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

❖ response body sample

200

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

400

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

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