メインコンテンツへスキップ
  1. Karaden SMS API サポート
  2. サンプルコード
  3. SMS送信サービス【PHP】

Ver.2023-12-01

  • 更新

SMS送信（即時送信）

<?php

include_once "vendor/autoload.php";
use DateTimeImmutable;
use DateTimeInterface;
use Karaden\Config;
use Karaden\Model\Message;
use Karaden\Param\Message\MessageCreateParams;
use Karaden\Exception\BadRequestException;
use Karaden\Exception\ForbiddenException;
use Karaden\Exception\InvalidParamsException;
use Karaden\Exception\NotFoundException;
use Karaden\Exception\TooManyRequestsException;
use Karaden\Exception\UnauthorizedException;
use Karaden\Exception\UnexpectedValueException;
use Karaden\Exception\UnknownErrorException;
use Karaden\Exception\UnprocessableEntityException;

Config::$apiKey = 'PJ-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
Config::$apiVersion = '2023-12-01';
Config::$tenantId = 'xxxxxxxxx-zzzz-yyyy-zzzz-12345678901';

$body = <<<EOS
送信テストです。
https://www.nttcoms.com/
EOS;
$datetime = DateTimeImmutable::createFromFormat(DateTimeInterface::ATOM, '2023-04-03T18:25:00+09:00');
$params = MessageCreateParams::newBuilder()
    ->withServiceId(1)
    ->withTo('090********')
    ->withBody($body)
    ->withTags(['test'])
    ->withLimitedAt($datetime)
    ->build();
$requestOptions = Config::asRequestOptions();
try {
    $message = Message::create($params, $requestOptions);
    var_dump($message);
} catch ( BadRequestException $e ) {
    echo "BadRequestException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( ForbiddenException $e ) {
    echo "ForbiddenException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( InvalidParamsException $e ) {
    echo "InvalidParamsException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( NotFoundException $e ) {
    echo "NotFoundException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( TooManyRequestsException $e ) {
    echo "TooManyRequestsException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( UnauthorizedException $e ) {
    echo "UnauthorizedException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( UnexpectedValueException $e ) {
    echo "UnexpectedValueException" . "が発生しました。" . PHP_EOL;
    echo "[StatusCode]" . PHP_EOL;
    var_dump($e->statusCode);
    echo "[Body]" . PHP_EOL;
    var_dump($e->body);
} catch ( UnknownErrorException $e ) {
    echo "UnknownErrorException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( UnprocessableEntityException $e ) {
    echo "UnprocessableEntityException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( Exception $e ) {
    echo "[Error!]" . PHP_EOL;
    var_dump($e);
}

?>


SMS送信（予約送信）

<?php
include_once "vendor/autoload.php";
use DateTimeImmutable;
use DateTimeInterface;
use Karaden\Config;
use Karaden\Model\Message;
use Karaden\Param\Message\MessageCreateParams;
use Karaden\Exception\BadRequestException;
use Karaden\Exception\ForbiddenException;
use Karaden\Exception\InvalidParamsException;
use Karaden\Exception\NotFoundException;
use Karaden\Exception\TooManyRequestsException;
use Karaden\Exception\UnauthorizedException;
use Karaden\Exception\UnexpectedValueException;
use Karaden\Exception\UnknownErrorException;
use Karaden\Exception\UnprocessableEntityException;

Config::$apiKey = 'PJ-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
Config::$apiVersion = '2023-12-01';
Config::$tenantId = 'xxxxxxxxx-zzzz-yyyy-zzzz-12345678901';

$body = <<<EOS
送信テストです。
https://www.nttcoms.com/
EOS;
$datetime = DateTimeImmutable::createFromFormat(DateTimeInterface::ATOM, '2023-04-11T10:30:00+09:00');
$params = MessageCreateParams::newBuilder()
    ->withServiceId(1)
    ->withTo('090********')
    ->withBody($body)
    ->withTags(['test'])
    ->withLimitedAt($datetime)
    ->withScheduledAt($datetime)
    ->build();

$requestOptions = Config::asRequestOptions();
try {
    $message = Message::create($params, $requestOptions);
    var_dump($message);
} catch ( BadRequestException $e ) {
    echo "BadRequestException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( ForbiddenException $e ) {
    echo "ForbiddenException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( InvalidParamsException $e ) {
    echo "InvalidParamsException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( NotFoundException $e ) {
    echo "NotFoundException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( TooManyRequestsException $e ) {
    echo "TooManyRequestsException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( UnauthorizedException $e ) {
    echo "UnauthorizedException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( UnexpectedValueException $e ) {
    echo "UnexpectedValueException" . "が発生しました。" . PHP_EOL;
    echo "[StatusCode]" . PHP_EOL;
    var_dump($e->statusCode);
    echo "[Body]" . PHP_EOL;
    var_dump($e->body);
} catch ( UnknownErrorException $e ) {
    echo "UnknownErrorException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( UnprocessableEntityException $e ) {
    echo "UnprocessableEntityException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( Exception $e ) {
    echo "[Error!]" . PHP_EOL;
    var_dump($e);
}
?>

 

SMS送信結果取得(一括)

<?php

include_once "vendor/autoload.php";
use Karaden\Config;
use Karaden\Model\Message;
use Karaden\Param\Message\MessageListParams;
use Karaden\Exception\BadRequestException;
use Karaden\Exception\ForbiddenException;
use Karaden\Exception\InvalidParamsException;
use Karaden\Exception\NotFoundException;
use Karaden\Exception\TooManyRequestsException;
use Karaden\Exception\UnauthorizedException;
use Karaden\Exception\UnexpectedValueException;
use Karaden\Exception\UnknownErrorException;
use Karaden\Exception\UnprocessableEntityException;

Config::$apiKey = 'PJ-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
Config::$apiVersion = '2023-12-01';
Config::$tenantId = 'xxxxxxxxx-zzzz-yyyy-zzzz-12345678901';

$params = MessageListParams::newBuilder()
    ->withServiceId(1)
    ->withTo('090********')
    ->build();
$requestOptions = Config::asRequestOptions();

try {
    $collection = Message::list($params, $requestOptions);
    var_dump($collection);
} catch ( BadRequestException $e ) {
    echo "BadRequestException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( ForbiddenException $e ) {
    echo "ForbiddenException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( InvalidParamsException $e ) {
    echo "InvalidParamsException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( NotFoundException $e ) {
    echo "NotFoundException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( TooManyRequestsException $e ) {
    echo "TooManyRequestsException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( UnauthorizedException $e ) {
    echo "UnauthorizedException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( UnexpectedValueException $e ) {
    echo "UnexpectedValueException" . "が発生しました。" . PHP_EOL;
    echo "[StatusCode]" . PHP_EOL;
    var_dump($e->statusCode);
    echo "[Body]" . PHP_EOL;
    var_dump($e->body);
} catch ( UnknownErrorException $e ) {
    echo "UnknownErrorException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( UnprocessableEntityException $e ) {
    echo "UnprocessableEntityException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( Exception $e ) {
    echo "[Error!]" . PHP_EOL;
    var_dump($e);
}
?>

 

SMS送信結果取得(レコード単位)

<?php

include_once "vendor/autoload.php";
use Karaden\Config;
use Karaden\Model\Message;
use Karaden\Param\Message\MessageDetailParams;
use Karaden\Exception\BadRequestException;
use Karaden\Exception\ForbiddenException;
use Karaden\Exception\InvalidParamsException;
use Karaden\Exception\NotFoundException;
use Karaden\Exception\TooManyRequestsException;
use Karaden\Exception\UnauthorizedException;
use Karaden\Exception\UnexpectedValueException;
use Karaden\Exception\UnknownErrorException;
use Karaden\Exception\UnprocessableEntityException;

Config::$apiKey = 'PJ-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
Config::$apiVersion = '2023-12-01';
Config::$tenantId = 'xxxxxxxxx-zzzz-yyyy-zzzz-12345678901';

$params = MessageDetailParams::newBuilder()
    ->withId('12345678-aabb-1234-abcd-123456789123')
    ->build();
$requestOptions = Config::asRequestOptions();

try {
    $message = Message::detail($params, $requestOptions);
    var_dump($message);
} catch ( BadRequestException $e ) {
    echo "BadRequestException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( ForbiddenException $e ) {
    echo "ForbiddenException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( InvalidParamsException $e ) {
    echo "InvalidParamsException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( NotFoundException $e ) {
    echo "NotFoundException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( TooManyRequestsException $e ) {
    echo "TooManyRequestsException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( UnauthorizedException $e ) {
    echo "UnauthorizedException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( UnexpectedValueException $e ) {
    echo "UnexpectedValueException" . "が発生しました。" . PHP_EOL;
    echo "[StatusCode]" . PHP_EOL;
    var_dump($e->statusCode);
    echo "[Body]" . PHP_EOL;
    var_dump($e->body);
} catch ( UnknownErrorException $e ) {
    echo "UnknownErrorException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( UnprocessableEntityException $e ) {
    echo "UnprocessableEntityException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( Exception $e ) {
    echo "[Error!]" . PHP_EOL;
    var_dump($e);
}
?>

 

 

SMS送信キャンセル

<?php

include_once "vendor/autoload.php";
use Karaden\Config;
use Karaden\Model\Message;
use Karaden\Param\Message\MessageCancelParams;
use Karaden\Exception\BadRequestException;
use Karaden\Exception\ForbiddenException;
use Karaden\Exception\InvalidParamsException;
use Karaden\Exception\NotFoundException;
use Karaden\Exception\TooManyRequestsException;
use Karaden\Exception\UnauthorizedException;
use Karaden\Exception\UnexpectedValueException;
use Karaden\Exception\UnknownErrorException;
use Karaden\Exception\UnprocessableEntityException;

Config::$apiKey = 'PJ-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx';
Config::$apiVersion = '2023-12-01';
Config::$tenantId = 'xxxxxxxxx-zzzz-yyyy-zzzz-12345678901';

$params = MessageCancelParams::newBuilder()
    ->withId('12345678-aabb-1234-abcd-123456789123')
    ->build();
$requestOptions = Config::asRequestOptions();
try {
    $message = Message::cancel($params, $requestOptions);
    var_dump($message);
} catch ( BadRequestException $e ) {
    echo "BadRequestException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( ForbiddenException $e ) {
    echo "ForbiddenException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( InvalidParamsException $e ) {
    echo "InvalidParamsException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( NotFoundException $e ) {
    echo "NotFoundException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( TooManyRequestsException $e ) {
    echo "TooManyRequestsException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( UnauthorizedException $e ) {
    echo "UnauthorizedException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( UnexpectedValueException $e ) {
    echo "UnexpectedValueException" . "が発生しました。" . PHP_EOL;
    echo "[StatusCode]" . PHP_EOL;
    var_dump($e->statusCode);
    echo "[Body]" . PHP_EOL;
    var_dump($e->body);
} catch ( UnknownErrorException $e ) {
    echo "UnknownErrorException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( UnprocessableEntityException $e ) {
    echo "UnprocessableEntityException" . "が発生しました。" . PHP_EOL;
    var_dump($e->error);
} catch ( Exception $e ) {
    echo "[Error!]" . PHP_EOL;
    var_dump($e);
}
?>

 

 

 

関連記事