# customerServiceMessage.send

Call this API at the server side. For more information, see Server API.

This API supports Cloud Calls. The WeChat DevTools version must be 1.02.1904090 or later (download the latest stable version here), and the wx-server-sdk version must be 0.4.0 or later.

Sends a customer message to the user. For detailed rules, see Sending a Customer Service Message.

Calling methods:

• HTTPS call
• Cloud call

# HTTPS Call

# Request Address

POST https://api.weixin.qq.com/cgi-bin/message/custom/send?access_token=ACCESS_TOKEN

# Request Parameters

Valid values of msgtype

image is composed as follows

link is composed as follows

miniprogrampage is composed as follows

# Return Value

# Object

JSON data package that is returned

Valid values of errcode

# Message Sending Example

# Sending a text message

{
  "touser":"OPENID",
  "msgtype":"text",
  "text":
  {
    "content":"Hello World"
  }
}

When sending a text message, you can add a text link that can redirect to a Mini Program.

Text content...<a href="http://www.qq.com" data-miniprogram-appid="appid" data-miniprogram-path="pages/index/index">Tap to redirect to the Mini Program</a>

# Description:

1. In data-miniprogram-appid, enter the AppID of the Mini Program. By tapping the link, the user is redirected to the Mini Program.
2. In data-miniprogram-path, enter the path of the Mini Program. The path must be the same as that in app.json and can contain parameters.
3. For WeChat 6.5.16 and earlier that do not support data-miniprogram-appid, if a herf is available, the link in the herf is still used to redirect to the Mini Program.
4. When a Mini Program sends a text message that contains a Mini Program text link, the data-miniprogram-appid must be the AppID of the Mini Program.

# Sending an image message

{
  "touser":"OPENID",
  "msgtype":"image",
  "image": {
    "media_id":"MEDIA_ID"
  }
}

# Sending a message with image/text links

You can send one message with image/text links at a time.

{
  "touser": "OPENID",
  "msgtype": "link",
  "link": {
    "title": "Happy Day",
    "description": "Is Really A Happy Day",
    "url": "URL",
    "thumb_url": "THUMB_URL"
  }
}

# Sending a Mini Program Card

{
 "touser":"OPENID",
 "msgtype":"miniprogrampage",
 "miniprogrampage": {
   "title":"title",
   "pagepath":"pagepath",
   "thumb_media_id":"thumb_media_id"
 }
}

# Cloud Call

Cloud call is a capability provided by Mini Program·Cloud Base that allows you to call WeChat APIs in a cloud function. It must be used via wx-server-sdk in the cloud function.

# API Calling Method

openapi.customerServiceMessage.send

You need to configure the permissions for the customerServiceMessage.send API via config.json. Details

# Request Parameters

Valid values of msgtype

image is composed as follows

link is composed as follows

miniprogrampage is composed as follows

# Return Value

# Object

JSON data package that is returned

Valid values of errCode

# Exceptions

# Object

Thrown Exceptions

Valid values of errCode

# Message Sending Example

# Sending a text message

const cloud = require('wx-server-sdk')
  cloud.init()
  exports.main = async (event, context) => {
    try {
      const result = await cloud.openapi.customerServiceMessage.send({
        touser: 'OPENID',
        msgtype: 'text',
        text: {
          content: 'Hello World'
        }
      })
      console.log(result)
      return result
    } catch (err) {
      console.log(err)
      return err
    }
  }

When sending a text message, you can add a text link that can redirect to a Mini Program.

Text content...<a href="http://www.qq.com" data-miniprogram-appid="appid" data-miniprogram-path="pages/index/index">Tap to redirect to the Mini Program</a>

# Description:

1. In data-miniprogram-appid, enter the AppID of the Mini Program. By tapping the link, the user is redirected to the Mini Program.
2. In data-miniprogram-path, enter the path of the Mini Program. The path must be the same as that in app.json and can contain parameters.
3. For WeChat 6.5.16 and earlier that do not support data-miniprogram-appid, if a herf is available, the link in the herf is still used to redirect to the Mini Program.
4. When a Mini Program sends a text message that contains a Mini Program text link, the data-miniprogram-appid must be the AppID of the Mini Program.

# Sending an image message

const cloud = require('wx-server-sdk')
  cloud.init()
  exports.main = async (event, context) => {
    try {
      const result = await cloud.openapi.customerServiceMessage.send({
        touser: 'OPENID',
        msgtype: 'image',
        image: {
          mediaId: 'MEDIA_ID'
        }
      })
      console.log(result)
      return result
    } catch (err) {
      console.log(err)
      return err
    }
  }

# Sending a message with image/text links

You can send one message with image/text links at a time.

const cloud = require('wx-server-sdk')
  cloud.init()
  exports.main = async (event, context) => {
    try {
      const result = await cloud.openapi.customerServiceMessage.send({
        touser: 'OPENID',
        msgtype: 'link',
        link: {
          title: 'Happy Day',
          description: 'Is Really A Happy Day',
          url: 'URL',
          thumbUrl: 'THUMB_URL'
        }
      })
      console.log(result)
      return result
    } catch (err) {
      console.log(err)
      return err
    }
  }

# Sending a Mini Program Card

const cloud = require('wx-server-sdk')
  cloud.init()
  exports.main = async (event, context) => {
    try {
      const result = await cloud.openapi.customerServiceMessage.send({
        touser: 'OPENID',
        msgtype: 'miniprogrampage',
        miniprogrampage: {
          title: 'title',
          pagepath: 'pagepath',
          thumbMediaId: 'thumb_media_id'
        }
      })
      console.log(result)
      return result
    } catch (err) {
      console.log(err)
      return err
    }
  }