5.1API 개요
과금 조회를 위한 API 를 제공한다.
알림톡, SMS, 상담톡 서비스 이용에 대한 과금을 월 단위로 제공한다.
response는 JSON형태 로 전달됩니다.
5.1.1선결 조건
고객의 청약 신청이 완료 되어야 조회가 가능한다.
5.1.2과금 API 리스트
5.1.2.1알림톡 발송 건수
알림톡 발송에 대한 건수를 조회 할수 있다.
발송이 성공한 경우만 제공한다.
5.1.2.2SMS 발송 건수
SMS/LMS/MMS 발송에 대한 건수를 조회 할수 있다.
SMS 종류에 따라 과금이 달라야 한다.
발송이 성공한 경우만 제공한다.
5.1.2.3상담톡 과금 건수
상담톡의 경우 하루를 기준으로 동일한 사용자의 경우 1건만 계산된다.
기준 시간은 새벽 4시 기준이다.
상담원 또는 봇이 응답하지 못했을 경우는 건수를 포함하지 않는다.
5.2과금 API
5.2.1알림톡 발송 건수
지정한 월의 발송 건수를 조회한다.
5.2.1.1Request
Description | 채팅상담 오픈 요청. |
|---|---|
Method | POST |
API URL | /subscription/alimtalk/count |
Header Parameters
키네임 | 필수 | 설명 |
|---|---|---|
Content-Type | Y | application/json |
Parameter
키네임 | 타입 | 필수 | 설명 |
|---|---|---|---|
tenant_alias | string | Y | 조회할 테넌트 alias 정보 |
date | string | Y | 조회할 년/월 (YYYYMM) ex) "date":"202407" |
- [Example]
curl -H "Content-type: application/json" \
-X POST -d \
'{"tenant_alias":"nexus", "date":"202407"}' \
https://xbiztalk.nexuscommunity.kr/subscription/alimtalk/count5.2.1.2Response
- HTTP HEADER 200: 성공, 나머지는 실패
키 | - | 타입 | 설명 |
|---|---|---|---|
code | text | 결과 코드 | |
message | text | 결과 메시지 | |
data | object | - | |
alimtalk | int | 결과건수 |
5.2.2SMS 발송 건수
지정한 월의 발송 건수를 조회한다.
5.2.2.1Request
Description | 채팅상담 오픈 요청. |
|---|---|
Method | POST |
API URL | /subscription/sms/count |
Header Parameters
키네임 | 필수 | 설명 |
|---|---|---|
Content-Type | Y | application/json |
Parameter
키네임 | 타입 | 필수 | 설명 |
|---|---|---|---|
tenant_alias | string | Y | 조회할 테넌트 alias 정보 |
date | string | Y | 조회할 년/월 (YYYYMM) ex) "date":"202407" |
- [Example]
curl -H "Content-type: application/json" \
-X POST -d \
'{"tenant_alias":"nexus", "date":"202407"}' \
https://xbiztalk.nexuscommunity.kr/subscription/sms/count5.2.2.2Response
- HTTP HEADER 200: 성공, 나머지는 실패
키 | - | 타입 | 설명 |
|---|---|---|---|
code | text | 결과 코드 | |
message | text | 결과 메시지 | |
data | object | - | |
sms | int | sms 결과건수 | |
lms | int | lms 결과건수 | |
mms | int | mms 결과건수 |
아래의 코드표 참조
5.2.3카카오 상담톡 발송 건수
지정한 월의 발송 건수를 조회한다.
5.2.3.1Request
Description | 채팅상담 오픈 요청. |
|---|---|
Method | POST |
API URL | /subscription/kakao/count |
Header Parameters
키네임 | 필수 | 설명 |
|---|---|---|
Content-Type | Y | application/json |
Parameter
키네임 | 타입 | 필수 | 설명 |
|---|---|---|---|
tenant_alias | string | Y | 조회할 테넌트 alias 정보 |
date | string | Y | 조회할 년/월 (YYYYMM) ex) "date":"202407" |
- [Example]
curl -H "Content-type: application/json" \
-X POST -d \
'{"tenant_alias":"nexus", "date":"202407"}' \
https://xbiztalk.nexuscommunity.kr/subscription/sms/count5.2.3.2Response
- HTTP HEADER 200: 성공, 나머지는 실패
키 | - | 타입 | 설명 |
|---|---|---|---|
code | text | 결과 코드 | |
message | text | 결과 메시지 | |
data | object | - | |
kakao | int | kakao 결과건수 |
아래의 코드표 참조
5.3코드 정의
5.3.1오류 코드
code | message | 설명 |
|---|---|---|
0 | 정상코드 | |
-400 | ForbiddenException | 권한 없음 |
-500 | UnauthorizedException | 인증 실패 |
-502 | InvalidSessionException | 세션이 만료되었거나 존재하지 않음 |
-509 | InvalidJsonException | 잘못된 파라메터 요청 |
-600 | FailedToSendMessageException | 메시지 전송 실패 |
-601 | InternalSystemErrorException | 내부 시스템 에러 |