EngageLab

このAPIは、現在のアプリケーションのVIPステータスとVIP有効期限を照会します。AppPushとWebPushに対応しています。

注意: データセンターと製品タイプは、リクエストドメインまたはURLルートによって決まります。リクエストパラメータで追加指定する必要はありません。

注意: AppKeyはREST APIのBasic Auth認証情報で渡されます。QueryまたはBodyで追加指定する必要はありません。

認証

詳細については、REST API概要の認証方法を参照してください。

GET v4/app/vip/status

              
              GET v4/app/vip/status

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

リクエストヘッダー

GET /v4/app/vip/status Authorization: Basic (base64 auth string) Content-Type: application/json

              
              GET /v4/app/vip/status
Authorization: Basic (base64 auth string)
Content-Type: application/json

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

リクエストパラメータ

なし。

成功レスポンス

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8

              
              HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

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

{ "vip_status": 1, "vip_end_time": 1775059200 }

              
              {
    "vip_status": 1,
    "vip_end_time": 1775059200
}

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

レスポンスパラメータ

フィールド	型	説明
`vip_status`	int	VIPステータス。`0` は無料トライアル、`1` は有料プラン利用中、`2` は支払い保留中だが利用可能、`-1` は無料トライアル期限切れ、`-2` は有料プラン期限切れ、`-3` は支払い保留のため利用不可を示します。
`vip_end_time`	int64	VIP有効期限。Unix秒単位のタイムスタンプです。

失敗レスポンス

HTTP/1.1 401 Unauthorized Content-Type: application/json; charset=utf-8

              
              HTTP/1.1 401 Unauthorized
Content-Type: application/json; charset=utf-8

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

{ "error": { "code": 21004, "message": "basic auth failed" } }

              
              {
    "error": {
        "code": 21004,
        "message": "basic auth failed"
    }
}

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

Code	HTTP	説明	Error Message	詳細
21004	401	認証失敗	basic auth failed	AppKeyとMasterSecretが一致しない、またはBasic Auth認証情報が提供されていません。
21008	400	リクエストパラメータエラー	app_key is not a 24 size string	Basic Auth内のAppKeyが24文字ではありません。
21030	503	システム内部エラー。しばらくしてから再試行してください	Server response time out, please try again later	内部サービスの応答がタイムアウトしました。
27000	500	システム内部エラー	Server inner err	内部サービス呼び出しに失敗したか、予期しないエラーが発生しました。
27001	401	認証情報が無効	app_key does not exist or basic info is invalid	Basic Auth内のAppKeyの長さは有効ですが、アプリケーションが存在しないか、アプリケーションの基本認証情報が無効です。