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

Ver.2023-01-01

  • 更新

SMS送信（即時送信）

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

Config.apiKey = '<APIキー>';
Config.apiVersion = '2023-01-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 = '2023-01-01'
Config.tenantId = '<テナントID>';

const dt = new Date('<日付>');//書式 -> 2023-08-25T09: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 = '2023-01-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 = '2023-01-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 = '2023-01-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);
    }
});

 

 

関連記事