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

Ver.2024-03-01

SMS送信（即時送信）

require 'karaden'
require 'pp'

request_options = Karaden::RequestOptions.new_builder
.with_api_key('<APIキー>')
.with_api_version('2024-03-01')        
.with_tenant_id('<テナントID>')
.build

params = Karaden::Param::Message::MessageCreateParams.new_builder
.with_service_id(<サービスID>)
.with_to('<電話番号>')
.with_body('<本文>')
.build

begin
    rbmsg = Karaden::Model::Message.create(params, request_options)
    pp rbmsg
rescue Karaden::Exception::BadRequestException => e
    puts "BadRequestExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::ForbiddenException => e
    puts "ForbiddenExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::InvalidParamsException => e
    puts "InvalidParamsExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::InvalidRequestOptionsException => e
    puts "InvalidRequestOptionsExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::NotFoundException => e
    puts "NotFoundExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::TooManyRequestsException => e
    puts "TooManyRequestsExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnauthorizedException => e
    puts "UnauthorizedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnexpectedValueException => e
    puts "UnexpectedValueExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnknownErrorException => e
    puts "UnknownErrorExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnprocessableEntityException => e
    puts "UnprocessableEntityExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Exception => e
    pp e
    pp e.error
end


SMS送信（予約送信）

require 'karaden'
require 'pp'

request_options = Karaden::RequestOptions.new_builder
.with_api_key('<APIキー>')
.with_api_version('2024-03-01')        
.with_tenant_id('<テナントID>')
.build

dt = Time.parse('<送信予約日時>') #日時指定フォーマット -> 2023-08-08T14:00:00+09:00

params = Karaden::Param::Message::MessageCreateParams.new_builder
.with_service_id(<サービスID>)
.with_to('<電話番号>')
.with_body('<本文>')
.with_scheduled_at(dt)
.build

begin
    rbmsg = Karaden::Model::Message.create(params, request_options)
    pp rbmsg
rescue Karaden::Exception::BadRequestException => e
    puts "BadRequestExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::ForbiddenException => e
    puts "ForbiddenExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::InvalidParamsException => e
    puts "InvalidParamsExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::InvalidRequestOptionsException => e
    puts "InvalidRequestOptionsExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::NotFoundException => e
    puts "NotFoundExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::TooManyRequestsException => e
    puts "TooManyRequestsExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnauthorizedException => e
    puts "UnauthorizedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnexpectedValueException => e
    puts "UnexpectedValueExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnknownErrorException => e
    puts "UnknownErrorExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnprocessableEntityException => e
    puts "UnprocessableEntityExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Exception => e
    pp e
    pp e.error
end

 

SMS送信結果取得(一括)

require 'karaden'
require 'pp'

request_options = Karaden::RequestOptions.new_builder
.with_api_key('<APIキー>')
.with_api_version('2024-03-01')        
.with_tenant_id('<テナントID>')
.build

params = Karaden::Param::Message::MessageListParams.new_builder
.with_service_id(<サービスID>)
.with_to('<電話番号>')
.with_status('<絞り込みステータス>')
.build

begin
    rbmsg = Karaden::Model::Message.list(params, request_options)
    pp rbmsg
rescue Karaden::Exception::BadRequestException => e
    puts "BadRequestExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::ForbiddenException => e
    puts "ForbiddenExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::InvalidParamsException => e
    puts "InvalidParamsExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::InvalidRequestOptionsException => e
    puts "InvalidRequestOptionsExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::NotFoundException => e
    puts "NotFoundExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::TooManyRequestsException => e
    puts "TooManyRequestsExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnauthorizedException => e
    puts "UnauthorizedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnexpectedValueException => e
    puts "UnexpectedValueExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnknownErrorException => e
    puts "UnknownErrorExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnprocessableEntityException => e
    puts "UnprocessableEntityExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Exception => e
    pp e
    pp e.error
end

 

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

require 'karaden'
require 'pp'

request_options = Karaden::RequestOptions.new_builder
.with_api_key('<APIキー>')
.with_api_version('2024-03-01')        
.with_tenant_id('<テナントID>')
.build

params = Karaden::Param::Message::MessageDetailParams.new_builder
.with_id('<メッセージID>')
.build

begin
    rbmsg = Karaden::Model::Message.detail(params, request_options)
    pp rbmsg
rescue Karaden::Exception::BadRequestException => e
    puts "BadRequestExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::ForbiddenException => e
    puts "ForbiddenExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::InvalidParamsException => e
    puts "InvalidParamsExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::InvalidRequestOptionsException => e
    puts "InvalidRequestOptionsExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::NotFoundException => e
    puts "NotFoundExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::TooManyRequestsException => e
    puts "TooManyRequestsExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnauthorizedException => e
    puts "UnauthorizedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnexpectedValueException => e
    puts "UnexpectedValueExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnknownErrorException => e
    puts "UnknownErrorExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnprocessableEntityException => e
    puts "UnprocessableEntityExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Exception => e
    pp e
    pp e.error
end

 

SMS送信キャンセル

require 'karaden'
require 'pp'

request_options = Karaden::RequestOptions.new_builder
.with_api_key('<APIキー>')
.with_api_version('2024-03-01')        
.with_tenant_id('<テナントID>')
.build

params = Karaden::Param::Message::MessageCancelParams.new_builder
.with_id('<メッセージID>')
.build

begin
    rbmsg = Karaden::Model::Message.cancel(params, request_options)
    pp rbmsg
rescue Karaden::Exception::BadRequestException => e
    puts "BadRequestExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::ForbiddenException => e
    puts "ForbiddenExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::InvalidParamsException => e
    puts "InvalidParamsExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::InvalidRequestOptionsException => e
    puts "InvalidRequestOptionsExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::NotFoundException => e
    puts "NotFoundExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::TooManyRequestsException => e
    puts "TooManyRequestsExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnauthorizedException => e
    puts "UnauthorizedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnexpectedValueException => e
    puts "UnexpectedValueExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnknownErrorException => e
    puts "UnknownErrorExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnprocessableEntityException => e
    puts "UnprocessableEntityExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Exception => e
    pp e
    pp e.error
end

 

SMS送信(BULK)

require 'karaden'
require 'pp'

request_options = Karaden::RequestOptions.new_builder
.with_api_key('<APIキー>')
.with_api_version('2024-03-01')        
.with_tenant_id('<テナントID>')
.build

begin
    filename = File.join(Dir.pwd, '＜csvファイル＞')
    bulk_message = Karaden::Service::BulkMessageService.create(filename, request_options)    
    pp bulk_message
    print "Karaden::Config::VERSION : "
    print Karaden::Config::VERSION
rescue Karaden::Exception::BadRequestException = e
    puts "BadRequestExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::BulkMessageCreateFailedException = e
    puts "BulkMessageCreateFailedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::BulkMessageListMessageRetryLimitExceedException = e
    puts "BulkMessageListMessageRetryLimitExceedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::BulkMessageShowRetryLimitExceedException = e
    puts "BulkMessageShowRetryLimitExceedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::FileDownloadFailedException = e
    puts "FileDownloadFailedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::FileNotFoundException = e
    puts "FileNotFoundExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::FileUploadFailedException = e
    puts "FileUploadFailedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::ForbiddenException = e
    puts "ForbiddenExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::InvalidParamsException = e
    puts "InvalidParamsExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::InvalidRequestOptionsException = e
    puts "InvalidRequestOptionsExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::NotFoundException = e
    puts "NotFoundExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::TooManyRequestsException = e
    puts "TooManyRequestsExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnauthorizedException = e
    puts "UnauthorizedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnexpectedValueException = e
    puts "UnexpectedValueExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnknownErrorException = e
    puts "UnknownErrorExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnprocessableEntityException = e
    puts "UnprocessableEntityExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::KaradenException = e
    puts "KaradenExceptionが返されました"
    pp e
    pp e.error
rescue Exception = e
    pp e
    pp e.error
end

 

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

require 'karaden'
require 'pp'

request_options = Karaden::RequestOptions.new_builder
.with_api_key('<APIキー>')
.with_api_version('2024-03-01')        
.with_tenant_id('<テナントID>')
.build

params = Karaden::Param::Message::Bulk::BulkMessageDownloadParams
    .new_builder
    .with_id('＜BulkID＞')
    .with_directory_path('＜directory_path＞')
    .with_max_retries(3)
    .with_retry_interval(30)
    .build
begin
    bulk_message = Karaden::Service::BulkMessageService.download(params, request_options)
    pp bulk_message
    print "Karaden::Config::VERSION : "
    print Karaden::Config::VERSION
rescue Karaden::Exception::BadRequestException = e
    puts "BadRequestExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::BulkMessageCreateFailedException = e
    puts "BulkMessageCreateFailedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::BulkMessageListMessageRetryLimitExceedException = e
    puts "BulkMessageListMessageRetryLimitExceedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::BulkMessageShowRetryLimitExceedException = e
    puts "BulkMessageShowRetryLimitExceedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::FileDownloadFailedException = e
    puts "FileDownloadFailedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::FileNotFoundException = e
    puts "FileNotFoundExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::FileUploadFailedException = e
    puts "FileUploadFailedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::ForbiddenException = e
    puts "ForbiddenExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::InvalidParamsException = e
    puts "InvalidParamsExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::InvalidRequestOptionsException = e
    puts "InvalidRequestOptionsExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::NotFoundException = e
    puts "NotFoundExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::TooManyRequestsException = e
    puts "TooManyRequestsExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnauthorizedException = e
    puts "UnauthorizedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnexpectedValueException = e
    puts "UnexpectedValueExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnknownErrorException = e
    puts "UnknownErrorExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnprocessableEntityException = e
    puts "UnprocessableEntityExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::KaradenException = e
    puts "KaradenExceptionが返されました"
    pp e
    pp e.error
rescue Exception = e
    pp e
    pp e.error
end

 

SMS送信状態取得(BULK)

require 'karaden'
require 'pp'

request_options = Karaden::RequestOptions.new_builder
.with_api_key('<APIキー>')
.with_api_version('2024-03-01')        
.with_tenant_id('<テナントID>')
.build

params = Karaden::Param::Message::Bulk::BulkMessageShowParams
    .new_builder
    .with_id('＜BulkID＞')
    .build
begin
    bulk_message = Karaden::Model::BulkMessage.show(params, request_options)
    pp bulk_message
    print "Karaden::Config::VERSION : "
    print Karaden::Config::VERSION
rescue Karaden::Exception::BadRequestException = e
    puts "BadRequestExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::BulkMessageCreateFailedException = e
    puts "BulkMessageCreateFailedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::BulkMessageListMessageRetryLimitExceedException = e
    puts "BulkMessageListMessageRetryLimitExceedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::BulkMessageShowRetryLimitExceedException = e
    puts "BulkMessageShowRetryLimitExceedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::FileDownloadFailedException = e
    puts "FileDownloadFailedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::FileNotFoundException = e
    puts "FileNotFoundExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::FileUploadFailedException = e
    puts "FileUploadFailedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::ForbiddenException = e
    puts "ForbiddenExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::InvalidParamsException = e
    puts "InvalidParamsExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::InvalidRequestOptionsException = e
    puts "InvalidRequestOptionsExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::NotFoundException = e
    puts "NotFoundExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::TooManyRequestsException = e
    puts "TooManyRequestsExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnauthorizedException = e
    puts "UnauthorizedExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnexpectedValueException = e
    puts "UnexpectedValueExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnknownErrorException = e
    puts "UnknownErrorExceptionが返されました"
    pp e
    pp e.error
rescue Karaden::Exception::UnprocessableEntityException = e
    puts "UnprocessableEntityExceptionが返されました"
    error_obj = e.error
    error_object = error_obj.errors
    if error_object then
        pp error_object
    end
rescue Karaden::Exception::KaradenException = e
    puts "KaradenExceptionが返されました"
    pp e
    pp e.error
rescue Exception = e
    pp e
    pp e.error
end

 

関連記事