본문으로 건너뛰기

각종 데이터 조회 예제

해당 페이지에서는 COOLSMS PHP SDK를 이용하여 각종 COOLSMS 내 저장 된 데이터를 조회하는 방법에 대해 가이드하고 있습니다.

정보
  • 각 발송 예시에 대한 결과 값 표시 기능은 현재 준비중에 있습니다.
  • 해당 예제는 PHP 7 버전 이상에서만 구동 가능합니다.
  • 해당 예제는 PHP SDK 5.0.4 버전을 기준으로 작성되었습니다.
  • 해당 예제의 모든 코드는 namespace, use(import) 키워드가 제외되어 있습니다!
  • PHP 5 버전을 사용하시는 분들께서는 아래의 PHP 5 버전 예제 링크를 참고해주세요!

환경설정​

터미널에서 연동할 프로젝트의 폴더로 이동하신 다음 아래와 같은 명령어를 입력하여 SDK를 설치해보세요!
설치가 완료되면 아래의 예제들을 참고하셔서 데이터 조회를 진행해보세요!

주의

Composer가 설치되어 있어야 합니다.

composer require coolsms/sdk

잔액 조회​

$messageService = new CoolsmsMessageService("API 키 입력", "API 시크릿 키 입력");
$response = $messageService->getBalance();

// 충전 요금(잔액) 조회
echo $response->balance . "\n";

// 잔여 포인트 조회
echo $response->point;

메시지 조회 예제(문자, 알림톡 등)​

$messageService = new CoolsmsMessageService("API 키 입력", "API 시크릿 키 입력");

// 필요한 검색 조건에 따라 주석들을 해제하여 응용해보세요!
$parameter = new GetMessagesRequest();

// 발신번호로 검색
// $parameter->setFrom("발신번호 입력");

// 수신번호로 검색
// $parameter->setTo("수신번호 입력");

// 조회할 건 수 지정
// $parameter->setLimit(1);

// 메시지 조회 시 나오는 nextKey로 페이지 조회
// $parameter->setStartKey("nextKey로 나온 값 입력");

// 그룹 ID로 조회
// $parameter->setGroupId("그룹 ID 입력");

// 메시지 ID로 조회
// $parameter->setMessageId("메시지 ID 입력");

// 메시지 ID 여러개 조회
// $parameter->setMessageIds([
//     "메시지 ID 입력",
//     "메시지 ID 입력"
// ]);

// 메시지 유형(알림톡: ATA, 단문 문자:SMS 등)으로 검색
// 유형에 대한 값은 아래 내용을 참고해주세요!
// SMS: 단문
// LMS: 장문
// MMS: 사진문자
// ATA: 알림톡
// CTA: 친구톡
// CTI: 이미지 친구톡
// NSA: 네이버 스마트알림
// RCS_SMS: RCS 단문
// RCS_LMS: RCS 장문
// RCS_MMS: RCS 사진문자
// RCS_TPL: RCS 템플릿문자
// $parameter->setType("조회 할 메시지 유형입력");

// 조회 할 상태코드 입력, 상태 코드 목록은 아래 페이지를 참고해주세요!
// https://developers.coolsms.com/references/message-status-codes
// $parameter->setStatusCode("조회 할 상태코드 입력");

// 날짜로 검색, startDate와 endDate가 반드시 같이 기입되어야 합니다!
// date_default_timezone_set("Asia/Seoul");
// $startDate = DateTime::createFromFormat("Y-m-d H:i:s", "2022-11-22 00:00:00")->format("c");
// $endDate = DateTime::createFromFormat("Y-m-d H:i:s", "2022-11-22 23:59:59")->format("c");
// $parameter->setStartDate($startDate);
// $parameter->setEndDate($endDate);

$messages = $messageService->getMessages($parameter);
print_r($messages);

foreach ($messages->messageList as $key => $val) {
    echo "메시지ID: {$val->messageId}\n";
    echo "그룹ID: {$val->groupId}\n";
    echo "타입: {$val->type}\n";
    echo "국가: {$val->country}\n";
    echo "제목(LMS, MMS): {$val->subject}\n";
    echo "내용: {$val->text}\n";
    echo "발신번호: {$val->from}\n";
    echo "수신번호: {$val->to}\n";
    echo "상태(코드): {$val->statusCode}\n";
    echo "-----------------------------\n";
}

통계 조회(발송 현황 등)​

$messageService = new CoolsmsMessageService("API 키 입력", "API 시크릿 키 입력");

// 날짜 검색이 필요할 경우 아래 주석을 해제하여 검색해보세요!
$parameter = new GetStatisticsRequest();

// 날짜로 검색, startDate와 endDate가 반드시 같이 기입되어야 합니다!
// date_default_timezone_set("Asia/Seoul");
// $startDate = DateTime::createFromFormat("Y-m-d H:i:s", "2022-11-22 00:00:00")->format("c");
// $endDate = DateTime::createFromFormat("Y-m-d H:i:s", "2022-11-22 23:59:59")->format("c");
// $parameter->setStartDate($startDate);
// $parameter->setEndDate($endDate);

$response = $messageService->getStatistics($parameter);
print_r($response);