服务商代开发
基础
数据与智能专区
应用接收专区通知
连接微信
客户联系
办公
服务商代开发
服务端API
邮件
发送邮件
发送普通邮件
发送普通邮件
最后更新:2023/05/08

应用可以通过该接口发送普通邮件,支持附件能力。

请求方式: POST(HTTPS
请求地址: https://qyapi.weixin.qq.com/cgi-bin/exmail/app/compose_send?access_token=ACCESS_TOKEN

请求包体

{
    "to": {
        "emails": [
            "word@bgjkcsqy.wecom.work",
            "jyan1@tiyantest.wang"   
        ],
        "userids": [
            "william"
        ]
    },
    "cc": {
        "emails": [],
        "userids": ["panyy"]
    },
    "bcc": {
        "emails": ["zoro@bgjkcsqy.wecom.work"],
        "userids": []
    },
    "subject": "这是标题",
    "content": "这是邮件正文",
    "attachment_list": [
        {
            "file_name": "a.txt",
            "content": "BASE64_CONTENT"
        }
    ],
    "enable_id_trans":1
}

参数说明

参数必须类型说明
toobj收件人,to.emails 和 to.userids 至少传一个
to.emailsstring[]收件人,邮箱地址
to.useridsstring[]收件人,企业内成员的userid
ccobj抄送
cc.emailsstring[]抄送人,邮箱地址
cc.useridsstring[]抄送人,企业内成员的userid
bccobj密送
bcc.emailsstring[]密送人,邮箱地址
bcc.useridsstring[]密送人,企业内成员的userid
subjectstring标题
contentstring内容
attachment_listobj[]附件相关
attachment_list[].file_namestring文件名
attachment_list[].contentstring文件内容(base64编码),所有附件加正文的大小不允许超过50M, 且附件个数不能超过200个
content_typestring内容类型 html,text(默认是html)
enable_id_transuint32表示是否开启id转译,0表示否,1表示是,默认0。仅第三方应用需要用到,企业自建应用可以忽略。
目前仅subject、content、attachment_list[].file_name字段支持转译。

id转译模版语法

$departmentName=DEPARTMENT_ID$
$userName=USERID$
$userAlias=USERID$
$userAliasOrName=USERID$

其中 DEPARTMENT_ID 是数字类型的部门id,USERID 是成员账号
譬如,
$departmentName=1$替换成部门id为1对应的部门名,如“企业微信部”;
$userName=lisi007$替换成userid为lisi007对应的用户姓名,如“李四”;
$userAlias=lisi007$替换成userid为lisi007对应的用户别名,如“lisi”;
$userAliasOrName=lisi007$替换成userid为lisi007对应的用户别名或姓名,别名优先级高于姓名,如"lisi";

若输入的模板不符合语法或无效的userid或者部门ID,则不替换该项内容,保留原样
转译userAlias时,如果用户没有别名,则不替换该项内容,保留原样
转译userAliasOrName时,如果用户有别名,则替换为别名;否则,将替换为姓名

 

权限说明

  • 自建应用需配置到“可调用应用”列表中的应用secret所获取的accesstoken来调用(accesstoken如何获取?
  • 第三方应用需具有“邮件”权限
  • 代开发自建应用需具有“邮件”权限

 

返回示例

{
    "errcode": 0,
    "errmsg": "ok"
}

参数说明

参数类型说明
errcodeint32返回码
errmsgstring对返回码的文本描述内容
上一篇概述
下一篇发送日程邮件
    本节内容
服务端API
基础
数据与智能专区
应用接收专区通知
连接微信
客户联系
办公
客户端API
小程序
基础
连接微信
办公
WECOM-JSSDK
JS-SDK
基础
连接微信
办公
更新日志
联系我们