メインコンテンツまでスキップ

配信リストアップロード

POST 

/engage/v1/sms_delivery/delivery_list

顧客データの CSV をアップロードします。配信をスケジュールする前に必要です。

アップロードは非同期に処理されます。レスポンスの upload_id を使って GET /engage/v1/sms_delivery/delivery_list で処理状況を確認してください。

レート制限: 2 req/秒

1 リクエストで投入できる宛先の件数に上限はありません。CSV のサイズ上限は 512 MB です。1 リクエストにまとめられる件数が大きいぶん、リクエスト数の上限を他のエンドポイントより低くしています。

CSV のフォーマット

  • 文字エンコーディングは UTF-8。BOM は付けない
  • 先頭行はヘッダ行とする
  • phone_numbercountry_dial_code の 2 項目は必須
    • CSV 内のカラム位置は任意(カラム名から判別)だが、先頭 2 カラムに配置することを推奨
  • 3 カラム目以降は任意。定義することでメッセージ内で変数として利用できる
  • 同一ファイル内での電話番号形式の混在可

phone_number

  • 国内電話番号、国際電話番号 (E.164) の両方の形式をサポート
  • 国内電話番号を指定する場合は country_dial_code の指定必須
  • 国際電話番号を指定する場合は country_dial_code を省略可(空の値を指定。カラム自体は必要)
    • 現時点では +81 で始まる番号(日本向け)以外は非対応
  • + と半角数字 (0-9) の他、半角スペース ( )、半角ハイフン (-)、半角丸括弧 (()) を含むことができる
    • 配信レポート API では、指定された値がそのまま返却される
  • 全角文字使用不可

country_dial_code

  • 現時点では +81(日本向け。phone_number に国内電話番号を指定した場合)か、空(phone_number に国際電話番号を指定した場合)のみをサポート
  • phone_number を国際電話番号形式で指定した場合、country_dial_code の値は無視される
  • 配信レポート API では、指定された値がそのまま返却される
  • + および半角数字 (0-9) のみ使用可
  • 全角文字使用不可

下記の例に含まれる X は任意の数字 1 桁を表すプレースホルダです。実際には半角数字を指定してください。

phone_number,country_dial_code,name,url
090XXXXXXX1,+81,山田太郎,https://example.com/client_id=1
090XXXXXXX2,+81,山田一郎,https://example.com/client_id=2
+8190XXXXXXX3,,田中二郎,https://example.com/client_id=3
090-XXXX-XXX4,+81,佐藤三郎,https://example.com/client_id=4
+81 80 XXXX XXX5,,鈴木四郎,https://example.com/client_id=5
080 (XXXX) XXX6,+81,佐々木五郎,https://example.com/client_id=6

Request

Responses

アップロードを受け付けた