Skip to main content

WeChat Message Types

There are various types of message content that can be sent to your users:

Text

WeChat Text Message
WeChat Text Message
{
type: "TEXT",
text: "Hello World!",
}
PropertyDescriptionRequired
typeTEXTY
textStringY

Image

WeChat Image
WeChat Image
WeChat Image
WeChat Image
{
type: "IMAGE",
url: "http://image.png",
mediaId: "SomeStringId",
}
PropertyDescriptionRequired
typeIMAGEY
urlURL of the image fileY
mediaIdString; WeChat-specificN
note
  • Image must be a valid image file format, including .jpg, .jpeg and .png
  • Maximum file size is 25MB

Audio

WeChat Audio
WeChat Audio
{
type: "AUDIO",
url: "http://audio.mp3",
mediaId: "SomeStringId",
}
PropertyDescriptionRequired
typeAUDIOY
urlURL of the audio fileY
mediaIdString; WeChat-specificN
note
  • Audio must be a valid audio file format, including .mp3
  • Maximum audio size is 25MB

Video

WeChat Video
WeChat Video
WeChat Video
WeChat Video
{
type: "VIDEO",
url: "http://video.mp4",
mediaId: "SomeMediaId",
thumbMediaId: "SomeMediaId",
title: "Some title",
description: "Some description",
}
PropertyDescriptionRequired
typeVIDEOY
urlURL of the video fileY
mediaIdString; WeChat-specificN
thumbMediaIdString; WeChat-specificN
titleString; WeChat-specificN
descriptionString; WeChat-specificN
note
  • Video must be a valid video file format, including .mp4
  • Maximum file size is 25MB

News

{
type: "NEWS",
articles: [{
title: "some title",
description: "hello",
url: "https://sanuker.com",
urlTracking: false,
picurl: "http://img.url"
}]
}
Response Object
PropertyDescriptionRequired
typeNEWSY
articlesMaximum 1 article objectsY
Articles Object
PropertyDescriptionRequired
titleString; WeChat-specificN
descriptionString; WeChat-specificN
urlURL of the articleY
picurlURL of the image fileY
urlTrackingSet "true" or "false"; Defaults to "true"N
note
  • Image must be a valid image file format, including .jpg, .jpeg and .png
  • Maximum file size is 25MB