API

초과 사용 현황 조회

작성일 2026.04.23 | 수정일 2026.04.29

GET/crm-core/v1/plans/me/overage

METERED 정책이 적용된 차원의 초과 사용 현황을 반환합니다. 차원별 한도·사용량·초과량·추정 요금이 한 번에 노출되어 콘솔 대시보드의 초과 요금 패널에 그대로 사용됩니다.

Response

NameTypeRequiredDescription
userOverageModestring*초과 사용 모드 — ALLOW | BLOCK
userOverageCapKRWnumber*월간 초과 사용 한도 (원)
currentMonthOverageKRWnumber*이번 달 누적 초과 요금 (원)
totalOverageChargeKRWnumber*전체 차원 초과 요금 합계 (원)
dimensionsarray<object>*METERED 정책 차원별 분석
dimensionstring*차원 이름 (예: records.max)
limitnumber*현재 적용 한도
usagenumber*현재 사용량
overagenumber*초과량 (usage - limit)
chargeKRWnumber*추정 초과 요금 (원)
unitPricenumber*단위 단가 (원)
unitLabelstring*단위 표시 (예: 건 / 1,000건)

Structure

코드 예제

const crypto = require('crypto');

const apiKey = 'NCSXXXXXXXXXXXXX';
const apiSecret = 'YOUR_API_SECRET';
const dateTime = new Date().toISOString();
const salt = crypto.randomBytes(16).toString('hex');
const signature = crypto.createHmac('sha256', apiSecret).update(dateTime + salt).digest('hex');
const authHeader = HMAC-SHA256 apiKey=${apiKey}, date=${dateTime}, salt=${salt}, signature=${signature};

const response = await fetch('https://api.solapi.com/crm-core/v1/plans/me/overage', {
method: 'GET',
headers: { 'Authorization': authHeader, 'Content-Type': 'application/json' }
});
const data = await response.json();

import hmac, hashlib, secrets, requests
from datetime import datetime, timezone

api_key = 'NCSXXXXXXXXXXXXX'
api_secret = 'YOUR_API_SECRET'
date_time = datetime.now(timezone.utc).strftime('%Y-%m-%dT%H:%M:%SZ')
salt = secrets.token_hex(16)
signature = hmac.new(api_secret.encode(), (date_time + salt).encode(), hashlib.sha256).hexdigest()
auth_header = f'HMAC-SHA256 apiKey={api_key}, date={date_time}, salt={salt}, signature={signature}'

response = requests.get('https://api.solapi.com/crm-core/v1/plans/me/overage', headers={
'Authorization': auth_header,
'Content-Type': 'application/json'
})
data = response.json()

API_KEY="NCSXXXXXXXXXXXXX"
API_SECRET="YOUR_API_SECRET"
DATE=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
SALT=$(openssl rand -hex 16)
SIGNATURE=$(echo -n "${DATE}${SALT}" | openssl dgst -sha256 -hmac "${API_SECRET}" | awk '{print $NF}')
AUTH="HMAC-SHA256 apiKey=${API_KEY}, date=${DATE}, salt=${SALT}, signature=${SIGNATURE}"

curl -X GET 'https://api.solapi.com/crm-core/v1/plans/me/overage' \
-H "Authorization: ${AUTH}" \
-H "Content-Type: application/json"

lightbulb

`dimensions`에 포함되는 차원은 `OVERAGE_POLICY` 정의가 `METERED`인 항목뿐입니다. BLOCK/THROTTLE 정책 차원은 한도 초과 시 즉시 차단되므로 별도 응답에 포함되지 않습니다.

lightbulb

**401 응답**: `{ "errorCode": "Unauthorized", "errorMessage": "권한이 없습니다." }`