メインコンテンツへスキップ
  1. Karaden SMS API サポート
  2. スタートアップガイド
  3. SMS

cURLクイックスタート

  • 更新

はじめに

cURLコマンドを用いて、『Karaden SMS API』へ簡単にアクセスするための具体的な手順をご紹介します。
 
 

cURLコマンドとは

LinuxなどのUNIX系OSでよく利用されるコマンドラインツールの一つで、URLで示されるネットワーク上の場所に対して様々なプロトコル（通信手順）を用いてアクセスできるようにするものです。オープンソースソフトウェアとして公開されており、誰でも利用することが可能です。
今回は、『Karaden SMS API』へアクセスする手段としてご紹介します。
 
 

準備

各OS・ツール毎にcURLコマンドを実行する環境が異なります。
  • Windows10, 11の場合
    • WSL2
      ※コマンドプロンプトやPowerShellでも実行可能ですが、その場合はスクリプトの内容を若干修正する必要が発生します。
  • MacOS, Linuxの場合
    • ターミナル
 
 

使い方

このライブラリを使用するには、『Karaden SMS API』でテナントを作成し、プロジェクト毎に発行できるトークンを発行し、サービスを登録する必要があります。
作成したテナントID（テナントIDはテナント選択画面で表示されています）は、エンドポイントURLに、発行したトークンはヘッダーのAuthorizationに、サービスIDは`service_id`にそれぞれ設定します。
 
curl -L 'https://prg.karaden.jp/api/<テナントID>/messages' \
    -X 'POST' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer <トークン>' \
    -H 'Karaden-Version: 2023-01-01' \
    --data-urlencode 'service_id=<サービスID>' \
    --data-urlencode 'to=09012345678' \
    --data-urlencode 'body=本文' \
    --data-urlencode 'is_shorten=<true/false>' \
    --data-urlencode 'scheduled_at=YYYY-MM-DDThh:mm:00+09:00' \
    --data-urlencode 'limited_at=YYYY-MM-DDThh:mm:00+09:00' \
    --data-urlencode 'tags%5B%5D=タグ1,タグ2' \
    --compressed

 

※本サンプルコードはLinux環境（Windowsの場合はWSL2環境）での実行を想定しています。

※Windows標準のコマンドプロンプトやPowerShellで実行する場合、改行コードが異なる等、コピー＆ペーストでは動作しません。また、PowerShell環境においては、curlではなく、curl.exeの表記を用いてコマンドを始めないと正しく動作しない場合があります。

 

サンプルコード

下記を参照ください。
 

関連記事