# Extension Message Management Interface

# I. reaching out to promoters

The merchant can call the interface to directly send template messages to bound promoters for timely incentive reminders and business-related notifications.

# 1. Group message

# Interface Dxplaination

This interface is only suitable for group messaging to a bound promoter (single sender = = 50). Use the single message capability when the group size is less than 50. Note: After sending a mass message, you can use the "Section II" interface to check the delivery result, and the "Section III" interface to check the click effect of the message.

# Request address

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

# Request parameters

# Example Requests

// List_type does not pass
{
  "msg_type" : 1,
  "content" : "{\"title\":\"今日优惠活动\",\"topic\":\"双十一大促\",\"desc\":\"三件五折，两件七折\",\"date\":\"2022/10/28\"}",
  "appid" : "xxxxx",
  "path" : "pages/index/xxxxx"
}

// List_type is 1
{
  "msg_type" : 1,
  "content" : "{\"title\":\"今日优惠活动\",\"topic\":\"双十一大促\",\"desc\":\"三件五折，两件七折\",\"date\":\"2022/10/28\"}",
  "appid" : "xxxxx",
  "path" : "pages/index/xxxxx",
  "list_type" : 1,
  "role_id" : [ 1, 2 ]
}

// List_type is 2
{
  "msg_type" : 1,
  "content" : "{\"title\":\"今日优惠活动\",\"topic\":\"双十一大促\",\"desc\":\"三件五折，两件七折\",\"date\":\"2022/10/28\"}",
  "appid" : "xxxxx",
  "path" : "pages/index/xxxxx",
  "list_type" : 2,
  "retail_id" : [ "xxxxx", "xxxxx" ]
}

// List_type is 3
{
  "msg_type" : 1,
  "content" : "{\"title\":\"今日优惠活动\",\"topic\":\"双十一大促\",\"desc\":\"三件五折，两件七折\",\"date\":\"2022/10/28\"}",
  "appid" : "xxxxx",
  "path" : "pages/index/xxxxx",
  "list_type" : 3,
  "id" : [ "1", "2" ]
}

# Return value

# Return data example

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

Note: Message parameter type restriction

• First: less than 10 characters (numbers / letters / symbols / Chinese characters), only one line feed
• Thing: 20 characters (numbers / letters / symbols / Chinese characters)
• Time: 24-hour time format (support + year, month, day), support time period, connect between two time points with "~" symbol
• Amount: a currency sign + 10 digits, mixed decimal and "yuan" at the end
• number: numbers within 32 bits

# 2. Send a single message

This interface is suitable for sending messages to a single bound promoter and returning the delivery results in real time after sending them. Note: When sending a single message, there is no need to use the "Section 2" interface to check the delivery result;It is not possible to query the click data of a single message through the "Section 3" interface; only the overall click data at the message type dimension (dimension=1) can be obtained.

# Request address

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

# Request parameters

# Example Requests

{
  "msg_type" : 1,
  "content" : "{\"title\":\"今日优惠活动\",\"topic\":\"双十一大促\",\"desc\":\"三件五折，两件七折\",\"date\":\"2022/10/28\"}",
  "appid" : "xxxxx",
  "path" : "pages/index/xxxxx",
  "id" : "1"
}
或
{
  "msg_type" : 1,
  "content" : "{\"title\":\"今日优惠活动\",\"topic\":\"双十一大促\",\"desc\":\"三件五折，两件七折\",\"date\":\"2022/10/28\"}",
  "appid" : "xxxxx",
  "path" : "pages/index/xxxxx",
  "openid" : "xxxxxxxxxxxx"
}

# Return value

# Return data example

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

# II. Enquiry Delivery Results

# Interface Dxplaination

After a merchant sends a message to a group of promoters (the number of promoters sent = > 50), it can query the delivery of the message through the interface to optimize the delivery rate of the message. Note 1: Since the message is sent asynchronously, it is recommended to wait a few minutes after sending the message (the value of the percent field is 100) before adjusting the interface query. Note 2: A query for message delivery results is valid for 7 days and needs to be queried within 7 days after the message is sent.

# Request address

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

# Request parameters

# Example Requests

{
  "msg_type" : 1
}

# Return value

# Return data example

{
  "send_cnt" : 2,
  "fail_cnt" : 1,
  "fail_info" : [
    {
      "id" : "123",
      "errcode" : 103010
    }
  ],
  "fail_info_url" : "https://xxxxxxxxxx",
  "msg_type" : 1,
  "content" : "{\"title\":\"今日优惠活动\",\"topic\":\"双十一大促\",\"desc\":\"三件五折，两件七折\",\"date\":\"2022/10/28\"}",
  "appid" : "xxxxx",
  "path" : "pages/index/xxxxx",
  "list_type" : 1,
  "role_id" : [ 1, 2 ],
  "errcode": 0,
  "errmsg": "OK"
}

# III. Analysis of click effect

# Interface Dxplaination

After the merchant confirms that the message has been delivered to the user, the next day you can check the clicking status of the message through this interface. Note 1: This interface only supports querying message data in the dimensions of grouped messages (single group size > = 50) and message type; Note 2: Message click data only scrolls for 7 days, i.e. after the message is sent, the message click data will remain the same; The message is stored for 3 months, i.e. 90 days after the message was sent, and the click data of the message cannot be found through this interface.

# Request address

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

# Request parameters

# Example Requests

{
  "send_date" : "2023-08-04",
  "dimonsion" : 0,
  "msg_type" : 1,
  "begin_send_time" : 1691114400,
  "end_send_time" : 1691128800
}
或
{
  "send_date" : "2023-08-04",
  "dimonsion" : 1,
  "msg_type" : 1
}

# Return value

# Return data example

dimonsion为0时返回：
{
  "data_list" : [
    {
      "msg_id" : "123456",
      "send_time" : 1691114400,
      "click_uv" : 123,
      "click_pv" : 200
    }
  ],
  "errcode": 0,
  "errmsg": "OK"
}

dimonsion为1时返回：
{
  "data_list" : [
    {
      "msg_type" : 1,
      "click_uv" : 123,
      "click_pv" : 200
    }
  ],
  "errcode": 0,
  "errmsg": "OK"
}