잔액 · 발신번호 · 프로필

발송 전 점검에 쓰는 조회 API 입니다. 잔액, API 로 사용할 수 있는 발신번호, 카카오 발신프로필과 템플릿(코드·변수)을 확인할 수 있습니다.

잔액 조회

GET /v1/account/balance
JSON
{ "request_id": "req_…", "data": { "balance": 82422, "currency": "KRW" } }

잔액은 웹사이트와 같은 지갑입니다. 대량 발송 전에 dry_run 의 amount 와 비교하면 402 INSUFFICIENT_BALANCE 를 미리 피할 수 있습니다.

발신번호 목록

GET /v1/send-numbers
JSON
{
  "request_id": "req_…",
  "data": [
    { "number": "0212345678", "alias": "본사 대표번호", "status": "APPROVED", "api_enabled": true },
    { "number": "01099998888", "alias": null, "status": "APPROVED", "api_enabled": false }
  ]
}
  • status: 웹에서의 승인 상태 (APPROVED 만 발송 가능)
  • api_enabled: true 인 번호만 API 의 from 으로 사용할 수 있습니다. 켜는 방법은 인증 · API 키 참고.

카카오 발신프로필 목록

GET /v1/kakao/profiles
JSON
{
  "request_id": "req_…",
  "data": [
    {
      "profile": "2f81c0b7e4d9…",
      "channel_name": "레드빈 스토어",
      "plus_friend_id": "@redbean",
      "usable": true,
      "brand_message": false
    }
  ]
}
  • profile 은 발송 API 의 profile 값(발신프로필 키)입니다.
  • usable: 승인되어 정상 사용 가능한 프로필 (차단·휴면이면 false)
  • brand_message: 브랜드메시지 발송이 가능한 프로필인지 여부

템플릿 목록

GET /v1/kakao/templates?profile={profile}&channel=alimtalk|brand
쿼리설명
profile 필수발신프로필 키
channelalimtalk(기본) 또는 brand
JSON
{
  "request_id": "req_…",
  "data": [
    {
      "template_code": "ORDER_RECEIVED",
      "name": "주문 접수 안내",
      "content": "#{name}님, #{item} 주문이 접수되었습니다.",
      "variables": ["name", "item"]
    }
  ]
}
  • 발송 가능한(승인·정상) 템플릿만 반환됩니다.
  • variables 는 발송 시 recipients[].variables 에 반드시 채워야 하는 변수 이름 목록입니다.
  • 브랜드 템플릿 응답에는 bubble_type 이 추가로 포함됩니다.
  • 프로필·템플릿의 등록과 검수 요청은 웹사이트에서만 가능합니다. 승인 결과는 웹사이트에서 확인하세요.

헬스 체크

GET /v1/health

인증 없이 호출할 수 있는 서버 상태 확인 엔드포인트입니다. 요청 제한에 포함되지 않지만 모니터링 용도로 분당 수 회 이내로 사용하세요.

JSON
{ "request_id": "req_…", "data": { "status": "ok", "time": "2026-11-07T09:00:00+09:00" } }