WeChat Message Types
There are various types of message content that can be sent to your users:
Text
{
type: "TEXT",
text: "Hello World!",
}
Property | Description | Required |
---|---|---|
type | TEXT | Y |
text | String | Y |
Image
{
type: "IMAGE",
url: "http://image.png",
mediaId: "SomeStringId",
}
Property | Description | Required |
---|---|---|
type | IMAGE | Y |
url | URL of the image file | Y |
mediaId | String; WeChat-specific | N |
Tips:
- Image must be a valid image file format, including
.jpg
,.jpeg
and.png
- Maximum file size is 25MB
Audio
{
type: "AUDIO",
url: "http://audio.mp3",
mediaId: "SomeStringId",
}
Property | Description | Required |
---|---|---|
type | AUDIO | Y |
url | URL of the audio file | Y |
mediaId | String; WeChat-specific | N |
Tips:
- Audio must be a valid audio file format, including
.mp3
- Maximum audio size is 25MB
Video
{
type: "VIDEO",
url: "http://video.mp4",
mediaId: "SomeMediaId",
thumbMediaId: "SomeMediaId",
title: "Some title",
description: "Some description",
}
Property | Description | Required |
---|---|---|
type | VIDEO | Y |
url | URL of the video file | Y |
mediaId | String; WeChat-specific | N |
thumbMediaId | String; WeChat-specific | N |
title | String; WeChat-specific | N |
description | String; WeChat-specific | N |
Tips:
- 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
Property | Description | Required |
---|---|---|
type | NEWS | Y |
articles | Maximum 1 article objects | Y |
Articles Object
Property | Description | Required |
---|---|---|
title | String; WeChat-specific | N |
description | String; WeChat-specific | N |
url | URL of the article | Y |
picurl | URL of the image file | Y |
urlTracking | Set "true" or "false"; Defaults to "true" | N |
Tips:
- Image must be a valid image file format, including
.jpg
,.jpeg
and.png
- Maximum file size is 25MB