WechatClient | messaging-apis

Hierarchy

WechatClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WechatClient(config: ClientConfig): WechatClient

- Defined in messaging-api-wechat/src/WechatClient.ts:71
Parameters
- config: ClientConfig
Returns WechatClient

Properties

accessToken

accessToken: string = ''

The current access token used by the client.

Readonly axios

axios: AxiosInstance

The underlying axios instance.

Methods

getAccessToken

getAccessToken(): Promise<AccessToken>

- Defined in messaging-api-wechat/src/WechatClient.ts:126
获取 access_token
see
https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140183

example
```
await client.getAccessToken();
// {
//   accessToken: "ACCESS_TOKEN",
//   expiresIn: 7200
// }
```
Returns Promise<AccessToken>
Access token info

getMedia

getMedia(mediaId: string): Promise<Media>

- Defined in messaging-api-wechat/src/WechatClient.ts:221
下载多媒体文件接口
see
https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1444738727

example
```
await client.getMedia(MEDIA_ID);
// {
//   videoUrl: "..."
// }
```
Parameters
- mediaId: string
  ID of the media to get.
Returns Promise<Media>
Info of the media.

sendImage

sendImage(userId: string, mediaId: string, options?: SendMessageOptions): Promise<SucceededResponseData>

- Defined in messaging-api-wechat/src/WechatClient.ts:364
发送图片消息
see
https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Service_Center_messages.html#7

example
```
await client.sendImage(USER_ID, 'MEDIA_ID');
```
Parameters
- userId: string
  User ID of the recipient
- mediaId: string
  ID of the media to be sent.
- Optional options: SendMessageOptions
  The other parameters.
Returns Promise<SucceededResponseData>
Error code and error message.

sendMPNews

sendMPNews(userId: string, mediaId: string, options?: SendMessageOptions): Promise<SucceededResponseData>

- Defined in messaging-api-wechat/src/WechatClient.ts:543
发送图文消息（点击跳转到图文消息页面）

图文消息条数限制在 8 条以内，注意，如果图文数超过 8，则将会无响应。
see
https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Service_Center_messages.html#7

example
```
await client.sendMPNews(USER_ID, 'MEDIA_ID');
```
Parameters
- userId: string
  User ID of the recipient
- mediaId: string
  ID of the media to be sent.
- Optional options: SendMessageOptions
  The other parameters.
Returns Promise<SucceededResponseData>
Error code and error message.

sendMiniProgramPage

sendMiniProgramPage(userId: string, miniProgramPage: MiniProgramPage, options?: SendMessageOptions): Promise<SucceededResponseData>

- Defined in messaging-api-wechat/src/WechatClient.ts:652
发送小程序卡片（要求小程序与公众号已关联）
see
https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Service_Center_messages.html#7

example
```
await client.sendMiniProgramPage(USER_ID, {
  title: 'title',
  appid: 'appid',
  pagepath: 'pagepath',
  thumbMediaId: 'thumb_media_id',
});
```
Parameters
- userId: string
  User ID of the recipient
- miniProgramPage: MiniProgramPage
  Info of the mini program page to be sent.
- Optional options: SendMessageOptions
  The other parameters.
Returns Promise<SucceededResponseData>
Error code and error message.

sendMsgMenu

sendMsgMenu(userId: string, msgMenu: MsgMenu, options?: SendMessageOptions): Promise<SucceededResponseData>

- Defined in messaging-api-wechat/src/WechatClient.ts:587
发送菜单消息
see
https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Service_Center_messages.html#7

example
```
await client.sendMsgMenu(USER_ID, {
  headContent: 'HEAD',
  list: [
    {
      id: '101',
      content: 'Yes',
    },
    {
      id: '102',
      content: 'No',
    },
  ],
  'tailContent': 'Tail',
});
```
Parameters
- userId: string
  User ID of the recipient
- msgMenu: MsgMenu
  Data of the msg menu to be sent.
- Optional options: SendMessageOptions
  The other parameters.
Returns Promise<SucceededResponseData>
Error code and error message.

sendMusic

sendMusic(userId: string, music: Music, options?: SendMessageOptions): Promise<SucceededResponseData>

- Defined in messaging-api-wechat/src/WechatClient.ts:466
发送音乐消息
see
https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Service_Center_messages.html#7

example
```
await client.sendMusic(USER_ID, {
  musicurl: 'MUSIC_URL',
  hqmusicurl: 'HQ_MUSIC_URL',
  thumbMediaId: 'THUMB_MEDIA_ID',
  title: 'MUSIC_TITLE',
  description: 'MUSIC_DESCRIPTION',
});
```
Parameters
- userId: string
  User ID of the recipient
- music: Music
- Optional options: SendMessageOptions
  The other parameters.
Returns Promise<SucceededResponseData>
Error code and error message.

sendNews

sendNews(userId: string, news: News, options?: SendMessageOptions): Promise<SucceededResponseData>

- Defined in messaging-api-wechat/src/WechatClient.ts:512
发送图文消息（点击跳转到外链）

图文消息条数限制在 8 条以内，注意，如果图文数超过 8，则将会无响应。
see
https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Service_Center_messages.html#7

example
```
await client.sendNews(USER_ID, {
  articles: [
    {
      title: 'Happy Day',
      description: 'Is Really A Happy Day',
      url: 'URL',
      picurl: 'PIC_URL',
    },
    {
      title: 'Happy Day',
      description: 'Is Really A Happy Day',
      url: 'URL',
      picurl: 'PIC_URL',
    },
  ],
});
```
Parameters
- userId: string
  User ID of the recipient
- news: News
  Data of the news to be sent.
- Optional options: SendMessageOptions
  The other parameters.
Returns Promise<SucceededResponseData>
Error code and error message.

sendRawBody

sendRawBody(body: ({ touser: string } & SendMessageOptions & { msgtype: "text"; text: { content: string } }) & ({ touser: string } & SendMessageOptions & { image: { mediaId: string }; msgtype: "image" }) & ({ touser: string } & SendMessageOptions & { msgtype: "voice"; voice: { mediaId: string } }) & ({ touser: string } & SendMessageOptions & { msgtype: "video"; video: Video }) & ({ touser: string } & SendMessageOptions & { msgtype: "music"; music: Music }) & ({ touser: string } & SendMessageOptions & { msgtype: "news"; news: News }) & ({ touser: string } & SendMessageOptions & { mpnews: { mediaId: string }; msgtype: "mpnews" }) & ({ touser: string } & SendMessageOptions & { msgmenu: MsgMenu; msgtype: "msgmenu" }) & ({ touser: string } & SendMessageOptions & { msgtype: "wxcard"; wxcard: { cardId: string } }) & ({ touser: string } & SendMessageOptions & { miniprogrampage: MiniProgramPage; msgtype: "miniprogrampage" })): Promise<SucceededResponseData>

- Defined in messaging-api-wechat/src/WechatClient.ts:244
发送消息-客服消息

internal
see
https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Service_Center_messages.html#7

Parameters
- body: ({ touser: string } & SendMessageOptions & { msgtype: "text"; text: { content: string } }) & ({ touser: string } & SendMessageOptions & { image: { mediaId: string }; msgtype: "image" }) & ({ touser: string } & SendMessageOptions & { msgtype: "voice"; voice: { mediaId: string } }) & ({ touser: string } & SendMessageOptions & { msgtype: "video"; video: Video }) & ({ touser: string } & SendMessageOptions & { msgtype: "music"; music: Music }) & ({ touser: string } & SendMessageOptions & { msgtype: "news"; news: News }) & ({ touser: string } & SendMessageOptions & { mpnews: { mediaId: string }; msgtype: "mpnews" }) & ({ touser: string } & SendMessageOptions & { msgmenu: MsgMenu; msgtype: "msgmenu" }) & ({ touser: string } & SendMessageOptions & { msgtype: "wxcard"; wxcard: { cardId: string } }) & ({ touser: string } & SendMessageOptions & { miniprogrampage: MiniProgramPage; msgtype: "miniprogrampage" })
Returns Promise<SucceededResponseData>

sendText

sendText(userId: string, text: string, options?: SendMessageOptions): Promise<SucceededResponseData>

- Defined in messaging-api-wechat/src/WechatClient.ts:333
发送文本消息
see
https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Service_Center_messages.html#7

example
```
await client.sendText(USER_ID, 'Hello!');
```
Parameters
- userId: string
  User ID of the recipient
- text: string
  Text to be sent.
- Optional options: SendMessageOptions
  The other parameters.
Returns Promise<SucceededResponseData>
Error code and error message.

sendVideo

sendVideo(userId: string, video: Video, options?: SendMessageOptions): Promise<SucceededResponseData>

- Defined in messaging-api-wechat/src/WechatClient.ts:431
发送视频消息
see
https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Service_Center_messages.html#7

example
```
await client.sendVideo(USER_ID, {
  mediaId: 'MEDIA_ID',
  thumbMediaId: 'THUMB_MEDIA_ID',
  title: 'VIDEO_TITLE',
  description: 'VIDEO_DESCRIPTION',
});
```
Parameters
- userId: string
  User ID of the recipient
- video: Video
  Info of the video to be sent.
- Optional options: SendMessageOptions
  The other parameters.
Returns Promise<SucceededResponseData>
Error code and error message.

sendVoice

sendVoice(userId: string, mediaId: string, options?: SendMessageOptions): Promise<SucceededResponseData>

- Defined in messaging-api-wechat/src/WechatClient.ts:395
发送语音消息
see
https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Service_Center_messages.html#7

example
```
await client.sendVoice(USER_ID, 'MEDIA_ID');
```
Parameters
- userId: string
  User ID of the recipient
- mediaId: string
  ID of the media to be sent.
- Optional options: SendMessageOptions
  The other parameters.
Returns Promise<SucceededResponseData>
Error code and error message.

sendWXCard

sendWXCard(userId: string, cardId: string, options?: SendMessageOptions): Promise<SucceededResponseData>

- Defined in messaging-api-wechat/src/WechatClient.ts:616
发送卡券
see
https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Service_Center_messages.html#7

example
```
await client.sendWXCard(USER_ID, '123dsdajkasd231jhksad');
```
Parameters
- userId: string
  User ID of the recipient
- cardId: string
  ID of the card to be sent.
- Optional options: SendMessageOptions
  The other parameters.
Returns Promise<SucceededResponseData>
Error code and error message.

uploadMedia

uploadMedia(type: MediaType, media: Buffer | ReadStream): Promise<UploadedMedia>

- Defined in messaging-api-wechat/src/WechatClient.ts:178
多媒体文件上传接口
see
https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1444738726

example
```
const fs = require('fs');

const buffer = fs.readFileSync('test.jpg');

await client.uploadMedia('image', buffer);
// {
//   type: 'image',
//   mediaId: 'MEDIA_ID',
//   createdAt: 123456789
// }
```
Parameters
- type: MediaType
  Type of the media to upload.
- media: Buffer | ReadStream
  Buffer or stream of the media to upload.
Returns Promise<UploadedMedia>
Info of the uploaded media.

Static connect

connect(config: ClientConfig): WechatClient

- Defined in messaging-api-wechat/src/WechatClient.ts:33
deprecated
Use new WechatClient(...) instead.

Parameters
- config: ClientConfig
Returns WechatClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

config: ClientConfig

Returns WechatClient

Properties

accessToken

Readonly axios

Methods

getAccessToken

Returns Promise<AccessToken>

getMedia

Parameters

mediaId: string

Returns Promise<Media>

sendImage

Parameters

userId: string

mediaId: string

Optional options: SendMessageOptions

Returns Promise<SucceededResponseData>

sendMPNews

Parameters

userId: string

mediaId: string

Optional options: SendMessageOptions

Returns Promise<SucceededResponseData>

sendMiniProgramPage

Parameters

userId: string

miniProgramPage: MiniProgramPage

Optional options: SendMessageOptions

Returns Promise<SucceededResponseData>

sendMsgMenu

Parameters

userId: string

msgMenu: MsgMenu

Optional options: SendMessageOptions

Returns Promise<SucceededResponseData>

sendMusic

Parameters

userId: string

music: Music

Optional options: SendMessageOptions

Returns Promise<SucceededResponseData>

sendNews

Parameters

userId: string

news: News

Optional options: SendMessageOptions

Returns Promise<SucceededResponseData>

sendRawBody

Parameters

Returns Promise<SucceededResponseData>

sendText

Parameters

userId: string

text: string

Optional options: SendMessageOptions

Returns Promise<SucceededResponseData>

sendVideo

Parameters

userId: string

video: Video

Optional options: SendMessageOptions

Returns Promise<SucceededResponseData>

sendVoice

Parameters

userId: string

mediaId: string

Optional options: SendMessageOptions

Returns Promise<SucceededResponseData>

sendWXCard

Parameters

userId: string