# Manage Extension Interface

# I. Declare the identity of promoter

# Interface Dxplaination

Weixin Mini Program The relationship with promoter is two-way, i.e. the Mini Program developer must first declare the identity of the user (e.g., a merchant, etc.) and invite the user to open the Mini Program function before the user officially becomes the Mini Program promoter. Weixin Mini Program Businesses need to declare the basic information of the promotion staff first, before inviting the promotion staff to open the function through the invitation material. Note: Each Weixin Mini Program binds a maximum of 100 thousand promoters.

# Request address

POST https://api.weixin.qq.com/promoter/addpromoter?access_token=ACCESS_TOKEN

# Request parameters

Note: A promoter under the same AppID is only allowed to bind a role and store, a single declaration of the total number of promoters can not exceed 10, the total number can not exceed 50000.

# Example Requests

{
  "promoter_list":
  [
    {
      "openid": "xxxxx",
      "role_id": 1,
      "retail_id": "xxxxx",
      "extra_info": "xxxxx",
      "name": "xxxxx",
      "phone": "xxxxx"
    },
    {
      "openid": "xxxxx",
      "role_id": 1,
      "retail_id": "xxxxx",
      "extra_info": "xxxxx",
      "name": "xxxxx",
      "phone": "xxxxx"
    }
  ]
}

# Return value

Note: Error declarations such as an invalid length of argument, incorrect openid, or duplicate will be returned in fail_list as is, with errcode and errmsg in fail_list indicating the cause of the error. Returns the outermost JSON errcode and errmsg to indicate whether the call to the API interface was successful or not.

# Return data example

{
  "total_cnt": 200,
  "fail_cnt": 2,
  "fail_list":
  [
    {
      "openid": "xxxxx",
      "role_id": 1,
      "retail_id": "xxxxx",
      "extra_info": "xxxxx",
      "name": "xxxxx",
      "phone": "xxxxx"
    },
    {
      "openid": "xxxxx",
      "role_id": 1,
      "retail_id": "xxxxx",
      "extra_info": "xxxxx",
      "name": "xxxxx",
      "phone": "xxxxx",
      "errcode": 103003,
      "errmsg": "data already exists"
    }
  ],
  "errcode": 0,
  "errmsg": "OK"
}

# II. Inquire about the identity of promoters

# Interface Dxplaination

The merchant can invite the promoter after (send the promoter the invitation material,Or direct the promoter to the authentication page from their own kiosk Weixin Mini Program, query whether the invited promoter accepted the invitation and when the invitation was accepted, and remind promoters who have not accepted the offer for a long time in due course. This interface can query the state of Weixin Mini Program binding to the promoter under all / specific role id / specific store id. If both decl_status and auth_status are 1 then the promotioner and the Mini Program are bound in both directions.After the promoter completes the two-way bonding, the merchant can check the promotional effectiveness of the promoter and send business notice to the promoter.

# Request address

POST https://api.weixin.qq.com/promoter/getpromoter?access_token=ACCESS_TOKEN

# Request parameters

Note: All character strings in this document are string.length (), the string to utf8 encoding, a Chinese character length of 3

# Example Requests

{
  "openid": "xxxxx",
  "role_id": 1,
  "retail_id": "xxxxx",
  "begin_time": 1668614400,
  "end_time": 1668666429,
  "start_id": "123",
  "need_unionid": 1,
  "auth_status": 1,
  "decl_status": 1
}

# Return value

Note: Sort by id from small to large. When paging needs to be done, squeeze the largest id into start_id. If total_cnt is less than 2000 or returns empty (error code: 103006, data does not exist), the data pull is complete.

# Return data example

{
  "promoter_list":
  [
    {
      "openid": "xxxxx",
      "role_id": 1,
      "retail_id": "xxxxx",
      "extra_info": "xxxxx",
      "auth_status": 1,
      "decl_status": 1,
      "update_time": 1668667349,
      "id": "100",
      "name": "xxxxx",
      "phone": "xxxxx"
    },
    {
      "openid": "xxxxx",
      "role_id": 1,
      "retail_id": "xxxxx",
      "extra_info": "xxxxx",
      "auth_status": 1,
      "decl_status": 1,
      "update_time": 1668667349,
      "id": "123",
      "name": "xxxxx",
      "phone": "xxxxx"
    }
  ],
  "total_cnt": 2,
  "errcode": 0,
  "errmsg": "OK"
}

# III. Modifying the Promoter's Status

# Interface Dxplaination

In the event of a promotional representative's change of duties (such as a change of role, a change in the stores served), or a departure, the merchant may change the promotional declaration information or cancel the declaration through this interface.

# Request address

POST https://api.weixin.qq.com/promoter/updatepromoter?access_token=ACCESS_TOKEN

# Request parameters

Note: All character strings in this document are string.length (), the string to utf8 encoding, a Chinese character length of 3

# Example Requests

{
  "id": "123",
  "role_id": 1,
  "retail_id": "xxxxx",
  "extra_info": "xxxxx",
  "decl_status": 2,
  "name": "xxxxx",
  "phone": "139xxxxxxxx"
}

# Return value

# Return data example

{
  "errcode": 0,
  "errmsg": "OK"
}