WeChat Official Account Admin Platform Message API Guide

Keyword: WeChat Message API Text Image Location Link Event Music RichMedia
Author: PondBay Studio[WeChat Developer EXPERT]
Address:  http://www.cnblogs.com/txw1958/p/WeChat-Message-API.html

 

  

Guide for Message API

Back

Contents

[hide]

• 1 Introduction
• 2 Apply for Message API
• 3 URL Access
• 4 Pushing Messages
  • 4.1 Text messages
  • 4.2 Image messages
  • 4.3 Location data messages
  • 4.4 Link messages
  • 4.5 Event messages
• 5 Messages Replies
  • 5.1 Text messages
  • 5.2 Music message
  • 5.3 Rich media messages
• 6 Notes
• 7 Sample code

Introduction

The WeChat Official Account Admin Platform provides developers with a Message API to manage incoming messages and reply logic.

Apply for Message API

Click Apply and fill in a name, phone and email for a contact person, as well as a URL pointing to your server and a token. The token is used to generate a signature for communication between your app and WeChat.

URL Access

When the application is submitted, a GET request will be sent to the URL provided above with the 4 parameters below:

ParameterDescriptionsignaturesignature for communication encryptiontimestamptime stampnoncea random numberechostra random string

You should check whether the HTTP request is from WeChat by verifying the signature. If the signature is correct, you should return the echostr.

The signature will be generated in the following way using the token (that you provided), timestamp and nonce.

1. Sort the 3 values of token, timestamp and nonce alphabetically.2. Combine the 3 parameters into one string, encrypt it using SHA-1.3. Compare the SHA-1 digest string with the signature from the request. If they are the same, the access request is from WeChat.

Pushing Messages

When a WeChat user sends a message to an Official Account, WeChat Official Account Admin Platform will POST it to you via the URL you provided.

Text messages

 <xml> <ToUserName><![CDATA[toUser]]></ToUserName> <FromUserName><![CDATA[fromUser]]></FromUserName>  <CreateTime>1348831860</CreateTime> <MsgType><![CDATA[text]]></MsgType> <Content><![CDATA[this is a test]]></Content> <MsgId>1234567890123456</MsgId> </xml>

ParameterDescriptionToUserNameWeChat ID of your appFromUserNamea unique ID for the senderCreateTimecreate time of the messageMsgTypemessage type ("text" for text messages)Contentmessage contentsMsgIda unique ID for the message (64 bit integer)

 

Image messages

 <xml> <ToUserName><![CDATA[toUser]]></ToUserName> <FromUserName><![CDATA[fromUser]]></FromUserName> <CreateTime>1348831860</CreateTime> <MsgType><![CDATA[image]]></MsgType> <PicUrl><![CDATA[this is a url]></PicUrl> <MsgId>1234567890123456</MsgId> </xml>

ParameterDescriptionToUserNameWeChat ID of your appFromUserNamea unique ID for the senderCreateTimecreate time of the messageMsgTypemessage type ("image" for image messages)PicUrlURL for the imageMsgIda unique ID for the message (64 bit integer)

Location data messages

<xml><ToUserName><![CDATA[toUser]]></ToUserName><FromUserName><![CDATA[fromUser]]></FromUserName><CreateTime>1351776360</CreateTime><MsgType><![CDATA[location]]></MsgType><Location_X>23.134521</Location_X><Location_Y>113.358803</Location_Y><Scale>20</Scale><Label><![CDATA[location]]></Label><MsgId>1234567890123456</MsgId></xml> 

ParameterDescriptionToUserNameWeChat ID of your appFromUserNamea unique ID for the senderCreateTimecreate time of the messageMsgTypemessage type ("location" for location messages)Location_Xlatitude of the locationLocation_Ylongitude of the locationScalescale of the mapLabellocation descriptionMsgIda unique ID for the message (64 bit integer)

Link messages

 <xml> <ToUserName><![CDATA[toUser]]></ToUserName> <FromUserName><![CDATA[fromUser]]></FromUserName> <CreateTime>1357290913</CreateTime> <MsgType><![CDATA[link]]></MsgType> <Title><![CDATA[WeChat Official Account Platform portal]]></Title> <Description><![CDATA[The URL of the portal]]></Description> <Url><![CDATA[url]]></Url> <MsgId>1234567890123456</MsgId> </xml> 

ParameterDescriptionToUserNameWeChat ID of your appFromUserNamea unique ID for the senderCreateTimecreate time of the messageMsgTypemessage type ("link" for link messages)Titletitle of the messageDescriptiondescription of the messageUrlurl which is sent to usersMsgIda unique ID for the message (64 bit integer)

Event messages

 <xml><ToUserName><![CDATA[toUser]]></ToUserName> <FromUserName><![CDATA[FromUser]]></FromUserName> <CreateTime>123456789</CreateTime> <MsgType><![CDATA[event]]></MsgType> <Event><![CDATA[EVENT]]></Event> <EventKey><![CDATA[EVENTKEY]]></EventKey> </xml>

ParameterDescriptionToUserNameWeChat ID of your appFromUserNamea unique ID for the senderCreateTimecreate time of the messageMsgTypemessage type ("event" for event messages)Eventevent type, currently we have 3 types: subscribe, unsubscribe, CLICK(coming soon)EventKeyfor future usage

Messages Replies

You can reply to incoming messages. Now the platform supports different kinds of messages, including text, image, voice, video and music. You can also do the operation 'add to my favorites'.

If you fail to perform your response within 5 seconds, we will close the connection.

The data structure for a reply message:

Text messages

 <xml> <ToUserName><![CDATA[toUser]]></ToUserName> <FromUserName><![CDATA[fromUser]]></FromUserName> <CreateTime>12345678</CreateTime> <MsgType><![CDATA[text]]></MsgType> <Content><![CDATA[content]]></Content> <FuncFlag>0</FuncFlag> </xml>

ParameterDescriptionToUserNamea unique ID for the receiver, you can get it from the requestFromUserNameWeChat ID of your appCreateTimecreate time of the message, the type is integerMsgTypemessage type ("text" for text messages)Contentreply message contentsFuncFlagadd a star for the message if the bit (0x0001) is set

 

Music message

 <xml> <ToUserName><![CDATA[toUser]]></ToUserName> <FromUserName><![CDATA[fromUser]]></FromUserName> <CreateTime>12345678</CreateTime> <MsgType><![CDATA[music]]></MsgType> <Music> <Title><![CDATA[TITLE]]></Title> <Description><![CDATA[DESCRIPTION]]></Description> <MusicUrl><![CDATA[MUSIC_Url]]></MusicUrl> <HQMusicUrl><![CDATA[HQ_MUSIC_Url]]></HQMusicUrl> <ThumbMediaId><![CDATA[media_id]]></ThumbMediaId> </Music> <FuncFlag>0</FuncFlag> </xml>

ParameterDescriptionToUserNamea unique ID for the receiver, you can get it from the requestFromUserNameWeChat ID of your appCreateTimecreate time of the message, the type is integerMsgTypemessage type("music" for music messages)MusicUrlURL for the musicHQMusicUrlURL for high quality, WeChat will access it when using WiFiThumbMediaIdOPTIONAL. You will get this ID after you upload the thumb (80*80) by using the APIFuncFlagadd a star for the message if the bit (0x0001) is set

Rich media messages

 <xml> <ToUserName><![CDATA[toUser]]></ToUserName> <FromUserName><![CDATA[fromUser]]></FromUserName> <CreateTime>12345678</CreateTime> <MsgType><![CDATA[news]]></MsgType> <ArticleCount>2</ArticleCount> <Articles> <item> <Title><![CDATA[title1]]></Title>  <Description><![CDATA[description1]]></Description> <PicUrl><![CDATA[picurl]]></PicUrl> <Url><![CDATA[url]]></Url> </item> <item> <Title><![CDATA[title]]></Title> <Description><![CDATA[description]]></Description> <PicUrl><![CDATA[picurl]]></PicUrl> <Url><![CDATA[url]]></Url> </item> </Articles> <FuncFlag>1</FuncFlag> </xml> 

ParameterDescriptionToUserNamea unique ID for the receiver, you can get it from the requestFromUserNameWeChat ID of your appCreateTimecreate time of the message, the type is integerMsgTypemessage type ("news" for rich media messages)ArticleCountquantity of rich media messages (no larger than 10)Articlescontents of rich media messages. The first item will be displayed in large image by default.Titletitle of the rich media messageDescriptiondescription of the rich media messagePicUrlURL of images in the rich media message. Domain name of this URL should be the same as the one of URL provided in basic info. Recommended image size: 640*320 (large image); 80*80 (small image)Urlredirection link of the rich media message

Notes

1. One user's unique ID is different for different Official Accounts.

2. Recommend you use port 80 for your app server.

Sample code

PHP：Download

 

 

 

PondBay Studio is the Expert of WeChat Development, and has a lots of cases in China, Japan, Europe and US.  The Founder has served the top companies such as China HuaWei and Israel Company.  You can Contact US via email