Skip to main content

​
ベースURL

https://api.utage-system.com/v1

​
リクエスト形式

  • HTTPメソッド: GET, POST, PATCH, PUT, DELETE
  • Content-Type: application/json
  • 文字コード: UTF-8
  • 認証: Authorization: Bearer {api_key}
更新系エンドポイントの正規メソッドは PATCH です。PUT は後方互換のために利用できます。
リクエスト例
curl -X POST "https://api.utage-system.com/v1/funnels" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "新しいファネル"}'

​
レスポンス形式

​
成功時

単一リソースの場合: 
{
    "data": {
        "id": "fn_abc123",
        "name": "ファネル名"
    }
}
リスト取得の場合: 
{
    "data": [
        {
            "id": "fn_abc123",
            "name": "ファネル1"
        },
        {
            "id": "fn_def456",
            "name": "ファネル2"
        }
    ],
    "meta": {
        "current_page": 1,
        "per_page": 20,
        "total": 42
    }
}

​
エラー時

{
    "error": {
        "code": "validation_error",
        "message": "ファネル名は必須です"
    }
}

​
ページネーション

一覧取得APIはページネーションに対応しています。クエリパラメータで制御できます。
パラメータ説明デフォルト
pageページ番号1
per_page1ページあたりの件数（最大100）20
レスポンスの meta オブジェクトにページネーション情報が含まれます。
フィールド説明
current_page現在のページ番号
per_page1ページあたりの件数
total全件数

​
エンドポイント一覧

主要エンドポイントの抜粋です。全エンドポイントは左メニューの各カテゴリを参照してください。

​
ファネル

メソッドエンドポイント説明
GET/funnelsファネル一覧
POST/funnelsファネル作成
PATCH/funnels/{funnel_id}ファネル更新

​
ステップ

メソッドエンドポイント説明
GET/funnels/{funnel_id}/stepsステップ一覧
POST/funnels/{funnel_id}/stepsステップ作成
PATCH/funnels/{funnel_id}/steps/{step_id}ステップ更新
PATCH/funnels/{funnel_id}/steps/reorderステップ並び替え

​
ページ

メソッドエンドポイント説明
GET/funnels/{funnel_id}/steps/{step_id}/pagesページ一覧
POST/funnels/{funnel_id}/steps/{step_id}/pagesページ作成
GET/funnels/{funnel_id}/steps/{step_id}/pages/{page_id}ページ取得
PATCH/funnels/{funnel_id}/steps/{step_id}/pages/{page_id}ページ更新
DELETE/funnels/{funnel_id}/steps/{step_id}/pages/{page_id}ページ削除

​
配信アカウント

メソッドエンドポイント説明
GET/accountsアカウント一覧
POST/accountsアカウント作成
GET/accounts/{account_id}/scenariosシナリオ一覧
POST/accounts/{account_id}/scenariosシナリオ作成

​
メディア

メソッドエンドポイント説明
GET/media/videos動画一覧
GET/media/videos/folders動画フォルダ一覧
GET/media/audios音声一覧
GET/media/audios/folders音声フォルダ一覧

​
要素タイプ

メソッドエンドポイント説明
GET/element-types/funnel要素タイプ一覧
GET/element-types/funnel/properties要素プロパティ取得

​
HTTPステータスコード

コード説明
200リクエスト成功
201リソース作成成功
400リクエスト不正（SMS設定不備、content_type変更不可、不正なファイルタイプなど）
401認証エラー（APIキーが無効または未指定）
403権限エラー（アクセス権がないリソース）
404リソースが見つからない
409競合（送信中メッセージの更新・削除、重複登録など）
422バリデーションエラー（リクエストパラメータの入力不備）
429レート制限超過

​
エラーコード

コード説明
unauthorizedAPIキーが無効または未指定
forbiddenリソースへのアクセス権がない
not_found指定されたリソースが存在しない
validation_errorリクエストパラメータのバリデーションエラー
conflictリソースの状態が競合（送信中メッセージの更新・削除、重複登録など）
rate_limit_exceededレート制限を超過した