首页 > 开发指南 > 发送消息
发送消息
更新时间: 2021-12-08 11:08:53

发送消息

支持消息类型:文本消息、复合消息、图文消息。

发送文本消息

请求说明

请求方式:post+application/json 方式

请求路径:https://open.71360.com/cgi/message/send

参数说明

参数参数类型必须说明
corpAccessTokenString企业应用访问公司合法性凭证
corpIdString开放平台公司账号
toUserList开放平台员工ID列表(消息接收者,目前最多支持500人)
msgTypeString消息类型,取值为:text
text 二级对象,文本内容详情
contentString文本消息内容

请求包结构体示例:

{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId":"CORP_ID",
    "toUser":[
      "TOUSER1",
      "TOUSER2"
    ],
    "msgType":"text",
    "text":{
        "content":"这是一条文本消息"
    }
}

返回说明

参数必须说明
errorCode返回码
errorMessage对返回码的文本描述内容

a) 正确的JSON返回结果示例:

{
    "errorCode": 0,
    "errorMessage": "success"
}

b) 错误的JSON返回示例:

{
    "errorCode": 20016,
    "errorMessage": "corpAccessToken error"
}

发送复合消息

请求说明

请求方式:post+application/json 方式

请求路径:https://open.71360.com/cgi/message/send

参数说明

参数参数类型必须说明
corpAccessTokenString企业应用访问公司合法性凭证
corpIdString开放平台公司账号
toUserList开放平台员工ID列表(消息接收者,目前最多支持500人)
msgTypeString消息类型,取值为:composite
compositeObject二级对象,文本数据详情
composite.head.titleString头部标题
composite.first.contentString内容标题
composite.formList内容列表
composite.form.labelString列表标签
composite.form.valueString列表值
composite.remark.contentString内容摘要
composite.link.titleString点击消息时跳转链接标题
composite.link.urlString点击消息时跳转链接地址

请求包结构体示例:

{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId":"CORP_ID",
    "toUser":[
      "TOUSER1",
      "TOUSER2"
    ],
    "msgType":"composite",
    "composite":{
        "head":{
            "title":"运营日报",
        },
        "first":{
            "content":"红包数据"
        },
        "form":[
            {
                "label":"CRM (日点击次数)",
                "value":"100000"
            },
            {
                "label":"会议助手 (日点击次数)",
                "value":"200000"
            },
            {
                "label":"CRM (日点击次数)",
                "value":"300000"
            },
            {
                "label":"PK助手 (日点击次数)",
                "value":"400000"
            }
        ],
        "remark":{
            "content":"remark"
        },
        "link":{
            "title":"详情",
            "url":"http://www.71360.com"
        }
    }
}

返回说明

参数必须说明
errorCode返回码
errorMessage对返回码的文本描述内容

a)    正确的JSON返回结果示例:

{
    "errorCode": 0,
    "errorMessage": "success"
}

b)    错误的JSON返回示例:

{
    "errorCode": 20016,
    "errorMessage": "corpAccessToken error"
}

发送图文消息

请求说明

请求方式:post+application/json 方式

请求路径:https://open.71360.com/cgi/message/send

参数说明

参数参数类型必须说明
corpAccessTokenString企业应用访问公司合法性凭证
corpIdString开放平台公司账号
toUserList开放平台员工ID列表(消息接收者,目前最多支持500人)
msgTypeString消息类型,取值为:articles
articlesList图文条目列表 ,一次最多允许7条图文消息
articles.titleString标题,最长45个字符
articles.authorString作者,最长8个字符
articles.descriptionString摘要,最长140字符。
articles.coverImageString封面图片对应的mediaId
articles.coverImageInContentBoolean当articles.type为"TEXT"时,内容中是否显示图片(false不包含,true包含,默认false)
articles.typeString图文消息内容类型("TEXT","URL")
articles.contentString图文消息内容,当imageTextType为"URL"时表示链接地址。

请求包结构体示例:

{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId":"CORP_ID",
    "toUser":[
      "TOUSER1",
      "TOUSER2"
    ],
    "msgType":"articles",
    "articles":[
        {
            "title":"这是标题",
            "author":"作者",
            "description":"这是普通文章样例",
            "coverImage":"mediaId",
            "coverImageInContent":true,
            "type":"TEXT",
            "content":"这是文章内容"
        },
        {
            "title":"这是标题",
            "author":"作者",
            "description":"这是跳转样例",
            "coverImage":"mediaId",
            "type":"URL",
            "content":"www.aaa.com"
        }
    ]
}

返回说明

参数必须说明
errorCode返回码
errorMessage对返回码的文本描述内容

a) 正确的JSON返回结果示例:

{
    "errorCode": 0,
    "errorMessage": "success"
}

b) 错误的JSON返回示例:

{
    "errorCode": 20016,
    "errorMessage": "corpAccessToken error"
}