taobao.openim.tribe.sendmsg (发送群消息)

发送群消息,目前支持发送4种类型的群消息,普通文本,图片,语音,自定义消息

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
user User 必须 群消息发送者,只有该群的成员才可以发送群消息
  • └ appkey
  • String
  • 可选
  • demo
  • 用户所属appkey
  • └ taobao_account
  • Boolean
  • 可选
  • false
  • 是否是淘宝账号
  • └ uid
  • String
  • 必须
  • abc
  • 用户id
tribe_id Number 必须 2000000 群id
msg TribeMsg 必须 发送群消息
  • └ at_flag
  • Number
  • 必须
  • 0
  • 是否是at消息, 0表示不是at消息,1表示at指定的用户,2表示at群里所有人
  • atmembers
  • User []
  • 可选
  • 当at_flag=1时,必须指定at的用户
  • └ appkey
  • String
  • 可选
  • demo
  • 用户所属appkey
  • └ taobao_account
  • Boolean
  • 可选
  • false
  • 是否是淘宝账号
  • └ uid
  • String
  • 可选
  • abc
  • 用户id
  • └ custom_push
  • String
  • 可选
  • {"d":"custom push", "sound":"dingdong", "title" : "title"}
  • 自定义push提醒参数,格式为json字符串,该参数为空时,采用系统默认的push;设置该参数时,json字符串必选包含至少包含指定的三个key,"d", "sound", "title"
  • └ media_attrs
  • String
  • 可选
  • {"height": 10, "width": 10, "type": "jpg"}
  • 格式为json字符串, 当消息类型为图片或语音时该参数为必选项,用于描述图片,语音的属性; 该参数json格式必须符合msg_type的要求;当消息类型为图片时,格式必须符合如下样例 : {“height”:10, "width":10, "type":"jpg"},当前支持3三种图片类型,gif, jpg,jpeg; 当消息类型为语音时,必须符合如下样例:{“playtime”:10,”type”:”amr”},语音的type只支持arm
  • └ msg_content
  • String
  • 必须
  • test
  • 文本消息最大长度是4K,图片最大为500K。消息内容格式根据type确定。当type为文本时,内容为文本字符串;当类型为图片或语音时,内容为图片和语音的二进制base64编码生成的字符串;当类型为自定义消息时,内容必须为就送字符串格式,该字符串必须包含header字符,即{"header":{"summary":},...}
  • └ msg_type
  • Number
  • 必须
  • 0
  • 消息类型,目前支持四中类型的消息; msg_type=0 表示普通文本消息; msg_type=2 表示语音消息; msg_type = 16表示图片消息; msg_type=17表示用户自定义消息
  • └ push
  • Boolean
  • 可选
  • true
  • 该消息是否需要push

响应参数

名称 类型 示例值 描述
tribe_code Number 0 错误码
message String success 错误信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpenimTribeSendmsgRequest req = new OpenimTribeSendmsgRequest();
OpenimTribeSendmsgRequest.User obj1 = new OpenimTribeSendmsgRequest.User();
obj1.setAppkey("demo");
obj1.setTaobaoAccount(false);
obj1.setUid("abc");
req.setUser(obj1);
req.setTribeId(2000000L);
OpenimTribeSendmsgRequest.TribeMsg obj2 = new OpenimTribeSendmsgRequest.TribeMsg();
obj2.setAtFlag(0L);
List<OpenimTribeSendmsgRequest.User> list4 = new ArrayList<OpenimTribeSendmsgRequest.User>();
OpenimTribeSendmsgRequest.User obj5 = new OpenimTribeSendmsgRequest.User();
list4.add(obj5);
obj5.setAppkey("demo");
obj5.setTaobaoAccount(false);
obj5.setUid("abc");
obj2.setAtmembers(list4);
obj2.setCustomPush("{\"d\":\"custom push\", \"sound\":\"dingdong\", \"title\" : \"title\"}");
obj2.setMediaAttrs("{\"height\": 10, \"width\": 10, \"type\": \"jpg\"}");
obj2.setMsgContent("test");
obj2.setMsgType(0L);
obj2.setPush(true);
req.setMsg(obj2);
OpenimTribeSendmsgResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<openim_tribe_sendmsg_response>
    <tribe_code>0</tribe_code>
    <message>success</message>
</openim_tribe_sendmsg_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部