How to receive messages in WeChat Enterprise Account Development

How to receive messages in WeChat Enterprise Account Development

When the app is set in callback mode, the enterprise can receive employee reply messages, as well as employee attention, menu clicks, geographic location reporting and other events through the callback URL.

After receiving an event, the enterprise can send a passive response message to enable interaction between employees and the enterprise.

Note that when an enterprise receives a message or sends a passive response message, the message body is encrypted using AES to ensure transmission security. For details, please refer to the section 'Callback Mode' in 'Establish Connection'.

1. Follow and Unfollow

When employees follow a corporate account, they must first bind it to the account in the corporate address book; if the company has enabled two-factor verification, then after the binding is successful, they must also be verified by the company before they can successfully follow.

1. Bind employees to accounts in the address book

When an employee follows a corporate account, the employee's WeChat ID, the mobile phone or email address bound to WeChat, will be matched with the account in the corporate address book. If a match is found, the binding is successful; otherwise, the employee will be prompted to enter the mobile phone number or email address, and after successful verification, it will be matched with the account in the corporate address book. Note that the employee's WeChat version must be above 5.4, and currently only supports iOS and Android platforms.

2. Secondary verification

When an enterprise enables two-step verification, it must fill in the URL of the enterprise two-step verification page. When an employee binds an account in the address book, he or she will receive a graphic message to guide the employee to the enterprise's verification page to verify his or her identity. After the employee successfully verifies, the enterprise can call the following interface to let the employee follow the success.

  • Request Instructions

Http request method: GET

https://qyapi.weixin.qq.com/cgi-bin/user/authsucc?access_token=ACCESS_TOKEN&userid=USERID

  • Parameter Description
parameter must illustrate
access_token yes Call interface credentials
userid yes Employee UserID
  • Permissions

The administrator must have the management authority of the employee corresponding to the userid.

  • Return results
  1.  {
  2.  "errcode" : "0" ,
  3.  "errmsg" : "ok"  
  4.  }

3. Push notifications for follow/unfollow events

Events of employees following or unfollowing an enterprise account will be pushed to the URL set by each application on the management side; in particular, the default enterprise assistant can be used to obtain the following status of the entire enterprise account. (The following assumes that the URL is http://api.3dept.com).

  • Request Instructions

Http request method: POST

http://api.3dept.com/?signature=ASDFQWEXZCVAQFASDFASDFSS&timestamp=13500001234&nonce=123412323

  • Parameter Description
  1.  < xml >  
  2.  < ToUserName > <![CDATA[toUser]]> </ ToUserName >  
  3.  < FromUserName > <![CDATA[UserID]]> </ FromUserName >  
  4.  <CreateTime> 1348831860 </CreateTime>​​​​  
  5.  < MsgType > <![CDATA[event]]> </ MsgType >  
  6.  < Event > <![CDATA[subscribe]]> </ Event >  
  7.  <AgentID> 1 </AgentID>​​​​  
  8.  </ xml >  
parameter illustrate
ToUserName Corporate ID
FromUserName Employee UserID
CreateTime Message creation time (integer)
MsgType Message type, fixed at this time: event
Event Event type, subscribe (subscription), unsubscribe (unsubscription)
AgentID The id of the enterprise application, integer. It can be obtained from the application settings page; if the id is 0, it means the follow/unfollow event of the entire enterprise account

#p#

2. Receiving ordinary messages

Ordinary messages refer to messages sent by employees to enterprise applications, including text, pictures, voice, video, geographic location, and other types.

  • text message
  1.  < xml >  
  2.  < ToUserName > <![CDATA[toUser]]> </ ToUserName >  
  3.  < FromUserName > <![CDATA[fromUser]]> </ FromUserName >   
  4.  <CreateTime> 1348831860 </CreateTime>​​​​  
  5.  < MsgType > <![CDATA[text]]> </ MsgType >  
  6.  < Content > <![CDATA[this is a test]]> </ Content >  
  7.  < MsgId > 1234567890123456 </ MsgId >  
  8.  <AgentID> 1 </AgentID>​​​​  
  9.  </ xml >  
parameter illustrate
ToUserName Corporate ID
FromUserName Employee UserID
CreateTime Message creation time (integer)
MsgType Message type, fixed at this time: text
Content Text message content
MsgId Message id, 64-bit integer
AgentID The id of the enterprise application, integer. You can view it on the application settings page.
  • image message
  1.  < xml >  
  2.  < ToUserName > <![CDATA[toUser]]> </ ToUserName >  
  3.  < FromUserName > <![CDATA[fromUser]]> </ FromUserName >   
  4.  <CreateTime> 1348831860 </CreateTime>​​​​  
  5.  < MsgType > <![CDATA[text]]> </ MsgType >  
  6.  < Content > <![CDATA[this is a test]]> </ Content >  
  7.  < MsgId > 1234567890123456 </ MsgId >  
  8.  <AgentID> 1 </AgentID>​​​​  
  9.  </ xml >  
parameter illustrate
ToUserName Corporate ID
FromUserName Employee UserID
CreateTime Message creation time (integer)
MsgType Message type, fixed at this time: text
Content Text message content
MsgId Message id, 64-bit integer
AgentID The id of the enterprise application, integer. You can view it on the application settings page.
  • image message
  1.  < xml >  
  2.  < ToUserName > <![CDATA[toUser]]> </ ToUserName >  
  3.  < FromUserName > <![CDATA[fromUser]]> </ FromUserName >  
  4.  <CreateTime> 1348831860 </CreateTime>​​​​  
  5.  < MsgType > <![CDATA[image]]> </ MsgType >  
  6.  < PicUrl > <![CDATA[this is a url]]> </ PicUrl >  
  7.  < MediaId > <![CDATA[media_id]]> </ MediaId >  
  8.  < MsgId > 1234567890123456 </ MsgId >  
  9.  <AgentID> 1 </AgentID>​​​​  
  10.  </ xml >  
parameter illustrate
ToUserName Corporate ID
FromUserName Employee UserID
CreateTime Message creation time (integer)
MsgType Message type, fixed at this time: image
PicUrl Image Link
MediaId The media id of the picture message can be used to call the multimedia file download interface to pull data.
MsgId Message id, 64-bit integer
AgentID The id of the enterprise application, integer. You can view it on the application settings page.
  • Voice message
  1.  < xml >  
  2.  < ToUserName > <![CDATA[toUser]]> </ ToUserName >  
  3.  < FromUserName > <![CDATA[fromUser]]> </ FromUserName >  
  4.  <CreateTime> 1357290913 </CreateTime>​​​​  
  5.  < MsgType > <![CDATA[voice]]> </ MsgType >  
  6.  < MediaId > <![CDATA[media_id]]> </ MediaId >  
  7.  < Format > <![CDATA[Format]]> </ Format >  
  8.  < MsgId > 1234567890123456 </ MsgId >  
  9.  <AgentID> 1 </AgentID>​​​​  
  10.  </ xml >  
parameter illustrate
ToUserName Corporate ID
FromUserName Employee UserID
CreateTime Message creation time (integer)
MsgType Message type, fixed at this time: voice
MediaId Voice message media id, you can call the multimedia file download interface to pull data.
Format Voice format, such as amr, speex, etc.
MsgId Message id, 64-bit integer
AgentID The id of the enterprise application, integer. You can view it on the application settings page.
  • Video message
  1.  < xml >  
  2.  < ToUserName > <![CDATA[toUser]]> </ ToUserName >  
  3.  < FromUserName > <![CDATA[fromUser]]> </ FromUserName >  
  4.  <CreateTime> 1357290913 </CreateTime>​​​​  
  5.  < MsgType > <![CDATA[video]]> </ MsgType >  
  6.  < MediaId > <![CDATA[media_id]]> </ MediaId >  
  7.  < ThumbMediaId > <![CDATA[thumb_media_id]]> </ ThumbMediaId >  
  8.  < MsgId > 1234567890123456 </ MsgId >  
  9.  <AgentID> 1 </AgentID>​​​​  
  10.  </ xml >  
parameter illustrate
ToUserName Corporate ID
FromUserName Employee UserID
CreateTime Message creation time (integer)
MsgType Message type, fixed at this time: video
MediaId Video message media id, you can call the multimedia file download interface to pull data.
ThumbMediaId The media ID of the video message thumbnail. You can call the multimedia file download interface to pull data.
MsgId Message id, 64-bit integer
AgentID The id of the enterprise application, integer. You can view it on the application settings page.
  • Location Message
  1.  < xml >  
  2.  < ToUserName > <![CDATA[toUser]]> </ ToUserName >  
  3.  < FromUserName > <![CDATA[fromUser]]> </ FromUserName >  
  4.  <CreateTime> 1351776360 </CreateTime>​​​​  
  5.  < MsgType > <![CDATA[location]]> </ MsgType >  
  6.  < Location_X > 23.134521 </ Location_X >  
  7.  < Location_Y > 113.358803 </ Location_Y >  
  8.  < Scale > 20 </ Scale >  
  9.  < Label > <![CDATA[Location Information]]> </ Label >  
  10.  < MsgId > 1234567890123456 </ MsgId >  
  11.  <AgentID> 1 </AgentID>​​​​  
  12.  </ xml >  
parameter illustrate
ToUserName Corporate ID
FromUserName Employee UserID
CreateTime Message creation time (integer)
MsgType Message type, fixed at this time: location
Location_X Geographical location latitude
Location_Y Geographic location longitude
Scale Map zoom size
Label Geographical location information
MsgId Message id, 64-bit integer
AgentID The id of the enterprise application, integer. You can view it on the application settings page.

#p#

3. Receiving events

Events refer to certain operations performed by employees on the enterprise account, such as following, reporting geographic location, clicking on menus, etc. (For events to follow, please refer to 'Follow and Unfollow')

1. Menu event push

When an employee clicks on a custom menu, WeChat will push the click event to the enterprise. Please note that clicking on a menu to pop up a submenu will not generate a report.

  • Parameter Description
  1.  < xml >  
  2.  < ToUserName > <![CDATA[toUser]]> </ ToUserName >  
  3.  < FromUserName > <![CDATA[FromUser]]> </ FromUserName >  
  4.  <CreateTime> 123456789 </CreateTime>​​​​  
  5.  < MsgType > <![CDATA[event]]> </ MsgType >  
  6.  < Event > <![CDATA[click]]> </ Event >  
  7.  <EventKey> <![ CDATA [ EVENTKEY ]] > </EventKey>  
  8.  <AgentID> 001 </AgentID>​​​​  
  9.  </ xml >  
parameter illustrate
ToUserName Corporate ID
FromUserName Employee UserID
CreateTime Message creation time (integer)
MsgType Message type, fixed at this time: event
Event Event type, which can be click or view, corresponding to the type when the menu is created
EventKey Event KEY value, corresponding to the KEY value in the menu interface
AgentID The id of the enterprise application, integer. You can view it on the application settings page.

2. Reporting Geolocation Events

After employees agree to report their location, they will report their location every time they enter an application session, or every 5 seconds after entering an application session. Enterprises can modify the above settings of the application on the management side. When reporting the location, WeChat will push this event to the URL set by the enterprise application on the management side (assuming that the URL is http://api.3dept.com below).

  • Request Instructions

Http request method: POST

http://api.3dept.com/?signature=ASDFQWEXZCVAQFASDFASDFSS&timestamp=13500001234&nonce=123412323

  • Parameter Description
  1.  < xml >  
  2.  < ToUserName > <![CDATA[toUser]]> </ ToUserName >  
  3.  < FromUserName > <![CDATA[FromUser]]> </ FromUserName >  
  4.  <CreateTime> 123456789 </CreateTime>​​​​  
  5.  < MsgType > <![CDATA[event]]> </ MsgType >  
  6.  < Event > <![CDATA[LOCATION]]> </ Event >  
  7.  <Latitude> 23.104105 </Latitude>​​​​  
  8.  <Longitude> 113.320107 </Longitude>​​​​  
  9.  < Precision > 65.000000 </ Precision >  
  10.  <AgentID> 001 </AgentID>​​​​  
  11.  </ xml >  
parameter illustrate
ToUserName Corporate ID
FromUserName Employee UserID
CreateTime Message creation time (integer)
MsgType Message type, fixed at this time: event
Event Event type, fixed at this time: LOCATION
Latitude Geographical location latitude
Longitude Geographic location longitude
Precision Geolocation accuracy
AgentID The id of the enterprise application, integer. You can view it on the application settings page.

#p#

4. Passive response message

The enterprise response message should also be encrypted and carry msg_signature, timestamp, nonce and ciphertext . The following is a standard response packet:

  1.  < xml >  
  2.  < Encrypt > <![CDATA[msg_encrypt]]> </ Encrypt >  
  3.  < MsgSignature > <![CDATA[msg_signature]]> </ MsgSignature >  
  4.  <TimeStamp> timestamp </TimeStamp>​​​​  
  5.  < Nonce > <![CDATA[nonce]]> </ Nonce >  
  6.  </ xml >  

The following is the plain text XML structure of each type of message:

  • text message
  1.  < xml >  
  2.  < ToUserName > <![CDATA[toUser]]> </ ToUserName >  
  3.  < FromUserName > <![CDATA[fromUser]]> </ FromUserName >   
  4.  <CreateTime> 1348831860 </CreateTime>​​​​  
  5.  < MsgType > <![CDATA[text]]> </ MsgType >  
  6.  < Content > <![CDATA[this is a test]]> </ Content >  
  7.  </ xml >  
parameter illustrate
ToUserName Employee UserID
FromUserName Corporate ID
CreateTime Message creation time (integer)
MsgType Message type, fixed at this time: text
Content Text message content
  • image message
  1.  < xml >  
  2.  < ToUserName > <![CDATA[toUser]]> </ ToUserName >  
  3.  < FromUserName > <![CDATA[fromUser]]> </ FromUserName >  
  4.  <CreateTime> 1348831860 </CreateTime>​​​​  
  5.  < MsgType > <![CDATA[image]]> </ MsgType >  
  6.  < Image >  
  7.  < MediaId > <![CDATA[media_id]]> </ MediaId >  
  8.  </ Image >  
  9.  </ xml >  
parameter illustrate
ToUserName Employee UserID
FromUserName Corporate ID
CreateTime Message creation time (integer)
MsgType Message type, fixed at this time: image
MediaId The media id of the picture message can be used to call the multimedia file download interface to pull data.
  • Voice message
  1.  < xml >  
  2.  < ToUserName > <![CDATA[toUser]]> </ ToUserName >  
  3.  < FromUserName > <![CDATA[fromUser]]> </ FromUserName >  
  4.  <CreateTime> 1357290913 </CreateTime>​​​​  
  5.  < MsgType > <![CDATA[voice]]> </ MsgType >  
  6.  < Voice >  
  7.  < MediaId > <![CDATA[media_id]]> </ MediaId >  
  8.  </ Voice >  
  9.  </ xml >  
parameter illustrate
ToUserName Employee UserID
FromUserName Corporate ID
CreateTime Message creation time (integer)
MsgType Message type, fixed at this time: voice
MediaId Voice message media id, you can call the multimedia file download interface to pull data
  • Video message
  1.  < xml >  
  2.  < ToUserName > <![CDATA[toUser]]> </ ToUserName >  
  3.  < FromUserName > <![CDATA[fromUser]]> </ FromUserName >  
  4.  <CreateTime> 1357290913 </CreateTime>​​​​  
  5.  < MsgType > <![CDATA[video]]> </ MsgType >  
  6.  < Video >  
  7.  < MediaId > <![CDATA[media_id]]> </ MediaId >  
  8.  < Title > <![CDATA[title]]> </ Title >  
  9.  < Description > <![CDATA[description]]> </ Description >  
  10.  </ Video >  
  11.  </ xml >  
parameter illustrate
ToUserName Employee UserID
FromUserName Corporate ID
CreateTime Message creation time (integer)
MsgType Message type, fixed at this time: video
MediaId Video message media id, you can call the multimedia file download interface to pull data.
Title Title of the video message
Description Description of video message
  • news
  1.  < xml >  
  2.  < ToUserName > <![CDATA[toUser]]> </ ToUserName >  
  3.  < FromUserName > <![CDATA[fromUser]]> </ FromUserName >  
  4.  <CreateTime> 12345678 </CreateTime>​​​​  
  5.  < MsgType > <![CDATA[news]]> </ MsgType >  
  6.  <ArticleCount> 2 </ArticleCount>​​​​  
  7.  < Articles >  
  8.  < item >  
  9.  < Title > <![CDATA[title1]]> </ Title >   
  10.  < Description > <![CDATA[description1]]> </ Description >  
  11.  < PicUrl > <![CDATA[picurl]]> </ PicUrl >  
  12.  < Url > <![CDATA[url]]> </ Url >  
  13.  </ item >  
  14.  < item >  
  15.  < Title > <![CDATA[title]]> </ Title >  
  16.  < Description > <![CDATA[description]]> </ Description >  
  17.  < PicUrl > <![CDATA[picurl]]> </ PicUrl >  
  18.  < Url > <![CDATA[url]]> </ Url >  
  19.  </ item >  
  20.  </ Articles >  
  21.  </ xml >  
parameter illustrate
ToUserName Employee UserID
FromUserName Corporate ID
CreateTime Message creation time (integer)
MsgType Message type, fixed at this time: news
ArticleCount For multiple text and picture messages, the first item is a large picture by default. Please note that if the number of pictures and texts exceeds 10, there will be no response.
Title Title of picture and text message
Description Description of the picture and text message
PicUrl Image link, supports JPG and PNG formats, the best effect is 360*200 for large images and 200*200 for small images
Url Click on the link to jump to the text message

<<:  How to manage multimedia files in WeChat Enterprise Account Development

>>:  Should I learn Swift or Objective-C directly?

Recommend

Analysis of GuangDianTong information flow optimization techniques!

Guangdiantong is one of Tencent’s two major infor...

How much does it cost to join the Changde Building Materials Mini Program? What is the price for joining the Changde Building Materials Mini Program?

How much does it cost to join the Changde Buildin...

Want to stay healthy by drinking soup? Does this method work?

《Cotton Swab Medical Science Popularization》 Beij...

Tencent VS Alibaba's Internet+ War

Internet+, this term has recently appeared freque...

The number of followers increased by 100,000. This is how Zhihu operates and promotes!

[Zhihu, is it worth doing? " Before answerin...

No offline business: Can Internet TV escape being a niche?

After experiencing a wave of Internet development...

How do local restaurants use Douyin?

Many of my fans and friends run offline restauran...

China Automobile Dealers Association: Comparison of used car business of Chinese and American 4S stores

The 2020 Annual Meeting of the Second-Hand Car Br...

Are you serious? This animal hibernates the longest in the world. | Science Museum

Although it is the beginning of spring, But the w...

Kaola.com Product Analysis

Kaola.com (formerly known as NetEase Kaola) is an...

Does Stockholm Syndrome really exist?

© BBC Leviathan Press: There are many explanation...

Insights and solutions for the automotive industry during the epidemic

At the beginning of the Year of the Rat, a sudden...

What is the difference between underwear that costs 20 yuan and underwear that costs 200 yuan?

Underwear plays an important role in shaping wome...

Unbelievable! He had gone through so much before getting on the train!

Some time ago Cotton blossoms into a sea of ​​flo...

Importance of App Title in ASO Optimization

The title is the most important metadata for user...