ベースURL
https://api.utage-system.com/v1
リクエスト形式
- HTTPメソッド:
GET,POST,PATCH,DELETE(PUTは下記の4エンドポイントのみ) - Content-Type:
application/json - 文字コード: UTF-8
- 認証:
Authorization: Bearer {api_key}
更新系エンドポイントの正規メソッドは
PATCH です。PUT が使えるのは後方互換のために残している次の4つだけで、それ以外の更新系エンドポイントに PUT で送ると 405(Laravel標準の形式。エラーレスポンスの形式を参照)になります。PUT /funnels/{funnel_id}(ファネル更新)PUT /funnels/{funnel_id}/steps/{step_id}(ステップ更新)PUT /funnels/{funnel_id}/steps/reorder(ステップ並び替え)PUT /funnels/{funnel_id}/steps/{step_id}/pages/{page_id}(ページ更新)
リクエスト例
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": "ファネル名は必須です"
}
}
error.details に補足情報が含まれます。詳細はエラーハンドリングを参照してください。
ページネーション
一覧取得APIはページネーションに対応しています。クエリパラメータで制御できます。| パラメータ | 説明 | デフォルト |
|---|---|---|
page | ページ番号 | 1 |
per_page | 1ページあたりの件数(最大100) | 20 |
meta オブジェクトにページネーション情報が含まれます。
| フィールド | 説明 |
|---|---|
current_page | 現在のページ番号 |
per_page | 1ページあたりの件数 |
total | 全件数 |
エンドポイント一覧
全261エンドポイントを管理画面の機能ごとに示します。「説明」のリンク先に各エンドポイントの仕様があります。ファネル
ファネル
ステップ
ページ
| メソッド | エンドポイント | 説明 |
|---|---|---|
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 | /funnels/{funnel_id}/stats | ファネル全体データ取得 |
GET | /funnels/{funnel_id}/stats/daily | ファネル日ごとデータ取得 |
GET | /funnels/{funnel_id}/subscribers | ファネル登録者一覧取得 |
登録経路
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /funnels/{funnel_id}/trackings | ファネル登録経路一覧取得 |
POST | /funnels/{funnel_id}/trackings | ファネル登録経路作成 |
GET | /funnels/{funnel_id}/trackings/stats | ファネル登録経路別集計取得 |
GET | /funnels/{funnel_id}/trackings/{tracking_id} | ファネル登録経路詳細取得 |
PATCH | /funnels/{funnel_id}/trackings/{tracking_id} | ファネル登録経路更新 |
DELETE | /funnels/{funnel_id}/trackings/{tracking_id} | ファネル登録経路削除 |
GET | /funnels/{funnel_id}/tracking-groups | ファネル登録経路グループ一覧取得 |
POST | /funnels/{funnel_id}/tracking-groups | ファネル登録経路グループ作成 |
GET | /funnels/{funnel_id}/tracking-groups/{tracking_group_id} | ファネル登録経路グループ詳細取得 |
PATCH | /funnels/{funnel_id}/tracking-groups/{tracking_group_id} | ファネル登録経路グループ更新 |
DELETE | /funnels/{funnel_id}/tracking-groups/{tracking_group_id} | ファネル登録経路グループ削除 |
ファネルアクション
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /funnel-actions | ファネルアクション一覧取得 |
POST | /funnel-actions | ファネルアクション作成 |
GET | /funnel-actions/{action_id} | ファネルアクション詳細取得 |
PATCH | /funnel-actions/{action_id} | ファネルアクション更新 |
DELETE | /funnel-actions/{action_id} | ファネルアクション削除 |
GET | /funnel-action-groups | ファネルアクショングループ一覧取得 |
配信
アカウント・シナリオ
メッセージ
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /accounts/{account_id}/scenarios/{scenario_id}/messages | 配信メッセージ一覧 |
POST | /accounts/{account_id}/scenarios/{scenario_id}/messages | 配信メッセージ作成 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/messages/stats | シナリオ別配信統計一覧 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/messages/{message_id} | 配信メッセージ詳細取得 |
PATCH | /accounts/{account_id}/scenarios/{scenario_id}/messages/{message_id} | 配信メッセージ更新 |
DELETE | /accounts/{account_id}/scenarios/{scenario_id}/messages/{message_id} | 配信メッセージ削除 |
POST | /accounts/{account_id}/scenarios/{scenario_id}/messages/{message_id}/test-send | 配信メッセージ テスト送信 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/messages/{message_id}/stats | メッセージ別配信統計 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/placeholders | 置き換え文字一覧 |
読者
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /accounts/{account_id}/readers | 全読者一覧 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/readers | シナリオ内読者一覧 |
POST | /accounts/{account_id}/scenarios/{scenario_id}/readers | 読者作成 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/readers/tracking-summary | 読者登録経路サマリ |
GET | /accounts/{account_id}/scenarios/{scenario_id}/readers/{reader_id} | 読者詳細取得 |
PATCH | /accounts/{account_id}/scenarios/{scenario_id}/readers/{reader_id} | 読者更新 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/readers/{reader_id}/labels | 読者ラベル一覧 |
POST | /accounts/{account_id}/scenarios/{scenario_id}/readers/{reader_id}/labels | 読者ラベル付与 |
DELETE | /accounts/{account_id}/scenarios/{scenario_id}/readers/{reader_id}/labels/{label_id} | 読者ラベル解除 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/readers/{reader_id}/scenarios | 読者の登録シナリオ一覧 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/readers/{reader_id}/queues | 読者の配信予約一覧 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/readers/{reader_id}/sent | 読者の配信済一覧 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/readers/{reader_id}/opens | 読者のメール開封履歴 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/readers/{reader_id}/clicks | 読者のクリック履歴 |
登録フォーム・読者項目
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /accounts/{account_id}/scenarios/{scenario_id}/reader-items | 読者項目一覧 |
POST | /accounts/{account_id}/scenarios/{scenario_id}/reader-items | 読者項目作成 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/reader-items/{reader_item_id} | 読者項目詳細取得 |
PATCH | /accounts/{account_id}/scenarios/{scenario_id}/reader-items/{reader_item_id} | 読者項目更新 |
DELETE | /accounts/{account_id}/scenarios/{scenario_id}/reader-items/{reader_item_id} | 読者項目削除 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/form-items | 登録フォーム項目一覧 |
POST | /accounts/{account_id}/scenarios/{scenario_id}/form-items | 登録フォーム項目作成 |
POST | /accounts/{account_id}/scenarios/{scenario_id}/form-items/bulk | 登録フォーム項目一括作成 |
PATCH | /accounts/{account_id}/scenarios/{scenario_id}/form-items/reorder | 登録フォーム項目並び替え |
GET | /accounts/{account_id}/scenarios/{scenario_id}/form-items/{form_item_id} | 登録フォーム項目詳細取得 |
PATCH | /accounts/{account_id}/scenarios/{scenario_id}/form-items/{form_item_id} | 登録フォーム項目更新 |
DELETE | /accounts/{account_id}/scenarios/{scenario_id}/form-items/{form_item_id} | 登録フォーム項目削除 |
LINE友だち・1対1チャット
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /accounts/{account_id}/line/friends | LINE友だち一覧取得 |
GET | /accounts/{account_id}/line/friends/{friend_id} | LINE友だち詳細取得 |
PATCH | /accounts/{account_id}/line/friends/{friend_id} | LINE友だち更新 |
PATCH | /accounts/{account_id}/line/friends/{friend_id}/menu | LINE友だちリッチメニュー切替 |
POST | /accounts/{account_id}/line/friends/{friend_id}/readers | LINE友だちをシナリオ登録 |
POST | /accounts/{account_id}/line/friends/{friend_id}/messages | LINE 1対1チャット送信 |
GET | /accounts/{account_id}/line/friends/{friend_id}/messages | LINE 1対1チャット履歴取得 |
PATCH | /accounts/{account_id}/line/friends/{friend_id}/messages/mark-as-read | LINE 1対1チャット既読化 |
LINEカスタム送信者
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /accounts/{account_id}/line/senders | LINEカスタム送信者一覧取得 |
POST | /accounts/{account_id}/line/senders | LINEカスタム送信者作成 |
GET | /accounts/{account_id}/line/senders/{sender_id} | LINEカスタム送信者詳細取得 |
PATCH | /accounts/{account_id}/line/senders/{sender_id} | LINEカスタム送信者更新 |
DELETE | /accounts/{account_id}/line/senders/{sender_id} | LINEカスタム送信者削除 |
LINEテンプレート
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /accounts/{account_id}/line/templates | LINEテンプレート一覧取得 |
POST | /accounts/{account_id}/line/templates | LINEテンプレート作成 |
PATCH | /accounts/{account_id}/line/templates/reorder | LINEテンプレート並び替え |
GET | /accounts/{account_id}/line/templates/{template_id} | LINEテンプレート詳細取得 |
PATCH | /accounts/{account_id}/line/templates/{template_id} | LINEテンプレート更新 |
DELETE | /accounts/{account_id}/line/templates/{template_id} | LINEテンプレート削除 |
GET | /accounts/{account_id}/line/template-groups | LINEテンプレートグループ一覧取得 |
POST | /accounts/{account_id}/line/template-groups | LINEテンプレートグループ作成 |
GET | /accounts/{account_id}/line/template-groups/{template_group_id} | LINEテンプレートグループ詳細取得 |
PATCH | /accounts/{account_id}/line/template-groups/{template_group_id} | LINEテンプレートグループ更新 |
DELETE | /accounts/{account_id}/line/template-groups/{template_group_id} | LINEテンプレートグループ削除 |
LINEリッチメニュー
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /accounts/{account_id}/line/richmenus | LINEリッチメニュー一覧取得 |
GET | /accounts/{account_id}/line/richmenu-groups | LINEリッチメニューグループ一覧取得 |
POST | /accounts/{account_id}/line/richmenu-groups | LINEリッチメニューグループ作成 |
GET | /accounts/{account_id}/line/richmenu-groups/{richmenu_group_id} | LINEリッチメニューグループ詳細取得 |
PATCH | /accounts/{account_id}/line/richmenu-groups/{richmenu_group_id} | LINEリッチメニューグループ更新 |
DELETE | /accounts/{account_id}/line/richmenu-groups/{richmenu_group_id} | LINEリッチメニューグループ削除 |
LINE自動応答
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /accounts/{account_id}/line/autoreplies | LINE自動応答一覧取得 |
POST | /accounts/{account_id}/line/autoreplies | LINE自動応答作成 |
GET | /accounts/{account_id}/line/autoreplies/{autoreply_id} | LINE自動応答詳細取得 |
PATCH | /accounts/{account_id}/line/autoreplies/{autoreply_id} | LINE自動応答更新 |
DELETE | /accounts/{account_id}/line/autoreplies/{autoreply_id} | LINE自動応答削除 |
GET | /accounts/{account_id}/line/autoreply-groups | LINE自動応答グループ一覧取得 |
ラベル・共通読者
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /accounts/{account_id}/labels | ラベル一覧 |
POST | /accounts/{account_id}/labels | ラベル作成 |
GET | /accounts/{account_id}/labels/{label_id} | ラベル詳細取得 |
PATCH | /accounts/{account_id}/labels/{label_id} | ラベル更新 |
DELETE | /accounts/{account_id}/labels/{label_id} | ラベル削除 |
GET | /accounts/{account_id}/common-readers/{common_reader_id} | 共通読者詳細取得 |
PATCH | /accounts/{account_id}/common-readers/{common_reader_id} | 共通読者更新 |
GET | /accounts/{account_id}/common-readers/{common_reader_id}/scenarios | 共通読者の登録シナリオ一覧 |
GET | /accounts/{account_id}/common-readers/{common_reader_id}/labels | 共通読者のラベル一覧 |
POST | /accounts/{account_id}/common-readers/{common_reader_id}/labels | 共通読者へラベル付与 |
DELETE | /accounts/{account_id}/common-readers/{common_reader_id}/labels/{label_id} | 共通読者のラベル解除 |
アクション
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /accounts/{account_id}/actions | アクション一覧 |
POST | /accounts/{account_id}/actions | アクション作成 |
GET | /accounts/{account_id}/actions/{action_id} | アクション詳細取得 |
PATCH | /accounts/{account_id}/actions/{action_id} | アクション更新 |
DELETE | /accounts/{account_id}/actions/{action_id} | アクション削除 |
GET | /accounts/{account_id}/action-groups | アクショングループ一覧 |
登録経路
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /accounts/{account_id}/scenarios/{scenario_id}/trackings | 登録経路一覧 |
POST | /accounts/{account_id}/scenarios/{scenario_id}/trackings | 登録経路作成 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/trackings/stats | 登録経路分析 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/trackings/{tracking_id} | 登録経路詳細取得 |
PATCH | /accounts/{account_id}/scenarios/{scenario_id}/trackings/{tracking_id} | 登録経路更新 |
DELETE | /accounts/{account_id}/scenarios/{scenario_id}/trackings/{tracking_id} | 登録経路削除 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/tracking-groups | 登録経路グループ一覧 |
POST | /accounts/{account_id}/scenarios/{scenario_id}/tracking-groups | 登録経路グループ作成 |
GET | /accounts/{account_id}/scenarios/{scenario_id}/tracking-groups/{tracking_group_id} | 登録経路グループ詳細取得 |
PATCH | /accounts/{account_id}/scenarios/{scenario_id}/tracking-groups/{tracking_group_id} | 登録経路グループ更新 |
DELETE | /accounts/{account_id}/scenarios/{scenario_id}/tracking-groups/{tracking_group_id} | 登録経路グループ削除 |
会員サイト
サイト
コース
コースグループ
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /members/{site_id}/course-groups | コースグループ一覧取得 |
POST | /members/{site_id}/course-groups | コースグループ作成 |
GET | /members/{site_id}/course-groups/{course_group_id} | コースグループ取得 |
PATCH | /members/{site_id}/course-groups/{course_group_id} | コースグループ更新 |
DELETE | /members/{site_id}/course-groups/{course_group_id} | コースグループ削除 |
バンドル
レッスン
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /members/{site_id}/courses/{course_id}/lesson-groups | レッスングループ一覧取得 |
GET | /members/{site_id}/courses/{course_id}/lessons | レッスン一覧取得 |
POST | /members/{site_id}/courses/{course_id}/lessons | レッスン作成 |
PATCH | /members/{site_id}/courses/{course_id}/lessons/reorder | レッスン並び替え |
GET | /members/{site_id}/courses/{course_id}/lessons/{lesson_id} | レッスン詳細取得 |
PATCH | /members/{site_id}/courses/{course_id}/lessons/{lesson_id} | レッスン更新 |
DELETE | /members/{site_id}/courses/{course_id}/lessons/{lesson_id} | レッスン削除 |
GET | /members/{site_id}/courses/{course_id}/lesson-stats | レッスンごと受講状況取得 |
GET | /members/{site_id}/courses/{course_id}/lessons/{lesson_id}/completed-students | レッスンの受講完了者一覧取得 |
GET | /members/{site_id}/lesson-completions | 受講完了者一覧取得 |
受講生
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /members/{site_id}/students | 受講生一覧取得 |
POST | /members/{site_id}/students | 受講生作成 |
GET | /members/{site_id}/students/{student_id} | 受講生詳細取得 |
PATCH | /members/{site_id}/students/{student_id} | 受講生更新 |
DELETE | /members/{site_id}/students/{student_id} | 受講生削除 |
GET | /members/{site_id}/students/{student_id}/progress | 受講生の受講状況一覧取得 |
GET | /members/{site_id}/students/{student_id}/progress/{course_id} | 受講生のコース別受講状況取得 |
GET | /members/{site_id}/students/{student_id}/activity-logs | 受講生の操作履歴取得 |
GET | /members/{site_id}/courses/{course_id}/students | コース登録受講生一覧取得 |
GET | /members/{site_id}/bundles/{bundle_id}/students | バンドル登録受講生一覧取得 |
登録コース・コミュニティ
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /members/{site_id}/students/{student_id}/enrollments | 受講生の登録コース・コミュニティ一覧取得 |
POST | /members/{site_id}/students/{student_id}/enrollments | 受講生の登録コース・コミュニティ追加 |
PATCH | /members/{site_id}/students/{student_id}/enrollments/{enrollment_id} | 受講生の登録コース・コミュニティ更新 |
DELETE | /members/{site_id}/students/{student_id}/enrollments/{enrollment_id} | 受講生の登録コース・コミュニティ解除 |
GET | /members/{site_id}/community-groups | コミュニティグループ一覧取得 |
イベント
イベント
日程
日程設定
申込フォーム・申込者項目
申込者
イベントグループ
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /event-groups | イベントグループ一覧取得 |
POST | /event-groups | イベントグループ作成 |
GET | /event-groups/{event_group_id} | イベントグループ詳細取得 |
PATCH | /event-groups/{event_group_id} | イベントグループ更新 |
DELETE | /event-groups/{event_group_id} | イベントグループ削除 |
担当者
決済
商品
商品グループ
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /product-groups | 商品グループ一覧取得 |
POST | /product-groups | 商品グループ作成 |
GET | /product-groups/{product_group_id} | 商品グループ取得 |
PATCH | /product-groups/{product_group_id} | 商品グループ更新 |
DELETE | /product-groups/{product_group_id} | 商品グループ削除 |
商品詳細
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /products/{product_id}/details | 商品詳細一覧取得 |
POST | /products/{product_id}/details | 商品詳細作成 |
PATCH | /products/{product_id}/details/reorder | 商品詳細並び替え |
GET | /products/{product_id}/details/{detail_id} | 商品詳細取得 |
PATCH | /products/{product_id}/details/{detail_id} | 商品詳細更新 |
DELETE | /products/{product_id}/details/{detail_id} | 商品詳細削除 |
売上
メディア
通常メディア
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /media | 通常メディア一覧 |
GET | /media/folders | 通常メディアフォルダ一覧 |
POST | /media/upload-url | 通常メディア アップロードURL発行 |
POST | /media/complete | 通常メディア アップロード完了通知 |
PATCH | /media/{media_id} | 通常メディア 名称変更 |
動画
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /media/videos | 動画一覧 |
GET | /media/videos/folders | 動画フォルダ一覧 |
POST | /media/videos/upload-url | 動画 アップロードURL発行 |
POST | /media/videos/complete | 動画 アップロード完了通知 |
PATCH | /media/videos/{media_id} | 動画 名称変更 |
音声
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /media/audios | 音声一覧 |
GET | /media/audios/folders | 音声フォルダ一覧 |
POST | /media/audios/upload-url | 音声 アップロードURL発行 |
POST | /media/audios/complete | 音声 アップロード完了通知 |
PATCH | /media/audios/{media_id} | 音声 名称変更 |
連携
| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /google-spreadsheet-accounts | Googleスプレッドシート連携アカウント一覧 |
GET | /ads-settings | 広告連携設定一覧 |
要素・タイプリファレンス
いずれも認証不要(APIキーなし)で利用でき、レート制限の対象外です。| メソッド | エンドポイント | 説明 |
|---|---|---|
GET | /element-types/funnel | 要素タイプ一覧 |
GET | /element-types/funnel/properties | 要素プロパティ定義 |
GET | /element-types/lesson | レッスン要素タイプ一覧 |
GET | /element-types/lesson/properties | レッスン要素プロパティ定義 |
GET | /element-types/mail | HTMLメール要素タイプ一覧 |
GET | /element-types/mail/properties | HTMLメール要素プロパティ定義 |
GET | /message-types/line | LINEメッセージタイプ定義 |
GET | /message-condition-types | 配信条件タイプ定義 |
HTTPステータスコード
| コード | 説明 |
|---|---|
200 | リクエスト成功 |
201 | リソース作成成功(作成APIの一部。200 を返す作成APIもあります) |
400 | リクエストの前提条件が満たされていない(SMS設定不備、content_type変更不可、不正なファイルタイプ、契約内容による件数上限(商品・会員サイト・コース・レッスン)など)。一部のAPIでは必須・型の不備も 400(validation_error) |
401 | 認証エラー(APIキーが未指定・無効・無効化、またはアカウントが利用停止中) |
403 | 権限エラー(アクセス権がないリソース) |
404 | リソースが見つからない |
409 | 競合(送信中メッセージの更新・削除、重複登録、項目が登録されているグループの削除など) |
422 | バリデーションエラー、契約内容による件数上限(ファネル・ステップ・配信アカウント・シナリオ)、ストレージ容量・エンコード数の上限、配信の安全制御 |
429 | レート制限、配信予約時のキュー作成レート制限、クールダウン、リソース作成上限の超過 |
500 | サーバー内部エラー(error 形式の internal_error はイベント作成のみ。それ以外はLaravel標準の形式) |
502 | 外部サービス(LINE API)への送信失敗 |
エラーコード
| コード | ステータス | 説明 |
|---|---|---|
bad_request | 400 | リクエストの前提条件が満たされていない(content_type変更不可、Googleスプレッドシート連携が利用できない環境での指定、契約内容による件数上限(商品・会員サイト・コース・レッスン)など) |
invalid_encoding | 400 | リクエストボディがUTF-8でない |
sms_not_configured / sms_no_credit | 400 | SMS配信の設定が未完了、またはSMSクレジット残数が不足 |
invalid_filetype / not_uploaded / folder_not_found | 400 | メディアアップロードのファイルタイプ・アップロード状態・フォルダの不備 |
invalid_element_id / duplicate_element_id | 400 | ページ更新・レッスン更新で element_id が存在しない、または重複している |
friend_blocked | 400 | ブロック中のLINE友だちへの1対1チャット送信 |
stripe_not_configured | 400 | Stripeの決済連携設定が未完了 |
invalid_event_type | 400 | イベントのタイプに対応しないエンドポイントを呼んだ |
unauthorized | 401 | APIキーが未指定・無効・無効化、またはアカウントが利用停止中 |
forbidden | 403 | リソースへのアクセス権がない |
not_found | 404 | 指定されたリソースが存在しない |
conflict | 409 | リソースの状態が競合(送信中メッセージの更新・削除、重複登録、項目が登録されているグループの削除など) |
already_completed | 409 | アップロード完了通知を処理済みのメディアに再度呼んだ |
validation_error | 422(一部のAPIでは 400) | リクエストパラメータのバリデーションエラー(422 では details に項目別のエラー。400 で返すAPIでは details なし) |
plan_limit_exceeded | 422 | 契約内容による件数上限(ファネル・ステップ・配信アカウント・シナリオ) |
storage_limit_exceeded | 422 | メディアのストレージ容量超過 |
encode_limit_exceeded | 422 | 動画・音声の同時エンコード処理数の上限 |
safety_restriction | 422 | 配信予約時の安全制御に該当 |
rate_limit_exceeded | 429 | レート制限、または配信予約時のキュー作成レート制限を超過 |
cooldown_active | 429 | 配信予約の再作成がクールダウン中 |
total_limit_exceeded / hourly_limit_exceeded / monthly_limit_exceeded | 429 | リソース作成上限(累計・1時間・月間)を超過 |
internal_error | 500 | イベント作成でリマインダ配信用シナリオの雛形を解決できない(それ以外のサーバー内部エラーは error 形式ではなくLaravel標準の形式) |
external_service_error | 502 | LINE APIへの送信失敗 |