本页介绍了和云之家基础消息能力相关的JS-API方法,开发者可以根据应用的需求进行相应的配置。本页方法会不定期更新以满足更多应用个性化的开发需求。如果您有什么需求,欢迎在云之家开发者交流社区留言反馈,我们会根据您的需求进行优化。
调用代码:
qing.call('chat', {
'openId':'ge6sjw12sda2scdfefe2',
'success': function(result){}
});
参数说明:
| 参数名称 | 数据类型 | 必选 | 说明 |
|---|---|---|---|
| openId | string | 与groupId二选一 | 云之家账号体系下对话人的用户ID。 |
| groupId | string | 与openId二选一 | 会话组ID。 |
| draft | string | 否 | 打开会话传入的草稿,会预置在聊天会话消息发送框。 |
回调说明:
{
success: true or false 是否成功(string)
error: 错误信息(String)
errorCode: 错误码(int)
data:
}
调用代码:轻应用转发信息给用户或聊天组
qing.call("share", {
"shareType":"4",
"appId":"XXX",
"appName":"XXX",
"lightAppId":"XXX",
"title":"XXX",
"content":"XXX",
"thumbData":"XXX",
"webpageUrl":"XXX",
"cellContent":"XXX",
"sharedObject":"XXX",
"callbackUrl":"XXX",
"selected":['aaa','bbb'],
"success": function(result){}
});
参数说明:
| 参数名称 | 数据类型 | 必选 | 说明 |
|---|---|---|---|
| shareType | string | 是 | 转发类型,目前仅支持4,表示轻应用转发信息。 |
| appId | string | 是 | 轻应用ID或公共号ID,当为轻应用时传轻应用ID;当为公共号时传公共号ID。 |
| appName | string | 是 | 轻应用名称或公共号名称,当为轻应用时传轻应用名称;当为公共号时传公共号名称。 |
| theme | string | 否 | 主题(可选),如传入,创建组时以此命名组名称。 |
| lightAppId | string | 否 | 轻应用ID(如果需要获取ticket,则必须传入此参数)。 |
| title | string | 是 | 新闻标题。 |
| content | string | 是 | 新闻内容。 |
| thumbData | string | 否 | 新闻缩略图,使用Base64编码,大小不要超过32k,否则消息发送失败,分辨率推荐198*198,图片格式推荐使用jpg |
| webpageUrl | string | 是 | 新闻的url。 |
| cellContent | string | 是 | 在聊天界面显示的内容。 |
| sharedObject | string | 是 | 转发的对象:all(所有),group(组),person(人)。 |
| selected | array(string) | 否 | 选择人员的openid |
| callbackUrl | string | 否 | 回调接口,可选。 如果轻应用传了此字段,客户端在转发消息之前(用户选择群组之后)会先调用此接口,并且将参数(groupId、eId、openId、content)以POST方式(contentType:application/x-www-form-urlencoded)回传给轻应用。 此接口处理完业务后需返回: {“data”:“id=3dsfj7322jfnbg20s3d2”,“error”: null,“errorCode”: 0,“success”: true }客户端取到data中的数据后接到webpageUrl后面,最终发送的消息中的链接会变成轻应用传过来的webpageUrl+data里的值。 |
| callbackParam | object({key: value}) | 否 | 仅桌面端支持,回调callbackUrl时需要传入的额外参数及参数值 |
回调说明:
{
success: true or false 是否成功(string)
error: 错误信息(String)
errorCode: 错误码(int)
data:
}