3.1개요

청약 홈페이지와 연동을 위한 API 정의 이다.
API는 http/https 프로토콜을 사용하며, GET, POST, DELETE method를 사용합니다.
request , response는 JSON String 형태로 전달됩니다.

3.1.1설명

청약 홈페이지에서 청약 신청, 변경, 해지 시 사용하는 API 이다

3.1.2지원 목록

청약 신청
청약 변경
청약 해지

3.1.3선결 과제

접속을 위해서는 접속하는 곳의 IP가 청약 API 서버에 등록되어 있어야 한다.

3.2API

host : https://xbiztalk.nexuscommunity.kr/adaptor/

3.2.1청약 신청(마스터 정보)

3.2.1.1청약 신청(마스터)

청약 정보를 전송한다. (알림톡 및 AI 정보는 청약 신청(상담톡,알림톡) , 청약 신청(AI) API 를 참고한다)
청약 완료시 callback URL 로 상담사 정보와 임시 패스워드가 발급된다.

청약 완료시 받을 URL 이 반드시 등록이 되어야 한다.

PUT /job/nexus

[Header]

Authorization: Bearer 토큰

[Parameter]

키			타입	필수	설명
activateId			text	Y	uuid 값 ex) "activateId": "976ff276-f72b-1116-test-1000001"
service			text	Y	서비스 (고정값 : nexus-csapp) ex) "service": "nexus-csapp"
transaction			text	Y	트랜잭션 구분 (고정값 : t_create_csapp) ex) "transaction": "t_create_csapp"
prevSteps			array		step 배열
	service		text	Y	서비스 구분 (고정값 : hbe) ex) "service": "hbe"
	report		object		청약 정보 객체
		bot	object	Y	봇 정보 (아래 bot 객체 참고)
		csapp	object	Y	상담 정보 (아래 csapp 객체 참고)
		ivr	object	Y	IVR 정보 (아래 ivr 객체 참고)
		plan	object	Y	요금제 정보 (아래 plan 객체 참고)
		tenant	object	Y	테넌트 정보 (아래 tenant 객체 참고)
jobRespAddr			text	Y	응답받을 URL "jobRespAddr": "http://127.0.0.1:8080/report/nexus"

bot 객체 정의

키	타입	필수	설명
callbackQty	int	Y	콜백 개수
qty	int	Y	봇 개수

csapp 객체 정의

키				타입	필수	설명
category				array	Y	상담분류 대
	name			text	Y	상담분류명
	category			array	Y	상담분류 중
		name		text	Y	상담분류명
		category		array	Y	상담분류 소
			name	text	Y	상담분류명
hardwarePhone				bool	Y	하드웨어전화기 사용(기본 : false) ex) "hardwarePhone": false
skillName				array	Y	문의 유형 배열 ex) "skillName": [ "배송 문의", "환불 문의", "취소 문의", "반품 문의", "교환 문의", "대량구매 문의", "세금 문의", "홈페이지 문의", "사업장 문의" ]
user				array	Y	상담원/관리자 접속 정보
	id			text	Y	상담원 아이디
	name			text	Y	상담원 이름
	roleCd			array	Y	권한 배열 ex) "roleCd": [ "agent", "admin" ]
	skillName			array	Y	상담원 스킬 정보 ex) "skillName": [ "배송 문의", "환불 문의" ]

ivr 객체 정의

키		타입	필수	설명
announcement		text	Y	IVR 정보 멘트
breakMent		text	Y	휴식시간 멘트
endMent		text	Y	종료멘트
firstId		text	Y	초기 연결 설정( bot or agent ) bot: 콜봇 연결, agent : 상담사 연결 ex) "firstId": "bot"
holidayMent		text	Y	휴일 멘트
numbering		array	Y/N	넘버링 플랜 정보
	announcement	text	Y	IVR 정보 멘트
	digit	text	Y	DTMF 키
	skillName	text	Y	스킬명
useMenu		bool	Y	사용여부 ex) "useMenu": true
welcomeMent		text	Y	인사멘트

plan 객체 정의

키	타입	필수	설명
agentEndMsg	bool	Y	상담종료 메시지 사용
bot	bool	Y	봇 사용
botEndMsg	bool	Y	봇 종료 멘트 사용
callback	bool	Y	콜백 사용
callbackMsg	bool	Y	콜백 문자 사용
chatting	bool	Y	상담톡 사용
chattingMsg	bool	Y	알림톡 사용
csapp	text	Y	상품 요금제 (BASIC, PREMIUM) ex) "csapp": "PREMIUM",
recordPeriod	text	Y	녹취기간 ex) "recordPeriod": "6M"
type	text	Y	고정값 ex) "type": "ALLINONE"

tenant 객체 정의

키		타입	필수	설명
name				테넌트 명
alias		text	Y	테넌트 별칭, 유니크
businessSch		array	Y	근무시간 정보
	breakStart	text	Y	휴식 시작
	breakEnd	text	Y	휴식 종료
	openTime	text	Y	근무 시작
	closeTime	text	Y	근무 종료
	days	array[int]	Y	근무 요일 (0:일,1:월,2:화,3:수,4:목,5:금,6:토) ex) "days": [ 1, 2, 3, 4, 5 ],
inPn		text	Y	대표번호(인바운드)
outPn		text	Y	발신번호(아웃바운드)
legalHoliday		bool	Y	법정공휴일 사용, (true, false)
startDate		text	Y	청약 시작일

[SAMPLE]

curl -v  -H "Accept: application/json" -H "Content-type: application/json" \
-X PUT -d @homepage_report.json \
  http://127.0.0.1:8450/job/nexus

homepage_report.json

{
  "activateId": "976ff276-f72b-1116-test-1000001",
  "service": "nexus-csapp",
  "transaction": "t_create_csapp",
  "prevSteps": 

[
  {
    "service": "hbe",
    "report": {
      "activateId": "976ff276-f72b-1112-84f8-ab33049d0fe4",
      "bot": {
        "callbackQty": 15,
        "qty": 29
      },
      "csapp": {
        "category": [
          {
            "category": [
              {
                "category": [
                  {
                    "name": "직장인 신용 대출"
                  },
                  {
                    "name": "전문직 신용 대출"
                  }
                ],
                "name": "신용 대출"
              },
              {
                "category": [
                  {
                    "name": "예적금 담보 대출"
                  }
                ],
                "name": "담보 대출"
              }
            ],
            "name": "대출"
          }
        ],
        "hardwarePhone": false,
        "skillName": [
          "배송 문의",
          "환불 문의",
          "취소 문의",
          "반품 문의",
          "교환 문의",
          "대량구매 문의",
          "세금 문의",
          "홈페이지 문의",
          "사업장 문의"
        ],
        "user": [
          {
            "id": "CCaaS_admin_01",
            "name": null,
            "roleCd": [
              "agent",
              "admin"
            ],
            "skillName": [
              "배송 문의",
              "환불 문의"
            ]
          },
          {
            "id": "CCaaS_admin_02",
            "name": null,
            "roleCd": [
              "agent",
              "admin"
            ],
            "skillName": [
              "교환 문의",
              "세금 문의"
            ]
          },
          {
            "id": "CCaaS_admin_03",
            "name": null,
            "roleCd": [
              "agent",
              "admin"
            ],
            "skillName": [
              "배송 문의",
              "환불 문의"
            ]
          },
          {
            "id": "CCaaS_admin_04",
            "name": null,
            "roleCd": [
              "agent",
              "admin"
            ],
            "skillName": [
              "배송 문의",
              "환불 문의"
            ]
          }
        ]
      },
      "ivr": {
        "announcement": "배송 문의 1번, 환불 문의 2번, 취소 문의 3번, 반품 문의 4번, 교환 문의 5번, 대량구매 문의 6번, 세금 문의 7번, 홈페이지 문의 8번, 사업장 문의 9번, 다시 듣기는 *표를 눌러주세요.",
        "breakMent": "11시 30분부터 13시 00분까지는 점심시간입니다.",
        "endMent": "지금은 고객센터 운영시간이 아닙니다. 운영시간은 월화수목금 09시 00분부터 19시 00분 , 일토 09시 00분부터 11시 30분 까지 입니다.",
        "firstId": "bot",
        "holidayMent": "오늘은 고객센터 영업일이 아닙니다. 영업일은 공휴일 제외 일,월,화,수,목,금,토요일입니다.",
        "numbering": [
          {
            "announcement": "배송 문의",
            "digit": "1",
            "skillName": "배송 문의"
          },
          {
            "announcement": "환불 문의",
            "digit": "2",
            "skillName": "환불 문의"
          },
          {
            "announcement": "취소 문의",
            "digit": "3",
            "skillName": "취소 문의"
          },
          {
            "announcement": "반품 문의",
            "digit": "4",
            "skillName": "반품 문의"
          },
          {
            "announcement": "교환 문의",
            "digit": "5",
            "skillName": "교환 문의"
          },
          {
            "announcement": "대량구매 문의",
            "digit": "6",
            "skillName": "대량구매 문의"
          },
          {
            "announcement": "세금 문의",
            "digit": "7",
            "skillName": "세금 문의"
          },
          {
            "announcement": "홈페이지 문의",
            "digit": "8",
            "skillName": "홈페이지 문의"
          },
          {
            "announcement": "사업장 문의",
            "digit": "9",
            "skillName": "사업장 문의"
          },
          {
            "announcement": "다시 듣기",
            "digit": "#",
            "skillName": ""
          }
        ],
        "useMenu": true,
        "welcomeMent": "안녕하십니까. 반갑습니다. 어서 오세요."
      },
      "plan": {
        "agentEndMsg": true,
        "bot": true,
        "botEndMsg": true,
        "callback": true,
        "callbackMsg": true,
        "chatting": true,
        "chattingMsg": true,
        "csapp": "PREMIUM",
        "recordPeriod": "1Y",
        "type": "ALLINONE"
      },
      "tenant": {
        "alias": "test1",
        "businessSch": [
          {
            "breakEnd": "1300",
            "breakStart": "1130",
            "closeTime": "1900",
            "days": [
              1,
              2,
              3,
              4,
              5
            ],
            "openTime": "0900"
          },
          {
            "breakEnd": "1300",
            "breakStart": "1130",
            "closeTime": "1130",
            "days": [
              0,
              6
            ],
            "openTime": "0900"
          }
        ],
        "inPn": "0316001031",
        "legalHoliday": true,
        "name": "테스트11",
        "outPn": "0316001031",
        "startDate": "20230726",
        "testPn": "07079157060"
      }
    }
  }
]


,
  "jobRespAddr": "http://xportal.neuxcommunity.kr:8450/report/nexus"
}

* 응답

[Response]

* 응답(성공)

HTTP/1.1 200 OK

* 응답(실패)

HTTP/1.1 401 Unauthorized

3.2.1.2청약 요청 응답

PUT /report/nexus

[Header]

Authorization: Bearer 토큰

[Parameter]

키		타입	필수	설명
activateId		text	Y	청약신청 activateId
report		object	Y	report 객체

report 객체 정의

키		타입	필수	설명
activateId		text	Y	요청받은 activateId 값
user		array	Y	사용자 임시 비번 배열
	id	text	Y	상담원 ID
	pasword	text	Y	상담원 비번

[SAMPLE]

curl -X PUT -H "Content-type: application/json" \
-d \
'{"tlogId":"976ff276-f72b-1112-84f8-ab33049d0fe4","report":{"activateId":"976ff276-f72b-1112-84f8-ab33049d0fe4","user":[{"id":"CCaaS_admin_01","password":"1",},{"id":"CCaaS_admin_02","password":"1",}]}}' \
http://xportal.neuxcommunity.kr:8450/report/nexus

* 응답

[Response]

* 응답(성공)

HTTP/1.1 200 OK

* 응답(실패)

HTTP/1.1 404 Not Found

3.2.1.3청약 신청(상담톡,알림톡)

청약 정보 마스터가 완료된후 상당톡, 알림톡 정보를 전달 한다.
상담톡,알림톡 미사용일 경우는 정보를 전달 하지 않는다.

청약 완료시 받을 URL 이 반드시 등록이 되어야 한다.

PUT /job/nexus/alimtalk

[Header]

Authorization: Bearer 토큰

[Parameter]

키			타입	필수	설명
activateId			text	Y	uuid 값 ex) "activateId": "976ff276-f72b-1116-test-1000001"
service			text	Y	서비스 (고정값 : nexus-csapp) ex) "service": "nexus-csapp"
transaction			text	Y	트랜잭션 구분 (고정값 : t_create_notitalk) ex) "transaction": "t_create_notitalk"
prevSteps			array		step 배열
	service		text	Y	서비스 구분 (고정값 : hbe) ex) "service": "hbe"
	report		object		청약 정보 객체
		senderKey	string	Y/N	알림톡 발신프로필키(사용할 경우만)
		senderKey2	string	Y/N	상담톡 발신프로필키(사용할 경우만)
		bot	bool	N	상담톡 봇 사용여부(true/false)
		outPn	string	Y/N	SMS 발신번호
		templetes	object	Y	템플릿 정보 (아래 templetes 객체 참고)
		tenant	object	Y	테넌트 정보 (아래 tenant 객체 참고)
jobRespAddr			text	Y	응답받을 URL "jobRespAddr": "http://127.0.0.1:8450/report/nexus/alimtalk"

templetes 객체 정의

키	타입	필수	설명
fallback	bool	Y	대체 발송 여부 ex) "fallback": false
fallbackMessage	text	Y	대체 발송 메시지 ex) "fallbackMessage": "상담이 종료되었습니다. 궁금하신 사항이 있으시면 언제든지 다시 연락해주세요. 감사합니다. ▶ 고객센터 - 운영시간 : 09:00~18:00 (주말, 공휴일 휴무) = 점심시간 : 12:00~13:00- ☎ 1000"
fallbackTitle			대체 발송 타이틀 ex) "fallbackTitle": "상담 종료 안내"
fallbackType			대체발송 타입(LMS, SMS) ex) "fallbackType": "LMS",
templateCd			템플릿 코드 ex) "templateCd": "nexus_call_end_01"
templateContents			템플릿 내용 ex) "templateContents": "상담이 종료되었습니다. 궁금하신 사항이 있으시면 언제든지 다시 연락해주세요. 감사합니다. ▶ 고객센터 - 운영시간 : 09:00~18:00 (주말, 공휴일 휴무) = 점심시간 : 12:00~13:00- ☎ 1000"
templateType			테블릿 타입 ( CALL_END, CHAT_END ) ex) "templateType": "CALL_END"

tenant 객체 정의

키		타입	필수	설명
alias		text	Y	테넌트 별칭, 유니크 ex) "alias": "nexus"

키

타입

필수

설명

alias

text

테넌트 별칭, 유니크

ex) "alias": "nexus"

[SAMPLE]

curl -v  -H "Accept: application/json" -H "Content-type: application/json" \
-X PUT -d @homepage_report_alimtalk.json \
  http://127.0.0.1:8450/job/nexus/alimtalk

homepage_report_alimtalk.json

{
  "activateId": "976ff276-f72b-1116-test-1000001",
  "service": "nexus-csapp",
  "transaction": "t_create_notitalk",
  "prevSteps": 

[
  {
    "service": "hbe",
    "report": {
      "outPn": "01072350880",
      "senderKey": "4e791157a9f604e7180650c155acbcc7ea118705",
      "senderKey2": "4e791157a9f604e7180650c155acbcc7ea118705",
      "bot": true,
      "templetes": [
        {
          "fallback": false,
          "fallbackMessage": "상담이 종료되었습니다. \n궁금하신 사항이 있으시면 언제든지 다시 연락해주세요.\n감사합니다.\n▶ 고객센터\n- 운영시간 : 09:00~18:00 (주말, 공휴일 휴무)\n- 점심시간 : 12:00~13:00\n- ☎ 1000",
          "fallbackTitle": "상담 종료 안내",
          "fallbackType": "",
          "templateCd": "agent_ndy1yzu2ntzidca",
          "templateContents": "상담이 종료되었습니다. \n궁금하신 사항이 있으시면 언제든지 다시 연락해주세요.\n감사합니다.\n▶ 고객센터\n• 운영시간 : 09:00~18:00 (주말, 공휴일 휴무)\n• 점심시간 : 12:00~13:00\n• ☎️ 1000",
          "templateType": "CALL_END"
        }
      ],
      "tenant": {
        "alias": "test5"
      }
    }
  }
]

,
  "jobRespAddr": "http://xportal.neuxcommunity.kr:8450/report/nexus/alimtalk"
}

* 응답

[Response]

* 응답(성공)

HTTP/1.1 200 OK

* 응답(실패)

HTTP/1.1 401 Unauthorized

3.2.1.4청약 요청 응답

PUT /report/nexus/alimtalk

[Header]

Authorization: Bearer 토큰

[Parameter]

키		타입	필수	설명
activateId		text	Y	요청받은 activateId 값

[SAMPLE]

curl -X PUT -H "Content-type: application/json" \
-d \
'"activateId":"976ff276-f72b-1112-84f8-alimtalk"' \
http://xportal.neuxcommunity.kr:8450/report/nexus/alimtalk

* 응답

[Response]

* 응답(성공)

HTTP/1.1 200 OK

* 응답(실패)

HTTP/1.1 404 Not Found

3.2.1.5청약 신청(AI 교육, AI 면접)

청약 정보 마스터가 완료된후 AI 교육, AI 면접 정보를 전달 한다.
AI 교육, AI 면접 미사용일 경우는 정보를 전달 하지 않는다.

청약 완료시 받을 URL 이 반드시 등록이 되어야 한다.

PUT /job/nexus/ai

[Header]

Authorization: Bearer 토큰

[Parameter]

키			타입	필수	설명
activateId			text	Y	uuid 값 ex) "activateId": "976ff276-f72b-1116-test-1000001"
service			text	Y	서비스 (고정값 : nexus-csapp) ex) "service": "nexus-csapp"
transaction			text	Y	트랜잭션 구분 (고정값 : t_create_ai) ex) "transaction": "t_create_ai"
prevSteps			array		step 배열
	service		text	Y	서비스 구분 (고정값 : hbe) ex) "service": "hbe"
	report		object		청약 정보 객체
		aiInterview	object	Y	AI 면접 객체
		aiTraining	object	Y	AI 교육 객체
		tenant	object	Y	테넌트 정보 (아래 tenant 객체 참고)
jobRespAddr			text	Y	응답받을 URL "jobRespAddr": "http://127.0.0.1:8450/report/nexus/ai"

aiInterview 객체 정의

키	타입	필수	설명
use	bool	Y	사용여부 (true, false)
startDate	text	Y/N	청약 시작일 ex) "startDate": "20230726"
plan	text	Y	plan 정보(건수정보 10, 50, 100) ex) "plan":"10"

키

타입

필수

설명

use

bool

사용여부 (true, false)

startDate

text

Y/N

청약 시작일

ex) "startDate": "20230726"

plan

text

plan 정보(건수정보 10, 50, 100)

ex) "plan":"10"

aiTraining 객체 정의

키	타입	필수	설명
use	bool	Y	사용여부 (true, false)
startDate	text	Y/N	교육 시작일(YYYYMMDD) ex) "startDate": "20230726"
plan	text	Y/N	plan 정보(1M, 3M, 6M, 12M) ex) "plan":"3M"

키

타입

필수

설명

use

bool

사용여부 (true, false)

startDate

text

Y/N

교육 시작일(YYYYMMDD)

ex) "startDate": "20230726"

plan

text

Y/N

plan 정보(1M, 3M, 6M, 12M)

ex) "plan":"3M"

tenant 객체 정의

키		타입	필수	설명
alias		text	Y	테넌트 별칭, 유니크 ex) "alias": "nexus"

키

타입

필수

설명

alias

text

테넌트 별칭, 유니크

ex) "alias": "nexus"

[SAMPLE]

curl -v  -H "Accept: application/json" -H "Content-type: application/json" \
-X PUT -d @homepage_report_ai.json \
  http://127.0.0.1:8450/job/nexus/ai

homepage_report_ai.json

{
  "activateId": "976ff276-f72b-1116-test-1000001",
  "service": "nexus-csapp",
  "transaction": "t_create_ai",
  "prevSteps": 
[
  {
    "service": "hbe",
    "report": {
      "aiInterview": {
        "use": true,
        "startDate": "202409026",
        "plan": "10"
      },
      "aiTraining": {
        "use": true,
        "startDate": "202409026",
        "plan": "6M"
      },
      "tenant": {
        "alias": "nexus"
      }
    }
  }
]

,
  "jobRespAddr": "http://xportal.neuxcommunity.kr:8450/report/nexus/ai"
}

* 응답

[Response]

* 응답(성공)

HTTP/1.1 200 OK

* 응답(실패)

HTTP/1.1 401 Unauthorized

3.2.1.6청약 요청 응답

PUT /report/nexus/ai

[Header]

Authorization: Bearer 토큰

[Parameter]

키		타입	필수	설명
activateId		text	Y	요청받은 activateId 값

[SAMPLE]

curl -X PUT -H "Content-type: application/json" \
-d \
'"activateId":"976ff276-f72b-1112-84f8-ai"' \
http://xportal.neuxcommunity.kr:8450/report/nexus/ai

* 응답

[Response]

* 응답(성공)

HTTP/1.1 200 OK

* 응답(실패)

HTTP/1.1 404 Not Found

3.2.2청약 해지

3.2.2.1청약 해지 신청(마스터)

청약 해지를 요청한다.
마스터 청약 해지 요청하기전에 상담톡, AI 교육/면접 정보가 있을경우 상담톡, AI 교육/면접 정보 부터 해지를 신청한다.

청약 완료시 받을 URL 이 반드시 등록이 되어야 한다.

PUT /job/nexus

[Header]

Authorization: Bearer 토큰

[Parameter]

키			타입	필수	설명
activateId			text	Y	uuid 값 ex) "activateId": "976ff276-f72b-1116-test-1000001"
service			text	Y	서비스 (고정값 : nexus-csapp) ex) "service": "nexus-csapp"
transaction			text	Y	트랜잭션 구분 (고정값 : t_terminated_csapp) ex) "transaction": "t_terminated_csapp"
prevSteps			array		step 배열
	service		text	Y	서비스 구분 (고정값 : hbe) ex) "service": "hbe"
	report		object		청약 정보 객체
		tenant	object	Y	테넌트 정보 (아래 tenant 객체 참고)
jobRespAddr			text	Y	응답받을 URL "jobRespAddr": "http://127.0.0.1:8080/report/nexus"

tenant 객체 정의

키		타입	필수	설명
alias		text	Y	테넌트 별칭, 유니크

[SAMPLE]

curl -v  -H "Accept: application/json" -H "Content-type: application/json" \
-X PUT -d @homepage_report.json \
  http://127.0.0.1:8450/job/nexus

homepage_report.json

{
  "activateId": "15bed190-4331-4337-8075-0002",
  "service": "nexus-csapp",
  "serviceType": "C",
  "transaction": "t_terminated_csapp",
  "prevSteps": [
      {
          "service": "hbe",
          "report":
          {
              "activateId": "15bed190-4331-4337-8075-0002",
              "tenant":
              {
                  "alias":"test5"
              }
          }
      }
  ],
  "jobRespAddr": "http://10.10.30.47:8450/report/nexus-csapp"}

* 응답

[Response]

* 응답(성공)

HTTP/1.1 200 OK

* 응답(실패)

HTTP/1.1 401 Unauthorized

3.2.2.2청약 해지(마스터) 응답

PUT {응답받을 URL}

[Header]

Authorization: Bearer 토큰

[Parameter]

키		타입	필수	설명
activateId		text	Y	청약신청 activateId
report		object	Y	report 객체

report 객체 정의

키		타입	필수	설명
activateId		text	Y	요청받은 activateId 값

[SAMPLE]

curl -X PUT -H "Content-type: application/json" \
-d \
'{"tlogId":"976ff276-f72b-1112-84f8-ab33049d0fe4","report":{"activateId":"976ff276-f72b-1112-84f8-ab33049d0fe4"}}' \
http://xportal.neuxcommunity.kr:8450/report/nexus/ai

* 응답

[Response]

* 응답(성공)

HTTP/1.1 200 OK

* 응답(실패)

HTTP/1.1 404 Not Found

3.2.2.3청약 해지 신청(상담톡,알림톡)

청약 해지 (마스터) 를 요청하시전 상당톡, 알림톡 해지를 요청한다.
상담톡,알림톡 미사용일 경우는 요청하지 않는다.

청약 해지 완료시 받을 URL 이 반드시 등록이 되어야 한다.

PUT /job/nexus/alimtalk

[Header]

Authorization: Bearer 토큰

[Parameter]

키			타입	필수	설명
activateId			text	Y	uuid 값 ex) "activateId": "976ff276-f72b-1116-test-1000001"
service			text	Y	서비스 (고정값 : nexus-csapp) ex) "service": "nexus-csapp"
transaction			text	Y	트랜잭션 구분 (고정값 : t_terminated_notitalk) ex) "transaction": "t_terminated_notitalk"
prevSteps			array		step 배열
	service		text	Y	서비스 구분 (고정값 : hbe) ex) "service": "hbe"
	report		object		청약 정보 객체
		tenant	object	Y	테넌트 정보 (아래 tenant 객체 참고)
jobRespAddr			text	Y	응답받을 URL "jobRespAddr": "http://127.0.0.1:8450/report/nexus/alimtalk"

tenant 객체 정의

키		타입	필수	설명
alias		text	Y	테넌트 별칭, 유니크 ex) "alias": "nexus"

키

타입

필수

설명

alias

text

테넌트 별칭, 유니크

ex) "alias": "nexus"

[SAMPLE]

curl -v  -H "Accept: application/json" -H "Content-type: application/json" \
-X PUT -d @homepage_report_alimtalk.json \
  http://127.0.0.1:8450/job/nexus/alimtalk

homepage_report_alimtalk.json

{
  "activateId": "15bed190-4331-4337-8075-000001",
  "service": "nexus-notitalk",
  "serviceType": "C",
  "transaction": "t_terminated_notitalk",
  "prevSteps": [
      {
          "service": "hbe",
          "report":
          {
              "activateId": "15bed190-4331-4337-8075-000001",
              "tenant":
              {
                  "alias":"test5"
              }
          }
      }
  ],
  "jobRespAddr": "http://10.10.30.47:8450/subscription/request/adaptor"
}

* 응답

[Response]

* 응답(성공)

HTTP/1.1 200 OK

* 응답(실패)

HTTP/1.1 401 Unauthorized

3.2.2.4청약 해지(상담톡,알림톡) 응답

PUT {응답받을 URL}

[Header]

Authorization: Bearer 토큰

[Parameter]

키		타입	필수	설명
activateId		text	Y	청약신청 activateId
report		object	Y	report 객체

report 객체 정의

키		타입	필수	설명
activateId		text	Y	요청받은 activateId 값

[SAMPLE]

curl -X PUT -H "Content-type: application/json" \
-d \
'{"tlogId":"976ff276-f72b-1112-84f8-ab33049d0fe4","report":{"activateId":"976ff276-f72b-1112-84f8-ab33049d0fe4"}}' \
http://xportal.neuxcommunity.kr:8450/report/nexus/alimtalk

* 응답

[Response]

* 응답(성공)

HTTP/1.1 200 OK

* 응답(실패)

HTTP/1.1 404 Not Found

* 응답

3.2.2.5청약 해지 신청(AI 교육, AI 면접)

청약 해지 (마스터) 를 요청하시전 AI 교육, AI 면접 해지를 요청한다.
AI 교육, AI 면접 미사용일 경우는 요청하지 않는다.

청약 해지 완료시 받을 URL 이 반드시 등록이 되어야 한다.

PUT /job/nexus/ai

[Header]

Authorization: Bearer 토큰

[Parameter]

키			타입	필수	설명
activateId			text	Y	uuid 값 ex) "activateId": "976ff276-f72b-1116-test-1000001"
service			text	Y	서비스 (고정값 : nexus-csapp) ex) "service": "nexus-csapp"
transaction			text	Y	트랜잭션 구분 (고정값 : t_terminated_ai) ex) "transaction": "t_terminated_ai"
prevSteps			array		step 배열
	service		text	Y	서비스 구분 (고정값 : hbe) ex) "service": "hbe"
	report		object		청약 정보 객체
		tenant	object	Y	테넌트 정보 (아래 tenant 객체 참고)
jobRespAddr			text	Y	응답받을 URL "jobRespAddr": "http://127.0.0.1:8450/report/nexus/ai"

tenant 객체 정의

키		타입	필수	설명
alias		text	Y	테넌트 별칭, 유니크 ex) "alias": "nexus"

키

타입

필수

설명

alias

text

테넌트 별칭, 유니크

ex) "alias": "nexus"

[SAMPLE]

curl -v  -H "Accept: application/json" -H "Content-type: application/json" \
-X PUT -d @homepage_report_ai.json \
  http://127.0.0.1:8450/job/nexus/ai

homepage_report_ai.json

{
  "activateId": "15bed190-4331-4337-8075-000001",
  "service": "nexus-csapp",
  "transaction": "t_terminated_ai",
  "prevSteps": [
      {
          "service": "hbe",
          "report":
          {
              "activateId": "15bed190-4331-4337-8075-000001",
              "tenant":
              {
                  "alias":"test5"
              }
          }
      }
  ],
  "jobRespAddr": "http://10.10.30.47:8450/subscription/request/adaptor"
}

* 응답

[Response]

* 응답(성공)

HTTP/1.1 200 OK

* 응답(실패)

HTTP/1.1 401 Unauthorized

3.2.2.6청약 해지(AI 교육, AI 면접) 응답

PUT {응답받을 URL}

[Header]

Authorization: Bearer 토큰

[Parameter]

키		타입	필수	설명
activateId		text	Y	청약신청 activateId
report		object	Y	report 객체

report 객체 정의

키		타입	필수	설명
activateId		text	Y	요청받은 activateId 값

[SAMPLE]

curl -X PUT -H "Content-type: application/json" \
-d \
'{"tlogId":"976ff276-f72b-1112-84f8-ab33049d0fe4","report":{"activateId":"976ff276-f72b-1112-84f8-ab33049d0fe4"}}' \
http://xportal.neuxcommunity.kr:8450/report/nexus/ai

* 응답

[Response]

* 응답(성공)

HTTP/1.1 200 OK

* 응답(실패)

HTTP/1.1 404 Not Found

* 응답

3.3코드 정의

3.3.1결과 코드

code	message	설명
200	OK	정상코드
400	Bad Request	요청실패
401	UnauthorizedException	인증 실패
403	Forbidden	접근거부
404	Not found	찾기 실패
500	Internal Server Error
600	FailedToSendMessageException	메시지 전송 실패
601	InternalSystemErrorException	내부 시스템 에러

3.청약 자동화 API U Connect 자원 API

3.1개요

3.1.1설명

3.1.2지원 목록

3.1.3선결 과제

3.2API

3.2.1청약 신청(마스터 정보)

3.2.1.1청약 신청(마스터)

3.2.1.2청약 요청 응답

3.2.1.3청약 신청(상담톡,알림톡)

3.2.1.4청약 요청 응답

3.2.1.5청약 신청(AI 교육, AI 면접)

3.2.1.6청약 요청 응답

3.2.2청약 해지

3.2.2.1청약 해지 신청(마스터)

3.2.2.2청약 해지(마스터) 응답

3.2.2.3청약 해지 신청(상담톡,알림톡)

3.2.2.4청약 해지(상담톡,알림톡) 응답

3.2.2.5청약 해지 신청(AI 교육, AI 면접)

3.2.2.6청약 해지(AI 교육, AI 면접) 응답

3.3코드 정의

3.3.1결과 코드