@steedos/yunzhijia
v1.0.3
Published
<!-- * @Author: [email protected] * @Date: 2024-03-01 09:49:05 * @LastEditors: [email protected] * @LastEditTime: 2024-03-01 09:49:22 * @Description: -->
Keywords
Readme
云之家SSO登录和发送公共号消息sendIM
SSO登录 Rest
/api/yunzhijia/login
- ticket 由云之家跳转的时候传递
送公共号消息sendIM
yunzhijia.sendIM
sendIM方法的参数说明
sendIM 方法用于发送消息,其参数对象ctx.params包含以下属性:
innerTos:IInnerTo[]- 描述: 接收消息的目标列表。
- 类型: 数组,每个元素是一个
IInnerTo对象。 - 结构:
user?:string[]- 接收消息的用户openid列表。code?: "all" - 群发所有用户。
type:MsgType- 描述: 消息类型。
- 类型: 枚举值,定义在
MsgType中。 - 可能的值:
- 2 - 纯文本信息。
- 5 - 文本链接信息。
- 6 - 图文混排信息。
msgs:IInnerMsg[]- 描述: 消息内容列表。
- 类型: 数组,每个元素是一个
IInnerMsg对象。 - 结构:
date?:string- 消息日期。title?:string- 消息标题。text:string- 消息文本。url?:string- 消息链接。name?:string- 消息名称。pic?:string- 消息图片。
model?:MsgModel- 描述: 消息模型(仅在
type为MIXED时使用)。 - 类型: 枚举值,定义在
MsgModel中。 - 可能的值:
1- 单条文本编排模板。2- 单条图文混排模板。3- 多条图文混排模板。
- 描述: 消息模型(仅在
示例
ctx.params = {
innerTos: [
{ user: ['667aaa5dd5de8eb92bbc7cdc', '337aaa5dd5de8eb92bbc7cdd'] }
],
type: 2,
msgs: [
{ text: 'Hello, world!' }
]
};
sendIM(ctx);注意事项
innerTos和msgs是必填项。type必须是MsgType枚举中的一个值。- 当
type为MIXED时,model是可选项,但建议提供以确保消息格式正确。
