발신번호 등록 API

Overview

발신번호 등록제 시행(2015년 4월 16일부터)에 따라 모든 문자메시지는 발신번호를 우선적으로 등록 후 발송 가능합니다.

 

Github에서 예제를 확인하세요.

https://github.com/coolsms/senderid-html-sample

POST register

발신번호를 등록합니다. 하지만 verify 리소스를 호출하여 인증확인 절차를 거쳐야 활성화 됩니다.

한 계정으로 같은 발신번호를 중복하여 등록할 수 없습니다.

Resource Url

https://api.coolsms.co.kr/senderid/1.2/register

Parameters

Mandatory Field Description
O 인증정보 인증데이터는 필수입니다. Authentication 참고
O phone

발신번호

예) 021234567

  site_user

사이트 유저 아이디 입력, 미입력시 __private__ 으로 설정됩니다.

예) admin

관계 법령에 따라 사용 불가

Response

JSON형식의 아래의 데이터가 리턴됩니다.

Mandatory Field Description
O handle_key

등록된 발신번호의 핸들값, verify 호출시 필요

O ars_number 전화 해야할 ARS 번호

 

Example Response

{
    "handle_key":"SID55DAD88A7E4EC",
    "ars_number":"01021382269"
}

 

POST verify

해당 발신번호의 인증결과를 확인 후 활성화 시킵니다.

Resource Url

https://api.coolsms.co.kr/senderid/1.2/verify

Parameters

Mandatory Field Description
O 인증정보 인증데이터는 필수입니다. Authentication 참고
O handle_key register 호출 후 리턴받은 핸들값

Response

데이터 없음 : 오류 없을 시 정상  등록, 오류 발생시 오류 테이블 참고

 

POST delete

발신번호를 삭제합니다. 

Resource Url

https://api.coolsms.co.kr/senderid/1.2/delete

Parameters

Mandatory Field Description
O 인증정보 인증데이터는 필수입니다. Authentication 참고
O phone 삭제할 발신번호
  site_user

사이트 유저 아이디 입력, 미입력시 __private__ 으로 설정됩니다.

예) admin

관계 법령에 따라 사용 불가

Response

데이터 없음 : 오류 없을 시 정상  등록, 오류 발생시 오류 테이블 참고

GET list

등록된 발신번호 목록을 조회합니다.

Resource Url

https://api.coolsms.co.kr/senderid/1.2/list

Parameters

Mandatory Field Description
O 인증정보 인증데이터는 필수입니다. Authentication 참고
  site_user

사이트 유저 아이디 입력, 미입력시 __private__ 으로 입력됩니다.

예) admin

관계 법령에 따라 사용 불가

Response

JSON형식의 아래의 데이터가 리턴됩니다

[
    {"idno":"SID555C89C49627D","phone_number":"0809302266","flag_default":"Y","updatetime":"2015-06-12 10:21:06","regdate":"2015-05-20 22:19:00"},
    {"idno":"SID5568347CC1518","phone_number":"01012345678","flag_default":"N","updatetime":"2015-05-29 18:42:58","regdate":"2015-05-29 18:42:20"}
]

 

POST set _default

기본으로 사용될 발신번호를 지정합니다.

Resource Url

https://api.coolsms.co.kr/senderid/1.2/set_default

Parameters

Mandatory Field Description
O 인증정보 인증데이터는 필수입니다. Authentication 참고
O handle_key 발신번호 핸들값을 입력
  site_user

사이트 유저 아이디 입력, 미입력시 __private__ 으로 입력됩니다.

예) admin

관계 법령에 따라 사용 불가

GET get_default

기본으로 사용될 발신번호를 리턴합니다.

Resource Url

https://api.coolsms.co.kr/senderid/1.2/get_default

Parameters

Mandatory Field Description
O 인증정보 인증데이터는 필수입니다. Authentication 참고
  site_user

사이트 유저 아이디 입력, 미입력시 __private__ 으로 입력됩니다.

예) admin

관계 법령에 따라 사용 불가

Response

JSON형식의 아래의 데이터가 리턴됩니다

{
    "handle_key":"SID555C89C49627D",
    "phone_number":"0809302266"
}