고객센터

하이웍스 문자 API를 이용해서 문자 발송하기와 잔여 건수를 확인할 수 있습니다.

문자를 발송하기 전, [오피스 토큰] 생성과 발신 번호 사전 등록을 진행해야 합니다.

 

• 발신번호 사전 등록제란 2015년 10월 16일 전기통신사업법 제84조에 따라 등록된 발신번호로만 문자를 발송할 수 있도록 ‘발신번호 사전 등록제’가 시행되었습니다. 따라서, API를 통한 문자 발송도 발신번호를 사전 등록해야 합니다. • 발신번호 사전 등록은 하이웍스 오피스 PC 버전에서만 가능합니다.

 

 

1. 하이웍스 오피스에 로그인  후 오피스 홈에서 [메시징]을 클릭합니다.

 

 

• 전기통신사업법 제84조의2 제3항에 따라, 하이웍스 오피스에서 제공하는 문자를 이용하기 위해서는 오피스당 1회의 본인 인증이 필요합니다. ‘휴대전화 본인인증’ 이후 문자 서비스를 이용할 수 있습니다.

 

 

2. [메시징 > 환경설정 > 발신 번호 설정 > 등록하기]를 클릭해 발신 번호를 등록합니다.

 

 

1) 개인용

 

- 휴대전화 번호(휴대전화 인증): 010/011/016/017/018/019로 시작하는 번호

- 유선전화 번호(ARS 인증): 17개 지역번호 및 0*0 계열로 시작하는 번호

 

2)  오피스 공용

 

특수전화번호(서류 인증): 전국 대표 번호(15**, 16** 등)와 특수전화번호(112,119 등)로 공용 번호를 등록할 경우, 통신 서비스 이용 증명원 서류 제출이 필요합니다.

 

발신 번호 등록이 완료되었다면, API를 이용해 문자(SMS)를 발송할 수 있습니다.

 

 

문자 발송하기

 

단문: 90byte (한글 45자) / 장문: 2,000byte (한글 1,000자) / 포토 문자: 2,000byte + 이미지 200KB 최대 3개까지

문자를 발송한 솔루션에서 user id, api key 등 필수 입력 값을 넣고 발송합니다.

 

• user ID: 오피스 ID

• office token: 오피스 관리 페이지에서 발급 받은 office token (오피스 토큰)

• sms Type: 단문, 장문, 포토 문자에서 선택

• sender: 발신자 - 사전에 등록된 발신번호에서만 발송 가능

• receiver: 수신을 받을 대상의 핸드폰 번호 입력

• message: 문자 본문 작성 (단문의 경우, 90byte 이상입력 시, 단문으로 잘려 발송됩니다.)

• send_date: 발송 시간 (발송시간 미 입력 시, 즉시 발송됩니다. 현재 시간 이후의 시간을 설정할 경우, 예약 발송이 됩니다.)

• File: 포토 문자를 발송 할 경우, 첨부 파일200KB, 최대 3개까지 발송할 수 있습니다.

 

 

 

발송 결과 확인하기

 

문자 발송 시, 발송자가 지정한 refkey로 실제 발송 상태를 확인할 수 있습니다.

refkey는 문자 발송 후, 하이웍스에서 임의로 지정하는 값입니다.

 

예) 200 success 요청이 성공적으로 완료되었습니다.

400 fail 요청이 실패되었습니다. 

500 server error 서버에 오류가 발생했습니다. 

 

 

잔여 건수 확인

 

발송 후, 총 잔여 건수를 조회할 수 있습니다. 

 

• shared_sms : 공용문자

• assign_sms : 할당 문자

• shared_ars : 공용 ARS 문자

• assign_ars : 할당 ARS 문자

 

 

발송 건수 확인

 

발송이 완료된 문자에 대한 건수를 조회할 수 있습니다.

 

• sms use count : 단문 문자 사용 건수

• lms use count : 장문 문자 사용 건수

• mms use count : 포토 문자 사용 건수

• period : 조회 기간