# Group messages based on hashtags

Debugging Tools

Interface should be called on the server side, not in the front end (Weixin Mini Program, web pages, APP, etc.) directly called, specific reference interface call guide

Interface name: sendAll

This interface is used to group messages based on tags

# Original validation will be performed before the text message is grouped

When a developer calls the grouping interface for the grouping of graphic messages, WeChat compares the articles that the developer prepared to group with those in the public platform original library. The results are divided into the following:

• If you are currently preparing to post a group post, you can post a post in a group if you fail to find an article in the original library.
• If you are currently preparing a group post and have hit an article in the original library, then:
  • If the original author allows the article to be reproduced, you can post it in groups. When a group post is automatically replaced with the original style, the article is automatically endorsed as a reprint and the source is displayed. If you want to modify the original content or style, or do not show the reprint source when the mass, you can contact the original author and obtain authorization to send the mass.
  • If the original author prohibits the reproduction of the article, it cannot be grouped.If you wish to reprint this article, you can contact the original Official Account author and obtain authorization to send it in groups.

The group messaging interface adds a new send_ignore_reprint parameter (default 0). Developers can set the send_ignore-reprint parameter of the group messagING interface to specify whether to continue the group when the article is determined to be republished.

• When the send_ignore_reprint parameter is set to 1, if the article is determined to be reproduced, and the original text is allowed to be reproduced, the group operation will continue.
• When the send_ignore_reprint parameter is set to 0, if the article is determined to be reproduced, the group operation will stop.

# API Group Security Protection

For users who open API group protection, after sending all users, you need to wait for the administrator to confirm, if the administrator refuses or does not confirm within 30 minutes, the group will fail. Users can turn off the API group protection function in "Settings - Security Center - Risk Operation Protection."

# 1. How to call

# HTTPS calls

POST https://api.weixin.qq.com/cgi-bin/message/mass/sendall?access_token=ACCESS_TOKEN

# Cloud Calls

• This interface does not support cloud calls

# Third party invocation

• This interface supports Third Party Platform generation business call.

• The permission set id to which the interface belongs is: 7

• When a service provider is authorized by one of the permissions set, it can call on behalf of the merchant by using authorizer_access_token , which can be viewed in the third-party call documentation.

# 2. Request parameters

# Query parametersQuery String parameters

# Request BodyRequest Payload

# Body.filterObject Payload

Used to set the recipient of a text message

# Body.mpnewsObject Payload

Graphic message

# Body.textObject Payload

Text Message

# Body.voiceObject Payload

Voice Messages

# Body.imagesObject Payload

Photo message

# Body.mpvideoObject Payload

Video Messages

# Body.wxcardObject Payload

Card Messages

# 3. Return Parameters

# Response Payload

# 4. Note

1. The media_id of the graphic message is obtained by uploading the graphic material [ ](() or by creating a new draft ](() interface.
2. If the media_id is obtained through the "Draft Box / New Draft" interface, then the media_id will be invalidated after the success of the group, and the background draft will be automatically deleted.
3. Overseas WeChat Official Account Only mpnews messages are supported.
4. When the return is successful, it means that the group task has been submitted successfully, and it does not mean that the group is finished at this time, so it is still possible that there are unusual circumstances during subsequent dispatch that cause the user to not receive the message, such as the message is sometimes audited, the server is unstable, etc. In addition, it generally takes a long time for a group task to be fully sent, so please be patient.

# Avoid sending repeatedly

Developers can actively set the clientmsgid parameter when calling the group interface to avoid repeated push.

When sending a group, WeChat background will check the group records within 24 hours,If a message already exists on the clientmsgid, this message request is rejected, returning the existing message msgid, and the developer can call the "query message sending status" interface to see the status of the message.

# Event Push Group Results

Since a group task may not be completed until a certain time after it has been submitted,Thus, when the queue interface is called, it only gives a hint of whether the queue task has been successfully submitted, and if the queue job has been submitted successfully, the event is pushed to the developer URL (callback URL) that the developer filled out on the public platform at the end of the queue.

It should be noted that since the complete completion of the cluster task takes a long time, the cluster results will be pushed when the cluster tasks are about to be completed, and the pushed number data will be somewhat inaccurate from the actual situation

The XML structure of the push is as follows (when sent successfully):

<xml>
  <ToUserName><![CDATA[gh_4d00ed8d6399]]></ToUserName>
  <FromUserName><![CDATA[oV5CrjpxgaGXNHIQigzNlgLTnwic]]></FromUserName>
  <CreateTime>1481013459</CreateTime>
  <MsgType><![CDATA[event]]></MsgType>
  <Event><![CDATA[MASSSENDJOBFINISH]]></Event>
  <MsgID>1000001625</MsgID>
  <Status><![CDATA[err(30003)]]></Status>
  <TotalCount>0</TotalCount>
  <FilterCount>0</FilterCount>
  <SentCount>0</SentCount>
  <ErrorCount>0</ErrorCount>
  <CopyrightCheckResult>
    <Count>2</Count>
    <ResultList>
      <item>
        <ArticleIdx>1</ArticleIdx>
        <UserDeclareState>0</UserDeclareState>
        <AuditState>2</AuditState>
        <OriginalArticleUrl><![CDATA[Url_1]]></OriginalArticleUrl>
        <OriginalArticleType>1</OriginalArticleType>
        <CanReprint>1</CanReprint>
        <NeedReplaceContent>1</NeedReplaceContent>
        <NeedShowReprintSource>1</NeedShowReprintSource>
      </item>
      <item>
        <ArticleIdx>2</ArticleIdx>
        <UserDeclareState>0</UserDeclareState>
        <AuditState>2</AuditState>
        <OriginalArticleUrl><![CDATA[Url_2]]></OriginalArticleUrl>
        <OriginalArticleType>1</OriginalArticleType>
        <CanReprint>1</CanReprint>
        <NeedReplaceContent>1</NeedReplaceContent>
        <NeedShowReprintSource>1</NeedShowReprintSource>
      </item>
    </ResultList>
    <CheckState>2</CheckState>
  </CopyrightCheckResult>
  <ArticleUrlResult>
     <Count>1</Count>
     <ResultList>
       <item>
         <ArticleIdx>1</ArticleIdx>
         <ArticleUrl><![CDATA[Url]]></ArticleUrl>
       </item>
     </ResultList>
  </ArticleUrlResult>
</xml>

Parameter explaination

# 5. Code examples

# 5.1 Graphic message

Example Requests

{
   "filter":{
      "is_to_all":false,
      "tag_id":2
   },
   "mpnews":{
      "media_id":"123dsdajkasd231jhksad"
   },
    "msgtype":"mpnews",
    "send_ignore_reprint":0
}

Return an example

{
   "errcode":0,
   "errmsg":"send job submission success",
   "msg_id":34182, 
   "msg_data_id": 206227730
}

# 5.2 Text Message

Example Requests

{
   "filter":{
      "is_to_all":false,
      "tag_id":2
   },
   "text":{
      "content":"CONTENT"
   },
    "msgtype":"text"
}

Return an example

{
   "errcode":0,
   "errmsg":"send job submission success",
   "msg_id":34182, 
   "msg_data_id": 206227730
}

# 5.3 Voice Messages

Example Requests

{
   "filter":{
      "is_to_all":false,
      "tag_id":2
   },
   "voice":{
      "media_id":"123dsdajkasd231jhksad"
   },
    "msgtype":"voice"
}

Return an example

{
   "errcode":0,
   "errmsg":"send job submission success",
   "msg_id":34182, 
   "msg_data_id": 206227730
}

# 5.4 Photo message

Example Requests

{
   "filter":{
      "is_to_all":false,
      "tag_id":2
   },
   "images": {
      "media_ids": [
         "aaa",
         "bbb",
         "ccc"
      ],
      "recommend": "xxx",
      "title": "yyy",
      "need_open_comment": 1,
      "only_fans_can_comment": 0
   },
   "msgtype":"image"
}

Return an example

{
   "errcode":0,
   "errmsg":"send job submission success",
   "msg_id":34182, 
   "msg_data_id": 206227730
}

# 5.5 Video Messages

Example Requests

{
   "filter":{
      "is_to_all":false,
      "tag_id":2
   },
   "mpvideo":{
      "media_id":"IhdaAQXuvJtGzwwc0abfXnzeezfO0NgPK6AQYShD8RQYMTtfzbLdBIQkQziv2XJc"
   },
    "msgtype":"mpvideo"
}

Return an example

{
   "errcode":0,
   "errmsg":"send job submission success",
   "msg_id":34182, 
   "msg_data_id": 206227730
}

# 5.6 Card Messages

Example Requests

{
   "filter":{
    "is_to_all":false,
      "tag_id":"2"
   },
  "wxcard":{              
    "card_id":"123dsdajkasd231jhksad"         
    },
   "msgtype":"wxcard"
}

Return an example

{
   "errcode":0,
   "errmsg":"send job submission success",
   "msg_id":34182, 
   "msg_data_id": 206227730
}

# 6. Error code

The following is a list of error codes for this interface, other error codes can refer to General error codes

# 7. Scope of application