SMS送信（BULK） – Karaden SMS API サポート

API基本情報

機能名	SMS送信（BULK）
リクエスト元	ユーザー
リクエスト先	『Karaden SMS API』
リクエスト方式	POST
リクエストContent-Type	application/x-www-form-urlencoded
レスポンスContent-Type	application/json
URL	/api/{tenant_id}/messages/bulks
概要	メッセージを一括送信します。指定された一括送信したいメッセージ（一覧）のCSVファイルに記述されたメッセージを一括送信します。一括送信は受付後に順次実行するため、レスポンスを返した時点では一括送信は完了していません。 ※本APIは、エンタープライズプランにて請求書払いの請求先が紐づくプロジェクトのみご利用可能です。

物理名

論理名

形式

必須
(値が無ければnull)

デフォルト

値

説明

bulk_file_id

ファイルID

string <uuid>

〇

本APIを実行する前に、「SMS送信情報ファイルアップロードURL取得（BULK）」で返却された署名付きURLへリクエスト情報をまとめたSMS情報ファイルのアップロードが必要。

#	物理名	論理名	形式	必須 (値が無ければnull)	デフォルト	値	説明
1	id	BULK MESSAGE ID	string <uuid>	〇	-	-	-
2	object	オブジェクトの型	string	〇	"bulk_message"	"bulk_message"	-
3	status	BULK送信状態	string	〇	-	SMS API共通仕様＞ステータス参照	受付時のステータスのため「処理待ち」を返却。
4	error	エラー情報	Array of objects	-	-	下記エラー情報詳細参照	送信情報ファイルのエラー情報。
5	created_at	受付日時	string <date-time> ISO 8601形式	〇	-	-	『Karaden SMS API』へのSMS送信要求を受付した日時。
6	updated_at	更新日時	string <date-time> ISO 8601形式	〇	-	-	-

#	物理名	論理名	形式	必須	デフォルト	値	説明
1	object	オブジェクトの型	string	〇	"error"	"error"	-
2	code	エラーコード	string	〇	-	SMS API共通仕様＞エラーコード参照	-
3	message	エラーメッセージ	string	〇	-	SMS API共通仕様＞エラーコード参照	-
4	errors	エラー詳細	object	-	-	-	エラーの詳細をエラーが発生したリスト要素、リソースのプロパティ毎に返却。オブジェクトのプロパティ名は、エラーが発生したリソースのプロパティ名。オブジェクトの値は、発生したすべてのエラーメッセージ。（配列）

・パラメータは SMS送信と同じ。

入力条件	署名付きURLにアップロードされたファイル（csv形式）件数上限は10,000件各項目のバリデーション内容は「SMS送信」に従う
ファイル名	フォーマットなし
改行コード	LF又はCR+LF
文字コード	BOM付きUTF-8
入力方法	1行目　　：物理名 2行目以降：値

#	物理名	論理名	形式	必須	デフォルト	値	説明
1	service_id	サービス設定ID	integer	〇	-	-	SMS送信するサービス設定IDを指定。
2	to	送信先番号	string^[0-9]{11}$	〇	-	-	SMS送信する宛先携帯電話番号を指定。
3	body	本文	string	〇	-	-	送信するSMSのメッセージ本文を指定。最大660文字。
4	tags	タグ	string	-	-	-	送信要求毎に利用用途などを識別する内容を指定。
5	is_shorten	短縮URL	boolean	-	-	-	短縮URLの使用有無を指定。指定なしの場合、サービス設定に登録された設定を適用。
6	limited_at	送信限度日時	string <date-time> ISO 8601形式	-	-	-	SMSを送信する限度日時を指定。