文本消息2 | 概述

文本消息(text2)

请求说明

Https请求方式: POST

https://bee.quanshi.com/ucopenapi/appmsg/text2/send

给指定用户发送特定应用的文本消息；每个消息最多20个接收人、10个部门接收人。

请求参数

{
   "username": "administrator@quanshi.com",
   "token":  "297ba84a-ed1d-4c35-a04f-ca40d6f0946e",
   "data": 
   { 
      "siteId":123123, // 所在site的ID号，默认可以不填。
      "toUsers": 
      [
         "test100.dev@quanshi.com", 
         "test100.dev@quanshi.com"
      ],
      "toPartyIds":[
         123,345
      ],
      "appId": 8,
      "title": "消息标题",
      "content": "消息内容",
      "detailType":0, 0:文本,1:URL;(后期可能固定为URL)
      "detailContent": "消息详情内容",
      "detailAuth"：1
   }
}

参数名称	类型	可选	说明
username	String	选填	第三方应用登录，此字段不填，下面各个API接口同此定义。
token	String	必填	登陆成功的凭证
data	数据结构	必填	要发送消息的数据封装
data.siteId	int	选填	内部应用可不填，第三方应用必填
data.toUsers	字符串数组	选填	接收人数组，每条消息不能超过5个；如果接收人是”@all”, 直接向整个根部门发送消息
data.toPartyIds	整形数组	选填	接收部门ID，不超过10个。接收部门和接收人不能同时为空
data.appId	int	必填	应用服务器的ID标识，由"管理中心"提供
data.title	String	选填	消息标题
data.content	String	必填	消息内容
data.detailType	int	必填	消息详情内容格式0：文本，1：URL;(后期可能固定为URL)
data.detailContent	String	选填	消息详情, 如果是URL，客户端直接打开这个URL
data.detailAuth	int	选填	打开URL方式，1: 以统一认证的方式打开； 0：直接打开(默认)

返回结果

{
   "errorCode" : 0,
   "data" : [ 
       {
         "errorCode" : 0,
         "toUser" : "test100.dev@quanshi.com",
         "errorMessage" : null
       }, {
         "errorCode" : 0,
         "toUser" : "test101.dev@quanshi.com",
         "errorMessage" : null
      }
   ],
   "errorMessage" : "Successful!",
   "requestId" : "9376c0d5-ae6e-4753-ba6d-3fc916ce1f4c"
}

参数名称	类型	可选	说明
errorCode	int	必填	0表示成功
data	数据结构	必填	消息的每个接收主体（账号/部门）的发送结果
errorMessage	String	必填	执行结果，同errorCode匹配
requestId	String	必填	本次请求的唯一编号用