1-1. 메시지 기본 정보 발송

발송 방법 및 전송/수신 파라미터 정의

SSL Protocol을 이용하여 파라미터들을 핑거푸시 Server to Server API Server(이하 API Server)에 전달합니다.

API Server로 전달해야 할 파라미터들은 아래 표를 참조해 주세요.

HTTPS Headers

파라미터명
필수 여부
설명

Content-Type

필수

application/json

authorization

필수

Bearer {token} 토큰 발급 API에서 발급받은 JWT 토큰 값

HTTPS Parameters

[표 1.1] 다수 발송, 메시지 IDX 받기 HTTPS, Parameters

파라미터명
필수 여부
Data Type
설명

callback

필수

text(25)

카카오 발신프로필 키

subject

필수

byte(40)

문자 메시지 제목

mmsContent

필수

byte(2000)

문자 메시지 내용 (90Byte이하일 경우 : SMS로 발송, 90Byte초과시는 LMS로 발송)

title

선택

text(100)

캠페인 구분용 제목

fileKeys

선택

list

첨부파일 fileKey [문자 > 이미지 관리 > 발급된 파일키]

orgCode

선택

text(20)

부서 코드 (핑거푸시 사이트에서 발급받은 부서 코드)

sendStatus

선택

text(4)

0001: 바로 발송(default)

0002: 예약발송

sendDate

선택

text(20)

발송 시간 yyyy-MM-dd HH:mm:ss

originCid

선택

text(9)

특부가 사업번호(특부가 사업자의 경우 필수)

Request JSON Sample

SMS, LMS 발송

MMS 발송

Response JSON

API 서버에서 전달 받은 파라미터 처리 후 결과를 JSON 형태로 제공합니다. code 값이 200 이고, processCode가 20001 이면 다음 대상자 등록 프로세스를 진행합니다.

[표 1.2] 발송 JSON 결과

설명

code

결과 코드

message

결과 메시지

data.msgIdx

메시지 번호

data.processCode

메시지 처리 단계 코드

data.ratelimitRemaining

분당 허용되는 최대 요청 횟수

data.retryAfter

잔여 분(minute) 동안 가능한 요청 횟수

[표 1.3] 발송 JSON 결과의 result code 유형

코드
내용
비고

200

정상처리 됨

401

접근 권한이 없습니다.

계정 서비스 권한 여부

403

필수 값이 없습니다.

429

분당 호출 수 초과

4035

유효한 호출이 아닙니다.

인증 토큰 누락

4036

유효한 호출이 아닙니다.

인증 토큰 만료

4037

유효한 호출이 아닙니다.

화이트리스트에 존재하지 않는 IP

500

서버 에러

[표 1.4] JSON 결과의 processCode code 유형

코드
내용
비고

20001

문자메시지 등록 정상 처리

메시지 아이디가 반환됨

20002

발송 대상자 등록 정상 처리

20003

문자메시지 등록 완료

Last updated