プッシュプラン API

最新更新：2025-07-22

このモジュールのAPIは主にプッシュプランID自体の作成、修正、照会操作を対象としています。

呼び出し検証

詳細はREST APIの概要にある認証方式の説明を参照してください。

プッシュプランの作成と更新

このAPIはプッシュプランの作成または更新に使用されます。plan_idとplan_descriptionを渡すことで、システムはplan_idが存在するかどうかに応じて作成または更新操作を行います。

呼び出しアドレス

POST v4/push_plan

              
              POST v4/push_plan

このコードブロックはフローティングウィンドウ内に表示されます

リクエストパラメータ

パラメータ名	タイプ	必須かどうか	説明
plan_id	string	はい	プッシュプランの一意識別子形式規則：アルファベット（大文字と小文字を区別）、数字、下線の組み合わせ、下線で始まることを禁止長さ制限：最大50文字一意性制約：設定後は変更できません更新策略：plan_idが既存の場合はplan_descriptionを更新し、存在しない場合は新しいプランを作成します
plan_description	string	はい	プッシュプランの説明情報内容要件：プッシュシナリオ、対象ユーザー、プッシュ内容などの業務上の重要な情報を含める必要があります形式規範：中国語、英語、数字、一般的な句読点をサポート長さ推奨：200文字以内（システムは強制的な制限を行いません）

リクエスト例

{ "plan_id": "push_20231001_001", "plan_description": "双十一大促活动推送计划，覆盖全量用户" }

              
              {
  "plan_id": "push_20231001_001",
  "plan_description": "双十一大促活动推送计划，覆盖全量用户"
}

このコードブロックはフローティングウィンドウ内に表示されます

返却パラメータの説明

成功応答

{ "plan_id": "push_20231001_001" }

              
              {
  "plan_id": "push_20231001_001"
}

このコードブロックはフローティングウィンドウ内に表示されます

失敗応答

{ "error": { "code": 27303, "message": "Empty plan id" } }

              
              {
  "error": {
    "code": 27303,
    "message": "Empty plan id"
  }
}

このコードブロックはフローティングウィンドウ内に表示されます

プッシュプランの照会

このAPIはプッシュプランリストのページング照会に使用され、送信元によるフィルタリングとプラン説明/プランIDの曖昧検索をサポートしています。

呼び出しアドレス

GET v4/push_plan/list?page_index=x&page_size=xx&send_source=x&search_description=xxx

              
              GET v4/push_plan/list?page_index=x&page_size=xx&send_source=x&search_description=xxx

このコードブロックはフローティングウィンドウ内に表示されます

リクエストパラメータ

パラメータ名	タイプ	必須かどうか	説明
page_index	int	はい	ページングページ番号（`1`から開始）
page_size	int	はい	ページあたりのデータ件数、最大`100`件までサポート
send_source	int	いいえ	送信元識別：`0`-API、`1`-Webコンソール
search_description	string	いいえ	プラン説明またはプランIDの曖昧一致（中国語、英語、数字、下線をサポート）

リクエスト例

GET /v4/push_plan/list?page_index=1&page_size=20&send_source=1&search_description=双十一

              
              GET /v4/push_plan/list?page_index=1&page_size=20&send_source=1&search_description=双十一

このコードブロックはフローティングウィンドウ内に表示されます

返却パラメータの説明

成功応答

{ "push_plan_info": [ { "push_id": "push_20231111", "plan_description": "双十一全站推送计划", "count": 15, "create_time": "2023-11-01T10:00:00Z", "last_used_time": "2023-11-11T20:30:00Z" } ], "total": 1 }

              
              {
  "push_plan_info": [
    {
      "push_id": "push_20231111",
      "plan_description": "双十一全站推送计划",
      "count": 15,
      "create_time": "2023-11-01T10:00:00Z",
      "last_used_time": "2023-11-11T20:30:00Z"
    }
  ],
  "total": 1
}

このコードブロックはフローティングウィンドウ内に表示されます

失敗応答

{ "error": { "code": 1003, "message": "Parameter value is invalid" } }

              
              {
    "error": {
        "code": 1003,
        "message": "Parameter value is invalid"
    }
}

このコードブロックはフローティングウィンドウ内に表示されます

プッシュプランに基づくMsgidの照会

このAPIは指定されたプッシュプランの過去1か月間の関連メッセージIDを取得するためのもので、複数のプランの関連メッセージデータの一括照会をサポートしています。

呼び出しアドレス

GET /v4/status/plan/msg/?plan_ids=xxxxxx,xxxxxx&start_date=yyyy-MM-dd&end_date=yyyy-MM-dd

              
              GET /v4/status/plan/msg/?plan_ids=xxxxxx,xxxxxx&start_date=yyyy-MM-dd&end_date=yyyy-MM-dd

このコードブロックはフローティングウィンドウ内に表示されます

リクエストパラメータ

パラメータ名	タイプ	必須かどうか	説明
plan_ids	string	はい	プッシュプランIDリスト、複数のIDは英文カンマで区切り、最大100個までサポート
start_date	string	はい	開始日（形式：`yyyy-MM-dd`）、以下の条件を満たす必要があります： 1. 現在日付から30日前以内 2. 終了日>=開始日
end_date	string	はい	終了日（形式：`yyyy-MM-dd`）、以下の条件を満たす必要があります： 1. 開始日との間隔≤31日 2. 開始日より早くない

リクエスト例

GET /v4/status/plan/msg/?plan_ids=push_20231101,push_20231102&start_date=2023-11-01&end_date=2023-11-15

              
              GET /v4/status/plan/msg/?plan_ids=push_20231101,push_20231102&start_date=2023-11-01&end_date=2023-11-15

このコードブロックはフローティングウィンドウ内に表示されます

返却パラメータの説明

成功応答

{ "push_20231101": { "msg_ids": ["msg_001", "msg_002"] }, "push_20231102": { "msg_ids": ["msg_003"] } }

              
              {
  "push_20231101": {
    "msg_ids": ["msg_001", "msg_002"]
  },
  "push_20231102": {
    "msg_ids": ["msg_003"]
  }
}

このコードブロックはフローティングウィンドウ内に表示されます

失敗応答

{ "error": { "code": 21044, "message": "The time interval exceeds one month." } }

              
              {
    "error": {
        "code": 21044,
        "message": "The time interval exceeds one month."
    }
}

このコードブロックはフローティングウィンドウ内に表示されます

プッシュプランの削除

このAPIはプッシュプランの削除に使用されます。plan_idを渡すことで、システムはplan_idが存在するかどうかに応じて削除操作を行います。

呼び出しアドレス

POST v4/push_plan/{plan_id}

              
              POST v4/push_plan/{plan_id}

このコードブロックはフローティングウィンドウ内に表示されます

リクエストパラメータ

パラメータ名	タイプ	必須かどうか	説明
plan_id	string	はい	プッシュプランの一意識別子

リクエスト例

curl -X DELETE http://127.0.0.1/v4/push_plan/push_20231001_001 -u "appKey:appSecret"

              
              curl -X DELETE http://127.0.0.1/v4/push_plan/push_20231001_001 -u "appKey:appSecret"

このコードブロックはフローティングウィンドウ内に表示されます

返却パラメータの説明

成功応答

{ "plan_id": "push_20231001_001" }

              
              {
  "plan_id": "push_20231001_001"
}

このコードブロックはフローティングウィンドウ内に表示されます

失敗応答

{ "error": { "code": 27305, "message": "Plan id does not exist" } }

              
              {
  "error": {
    "code": 27305,
    "message": "Plan id does not exist"
  }
}

このコードブロックはフローティングウィンドウ内に表示されます

プッシュプランの削除

このAPIはプッシュプランを削除するために使用されます。plan_idを渡すことで、plan_idが存在するかどうかに基づいて削除操作が実行されます。

エンドポイント

POST v4/push_plan/{plan_id}

              
              POST v4/push_plan/{plan_id}

このコードブロックはフローティングウィンドウ内に表示されます

リクエストパラメータ

パラメータ名	タイプ	必須	説明
plan_id	string	はい	プッシュプランの一意識別子

リクエスト例

curl -X DELETE http://127.0.0.1/v4/push_plan/push_20231001_001 -u "appKey:appSecret"

              
              curl -X DELETE http://127.0.0.1/v4/push_plan/push_20231001_001 -u "appKey:appSecret"

このコードブロックはフローティングウィンドウ内に表示されます

レスポンスパラメータの説明

成功レスポンス

{ "plan_id": "push_20231001_001" }

              
              {
  "plan_id": "push_20231001_001"
}

このコードブロックはフローティングウィンドウ内に表示されます

失敗レスポンス

{ "error": { "code": 27305, "message": "プランIDが存在しません" } }

              
              {
  "error": {
    "code": 27305,
    "message": "プランIDが存在しません"
  }
}

このコードブロックはフローティングウィンドウ内に表示されます

エラーコードの説明

エラーコード	説明	推奨処理方法
21015	プッシュプランの作成リクエストパラメータエラー	`plan_id`または`plan_description`のタイプが正しいか確認してください
27300	プッシュプラン識別子が不正	`plan_id`が命名規則に従っていることを確認してください
27301	プッシュプランの説明が不正	`plan_description`が規則に従っていることを確認してください
27303	プッシュプラン識別子が空	プッシュプランを作成する際に有効なプッシュプラン識別子を指定してください
27304	プッシュプラン識別子の長さが制限を超えています	プッシュプラン識別子の長さを50文字未満にしてください
27305	プッシュプランが存在しません	プッシュプランが存在しません
21004	プッシュプランの作成権限検証に失敗しました	呼び出し元にインターフェースアクセス権限があることを確認してください
27000	サーバー内部エラー	技術サポートに連絡するか、再試行してください
1003	プッシュプランの照会パラメータが不正	`page_index/page_size`が0より大きいことを確認してください
21004	プッシュプランの照会権限検証に失敗しました	呼び出し元にインターフェースアクセス権限があることを確認してください
27302	プッシュプランの使用上限を超えています	技術サポートに連絡して上限を引き上げてください
21009	システム内部エラー、再試行不可	技術サポートに連絡してください
23001	プッシュプランに基づくMsgid照会の権限検証に失敗しました	呼び出し元にインターフェースアクセス権限があることを確認してください
3010	照会インターフェースのAPI呼び出し量が制限を超えています	技術サポートに連絡してください
23002	プッシュプランに基づくMsgid照会の有効plパラメータエラー	plan_idsの有効性または日付パラメータが渡されているか確認してください
21003	渡された日付が不正	日付の有効性を確認してください
21044	開始日と終了日の間隔が1か月を超えています	開始日と終了日の間隔を1か月未満にしてください

お問い合わせ