CONTACT
  • 문의
    nit@nitsoft.biz
  • TEL
    1600-0648
  • FAX
    02-561-8616
  • 주소
    서울특별시 강남구 선릉로 624, 3층
회사사업문의
홈
>API
>문자 API
>발신 번호
발신번호 등록 인증코드 발송
채널 등록을 위한 인증코드 발송
post
EndPoint
POST /message/channels/phone
ParametersBody
phone
*
휴대전화 번호
Response
- JSON
statusCode
오류 코드
error
오류 메세지
message
결과 메세지
key
휴대전화번호 인증키
phone
휴대전화 번호
isVerified
검증 여부
expiredAt
만료 일시
Example
Request
POST /message/channels/phone
Request Body
{
    "phone": "01000000000"
}
설명
Response
{
    "key": 280,
    "phone": "01000000000",
    "isVerified": 0,
    "expiredAt": "2024-08-23T13:17:25.000Z"
}
설명
Error Response
{
    "statusCode": 400,
    "error": "Bad Request",
    "message": [
        "휴대전화번호 형식이 올바르지 않습니다."
    ]
}
설명
탑버튼
발신번호 등록 인증코드 검증
채널 등록을 위한 인증코드 검증
put
EndPoint
PUT /message/channels/phone
Parameters Body
verificationKey
*
휴대전화번호 인증키
code
*
휴대전화번호 인증코드
Response
- JSON
statusCode
오류 코드
error
오류 메세지
message
결과 메세지
key
휴대전화번호 인증키
phone
휴대전화 번호
isVerified
검증 여부
expiredAt
만료 일시
Example
Request
PUT /message/channels/phone
Request Body
{
    "verificationKey": 280,
    "code": "######"
}
설명
Response
{
    "key": 281,
    "phone": "01000000000",
    "isVerified": 1,
    "expiredAt": "2024-08-23T13:24:20.000Z"
}
설명
Error Response
{
    "statusCode": 400,
    "error": "Bad Request",
    "message": "휴대전화번호 인증 시간이 만료되었거나, 인증 번호가 틀립니다."
}
설명
탑버튼
발신번호 등록
발신번호 등록
post
EndPoint
POST /message/channels
Parameters Body
name
*
발신번호 별칭
phone
*
발신번호
phoneType
*
발신번호 유형 (B: 사업자, P: 개인)
isOwn
*
명의자 구분 (0: 타인, 1: 본인)
isElection
*
선거용 발신번호 여부
verificationKey
발신번호 인증키
candidateName
후보자명 (isElection이 1인 경우 필수)
candidateInformation
선거정보 (isElection이 1인 경우 필수)
Response
- JSON
statusCode
오류 코드
error
오류 메세지
message
결과 메세지
key
발신번호 키
name
발신번호 별칭
phone
발신번호
phoneType
발신번호 유형 (B: 사업자, P: 개인)
isOwn
명의자 구분 (0: 타인, 1: 본인)
isElection
선거용 발신번호 여부
stauts
상태(verified: 완료, pending: 대기, rejected: 반려, suspended: 중지)
expiredAt
만료일시
election
선거정보
name
후보자명
information
선거정보
Example
Request
POST /message/channels
Request Body
{
    "name": "테스트 발신번호",
    "phone": "010000000000",
    "phoneType": "P",
    "verificationKey": 231,
    "isOwn": 1,
    "isElection": 1,
    "candidateName": "홍길동",
    "candidateInformation": "기호 1번"
}
설명
Response
{
    "key": "#################",
    "name": "테스트 발신번호",
    "phone": "0100000000000",
    "phoneType": "P",
    "isOwn": 1,
    "isElection": 1,
    "status": "verified",
    "expiredAt": "2025-08-23 12:00:00",
    "election": {
        "name": "홍길동",
        "information": "기호 1번"
    }
}
설명
Error Response
{
    "statusCode": 400,
    "error": "Bad Request",
    "message": "휴대전화번호 인증을 진행해주세요."
}
설명
탑버튼
발신번호 목록 조회
발신번호 목록 조회
get
EndPoint
GET /message/channels
Response
- JSON
statusCode
오류 코드
error
오류 메세지
message
결과 메세지
key
발신번호 고유키
name
발신번호 별칭
phone
발신번호
phoneType
사업자 구분 (B: 사업자, P: 개인)
isOwn
명의자 구분 (0: 타인, 1: 본인)
isElection
선거용 발신번호 여부
status
인증 상태
order
정렬 순서
expiredAt
만료일자
comments
발신번호 반려사유
Example
Request
GET /message/channels
Response
[
    {
        "key": "발신번호 키1",
        "name": "별칭1",
        "phone": "01000000000",
        "phoneType": "P",
        "isOwn": 1,
        "isElection": 0,
        "status": "인증완료",
        "order": 1,
        "expiredAt": "2026-01-01",
        "comments": [
        ]
    },
    {
        "key": "발신번호 키2",
        "name": "별칭2",
        "phone": "01000000001",
        "phoneType": "P",
        "isOwn": 1,
        "isElection": 0,
        "status": "반려",
        "order": 1,
        "expiredAt": "2026-01-01",
        "comments": [
            "반려사유입니다."
        ]
    }
]
설명
Error Response
{
    "statusCode": 401,
    "error": "Unauthorized",
    "message": "x-api-key를 확인해 주세요."
}
설명
탑버튼