查询试运营期信息
收藏
我的收藏

接口介绍

该接口用于第三方小程序应用为授权小程序查询试运营期信息。

请求

基本信息

基本
HTTP URL	https://open.microapp.bytedance.com/openapi/v1/microapp/app/trial_info
HTTP Method	GET
权限要求	授权小程序授予基本信息设置权限

查询参数

参数名	参数类型	是否必须	备注
component_appid	string	是	第三方小程序应用 appid
authorizer_access_token	string	是	授权小程序接口调用凭据

响应

响应体

参数名	参数类型	备注
errno	int	错误码
message	string	错误信息
data	object

data 说明：

参数名	参数类型	备注
is_trial	int	是否处于试运营期，0：否，1：是
app_credit_score	int	小程序信用分分数，-999 表示小程序未初始化信用分
trial_pass_score	int	试运营期通过分数
trial_task_info	Array<object>	试运营期任务列表
trial_task_info.name	string	试运营期任务名称，Health：健康加分任务，Order：订单加分任务，Course：课程加分任务，Live：直播挂载任务，Video：视频挂载任务，RestrictTask：经营限制总任务
trial_task_info.target	int	试运营期任务目标
trial_task_info.progress	int	试运营期任务进度
trial_limit_info	<object>	试运营期限制
trial_limit_info.is_capability_limited	int	是否被限制进阶能力，0：否，1：是
trial_limit_info.is_payment_restricted	int	是否被限制支付额度，0：否，1：是
trial_limit_info.is_traffic_limited	int	是否被限制流量，0：否，1：是

响应体示例

JSON复制
{ 
  "errno": 0,
  "message": "success",
  "data": {
    "is_trial": 1,
    "app_credit_score": 60,
    "trial_pass_score": 80,
    "trial_task_info": [
      {
        "name": "Health",
        "target": 20,
        "progress": 8
      },
      {
        "name": "Order",
        "target": 10,
        "progress": 0
      },
      {
        "name": "Course",
        "target": 3,
        "progress": 3
      },
      {
        "name": "Live",
        "target": 3,
        "progress": 1
      },
      {
        "name": "Video",
        "target": 3,
        "progress": 2
      },
      {
        "name": "RestrictTask",
        "target": 3,
        "progress": 3
      }      
    ],
     "trial_limit_info": {
         "is_capability_limited": 0,
         "is_payment_restricted": 0,
         "is_traffic_limited": 1
     }
  }
}

错误码

错误码	message
40001	参数错误
40003	找不到相关第三方小程序应用
40004	找不到相关授权小程序
40020	第三方小程序应用 authorizer_access_token 不正确或者已过期
40036	授权小程序未授予该接口对应的权限

试运营期小程序节点变化通知

试运营期小程序节点发生变化之后，会自动触发消息发送，然后开放平台服务器会向第三方小程序应用的【消息与事件接收 URL】以 HTTP POST 方式推送相应授权小程序的试运营期小程序节点变化的通知消息。

POST 数据示例：

JSON复制
{ 
  "Nonce": "4464221",
  "TimeStamp": "1535551395",
  "Encrypt": "Encrypt Message xxxxxxxx",
  "MsgSignature": "ba394c04acece6c2c0edee058c5dddf82474b8ee"
}

其中 Encrypt 字段需要解密，解密详情见消息推送及加解密说明部分。解密后消息格式如下：

JSON复制
{ 
  "AppId": "授权小程序的appid",
  "TpAppId": "第三方小程序应用appid",
  "EventTime": "2019-01-14 12:45:10",
  "Event": "APP_TRIAL_CHANGE_NOTIFICATION",
  "TrialAppChangeNotification": {
    "type": 2,
    "time": 1679999999
  }
}

消息体字段含义如下：

参数名	参数类型	备注
AppId	string	授权小程序 appid
TpAppId	string	第三方小程序应用 appid
EventTime	string	推送事件时间
Event	string	推送事件类型
TrialAppChangeNotification	object	试运营期小程序节点变化通知
type	int	节点变化类型，1：小程序无经营限制进入试运营期，2：小程序无经营限制通过试运营期，3：小程序有经营限制进入试运营期，4：小程序有经营限制通过试运营期
time	int	unix时间戳