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

Ver.2024-03-01

SMS送信（即時送信）

const { Config, MessageCreateParams, Message } = require('karaden-prg-node');

Config.apiKey = '<APIキー>';
Config.apiVersion = '2024-03-01'
Config.tenantId = '<テナントID>';

const params = MessageCreateParams.newBuilder()
    .withServiceId(<サービスID>)
    .withTo('<電話番号>')
    .withBody('<本文>')
    .build();

Message.create(params)
.then(result=>{
    console.log(result);
})
.catch(e=>{
    if(e.name == "BadRequestException"){
        console.error("BadRequestExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "ForbiddenException"){
        console.error("ForbiddenExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "InvalidParamsException"){
        console.error("InvalidParamsExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "InvalidRequestOptionsException"){
        console.error("InvalidRequestOptionsExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "NotFoundException"){
        console.error("NotFoundExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "TooManyRequestsException"){
        console.error("TooManyRequestsExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnauthorizedException"){
        console.error("UnauthorizedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnexpectedValueException"){
        console.error("UnexpectedValueExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnknownErrorException"){
        console.error("UnknownErrorExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnprocessableEntityException"){
        console.error("UnprocessableEntityExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else {
        console.error("Errorが返されました");
        console.error(e);
    }
});


SMS送信（予約送信）

const { Config, MessageCreateParams, Message } = require('karaden-prg-node');

Config.apiKey = '<APIキー>';
Config.apiVersion = '2024-03-01'
Config.tenantId = '<テナントID>';

const dt = new Date('<日付>');//書式 -> 2024-04-01T09:30:00+09:00

const params = MessageCreateParams.newBuilder()
    .withServiceId(<サービスID>)
    .withTo('<電話番号>')
    .withBody('<本文>')
    .withScheduledAt(dt)
    .build();

Message.create(params)
.then(result=>{
    console.log(result);
})
.catch(e=>{
    if(e.name == "BadRequestException"){
        console.error("BadRequestExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "ForbiddenException"){
        console.error("ForbiddenExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "InvalidParamsException"){
        console.error("InvalidParamsExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "InvalidRequestOptionsException"){
        console.error("InvalidRequestOptionsExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "NotFoundException"){
        console.error("NotFoundExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "TooManyRequestsException"){
        console.error("TooManyRequestsExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnauthorizedException"){
        console.error("UnauthorizedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnexpectedValueException"){
        console.error("UnexpectedValueExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnknownErrorException"){
        console.error("UnknownErrorExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnprocessableEntityException"){
        console.error("UnprocessableEntityExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else {
        console.error("Errorが返されました");
        console.error(e);
    }
});

 

SMS送信結果取得(一括)

const { Config, MessageListParams, Message } = require('karaden-prg-node');

Config.apiKey = '<APIキー>';
Config.apiVersion = '2024-03-01'
Config.tenantId = '<テナントID>';

//const dt = new Date('<日付>');//書式 -> 2023-08-20T09:30:00+09:00

const params = MessageListParams.newBuilder()
    .withServiceId(<サービスID>)
    .withTo('<電話番号>')
    //.withStartAt(dt)
    .build();

Message.list(params)
.then(result=>{
    console.log(result.properties.data);
})
.catch(e=>{
    if(e.name == "BadRequestException"){
        console.error("BadRequestExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "ForbiddenException"){
        console.error("ForbiddenExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "InvalidParamsException"){
        console.error("InvalidParamsExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "InvalidRequestOptionsException"){
        console.error("InvalidRequestOptionsExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "NotFoundException"){
        console.error("NotFoundExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "TooManyRequestsException"){
        console.error("TooManyRequestsExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnauthorizedException"){
        console.error("UnauthorizedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnexpectedValueException"){
        console.error("UnexpectedValueExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnknownErrorException"){
        console.error("UnknownErrorExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnprocessableEntityException"){
        console.error("UnprocessableEntityExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else {
        console.error("Errorが返されました");
        console.error(e);
    }
});

 

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

const { Config, MessageDetailParams, Message } = require('karaden-prg-node');

Config.apiKey = '<APIキー>';
Config.apiVersion = '2024-03-01'
Config.tenantId = '<テナントID>';


const params = MessageDetailParams.newBuilder()
    .withId('<メッセージID>')
    .build();

Message.detail(params)
.then(result=>{
    console.log(result);
})
.catch(e=>{
    if(e.name == "BadRequestException"){
        console.error("BadRequestExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "ForbiddenException"){
        console.error("ForbiddenExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "InvalidParamsException"){
        console.error("InvalidParamsExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "InvalidRequestOptionsException"){
        console.error("InvalidRequestOptionsExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "NotFoundException"){
        console.error("NotFoundExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "TooManyRequestsException"){
        console.error("TooManyRequestsExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnauthorizedException"){
        console.error("UnauthorizedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnexpectedValueException"){
        console.error("UnexpectedValueExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnknownErrorException"){
        console.error("UnknownErrorExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnprocessableEntityException"){
        console.error("UnprocessableEntityExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else {
        console.error("Errorが返されました");
        console.error(e);
    }
});

 

SMS送信キャンセル

const { Config, MessageCancelParams, Message } = require('karaden-prg-node');

Config.apiKey = '<APIキー>';
Config.apiVersion = '2024-03-01'
Config.tenantId = '<テナントID>';


const params = MessageCancelParams.newBuilder()
    .withId('<メッセージID>')
    .build();

Message.cancel(params)
.then(result=>{
    console.log(result);
})
.catch(e=>{
    if(e.name == "BadRequestException"){
        console.error("BadRequestExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "ForbiddenException"){
        console.error("ForbiddenExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "InvalidParamsException"){
        console.error("InvalidParamsExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "InvalidRequestOptionsException"){
        console.error("InvalidRequestOptionsExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "NotFoundException"){
        console.error("NotFoundExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "TooManyRequestsException"){
        console.error("TooManyRequestsExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnauthorizedException"){
        console.error("UnauthorizedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnexpectedValueException"){
        console.error("UnexpectedValueExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnknownErrorException"){
        console.error("UnknownErrorExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnprocessableEntityException"){
        console.error("UnprocessableEntityExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else {
        console.error("Errorが返されました");
        console.error(e);
    }
});

 

SMS送信(BULK)

const path = require('path');
const { Config, BulkMessageService } = require('karaden-prg-node');

Config.apiKey = '<APIキー>';
Config.apiVersion = '2024-03-01'
Config.tenantId = '<テナントID>';

const requestOptions = Config.asRequestOptions();
const filename = path.join(__dirname, '＜csvファイル＞');
const bulkMessage = BulkMessageService.create(filename, requestOptions)
.then(result={
    console.log(result);
    console.log("VERSION: " + Config.VERSION);
})
.catch(e={
    if(e.name == "BadRequestException"){
        console.error("BadRequestExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "BulkMessageCreateFailedException"){
        console.error("BulkMessageCreateFailedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "BulkMessageListMessageRetryLimitExceedException"){
        console.error("BulkMessageListMessageRetryLimitExceedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "BulkMessageShowRetryLimitExceedException"){
        console.error("BulkMessageShowRetryLimitExceedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "FileDownloadFailedException"){
        console.error("FileDownloadFailedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "FileNotFoundException"){
        console.error("FileNotFoundExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "FileUploadFailedException"){
        console.error("FileUploadFailedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "ForbiddenException"){
        console.error("ForbiddenExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "InvalidParamsException"){
        console.error("InvalidParamsExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "InvalidRequestOptionsException"){
        console.error("InvalidRequestOptionsExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "NotFoundException"){
        console.error("NotFoundExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "NotImplementationException"){
        console.error("NotImplementationExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "TooManyRequestsException"){
        console.error("TooManyRequestsExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnauthorizedException"){
        console.error("UnauthorizedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnexpectedValueException"){
        console.error("UnexpectedValueExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnknownErrorException"){
        console.error("UnknownErrorExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnprocessableEntityException"){
        console.error("UnprocessableEntityExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "KaradenException"){
        console.error("KaradenExceptionが返されました");
        console.error(e.error);
    } else {
        console.error("Errorが返されました");
        console.error(e);
    }
});

 

SMS送信結果ファイル取得(BULK)

const path = require('path');
const { Config, BulkMessageDownloadParams, BulkMessageService } = require('karaden-prg-node');

Config.apiKey = '<APIキー>';
Config.apiVersion = '2024-03-01'
Config.tenantId = '<テナントID>';

const params = BulkMessageDownloadParams
    .newBuilder()
    .withId('＜BulkID＞')
    .withDirectoryPath('＜DirectoryPath＞')
    .withMaxRetries(3)
    .withRetryInterval(30)
    .build();

const requestOptions = Config.asRequestOptions();
BulkMessageService.download(params, requestOptions)
.then(result={
    console.log(result);
    console.log("VERSION: " + Config.VERSION);
})
.catch(e={
    if(e.name == "BadRequestException"){
        console.error("BadRequestExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "BulkMessageCreateFailedException"){
        console.error("BulkMessageCreateFailedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "BulkMessageListMessageRetryLimitExceedException"){
        console.error("BulkMessageListMessageRetryLimitExceedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "BulkMessageShowRetryLimitExceedException"){
        console.error("BulkMessageShowRetryLimitExceedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "FileDownloadFailedException"){
        console.error("FileDownloadFailedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "FileNotFoundException"){
        console.error("FileNotFoundExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "FileUploadFailedException"){
        console.error("FileUploadFailedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "ForbiddenException"){
        console.error("ForbiddenExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "InvalidParamsException"){
        console.error("InvalidParamsExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "InvalidRequestOptionsException"){
        console.error("InvalidRequestOptionsExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "NotFoundException"){
        console.error("NotFoundExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "NotImplementationException"){
        console.error("NotImplementationExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "TooManyRequestsException"){
        console.error("TooManyRequestsExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnauthorizedException"){
        console.error("UnauthorizedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnexpectedValueException"){
        console.error("UnexpectedValueExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnknownErrorException"){
        console.error("UnknownErrorExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnprocessableEntityException"){
        console.error("UnprocessableEntityExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "KaradenException"){
        console.error("KaradenExceptionが返されました");
        console.error(e.error);
    } else {
        console.error("Errorが返されました");
        console.error(e);
    }
});

 

SMS送信状態取得(BULK)

const path = require('path');
const { Config, BulkMessageShowParams, BulkMessage } = require('karaden-prg-node');

Config.apiKey = '<APIキー>';
Config.apiVersion = '2024-03-01'
Config.tenantId = '<テナントID>';

const params = BulkMessageShowParams
    .newBuilder()
    .withId('＜BulkID＞')
    .build();

const requestOptions = Config.asRequestOptions();
const bulkMessage = BulkMessage.show(params, requestOptions)
.then(result={
    console.log(result);
    if(result.error != undefined){
        console.log("-------------------");
        console.log(result.error);
        if(result.error.errors != undefined){
            console.log("-------------------");
            console.log(result.error.errors);
        }
    }
    console.log("VERSION: " + Config.VERSION);
})
.catch(e={
    if(e.name == "BadRequestException"){
        console.error("BadRequestExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "BulkMessageCreateFailedException"){
        console.error("BulkMessageCreateFailedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "BulkMessageListMessageRetryLimitExceedException"){
        console.error("BulkMessageListMessageRetryLimitExceedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "BulkMessageShowRetryLimitExceedException"){
        console.error("BulkMessageShowRetryLimitExceedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "FileDownloadFailedException"){
        console.error("FileDownloadFailedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "FileNotFoundException"){
        console.error("FileNotFoundExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "FileUploadFailedException"){
        console.error("FileUploadFailedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "ForbiddenException"){
        console.error("ForbiddenExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "InvalidParamsException"){
        console.error("InvalidParamsExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "InvalidRequestOptionsException"){
        console.error("InvalidRequestOptionsExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "NotFoundException"){
        console.error("NotFoundExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "NotImplementationException"){
        console.error("NotImplementationExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "TooManyRequestsException"){
        console.error("TooManyRequestsExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnauthorizedException"){
        console.error("UnauthorizedExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnexpectedValueException"){
        console.error("UnexpectedValueExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnknownErrorException"){
        console.error("UnknownErrorExceptionが返されました");
        console.error(e.error);
    } else if(e.name == "UnprocessableEntityException"){
        console.error("UnprocessableEntityExceptionが返されました");
        console.error(e.error);
        console.error(e.error.properties.errors.properties);
    } else if(e.name == "KaradenException"){
        console.error("KaradenExceptionが返されました");
        console.error(e.error);
    } else {
        console.error("Errorが返されました");
        console.error(e);
    }
});

 

 

関連記事