Description

这是一个发送消息到云之家封装的模块

云之家原始接口文档 https://www.yunzhijia.com/opendocs/docs.html#/server-api/im/pubSend

环境变量

• IM 发送消息环境变量

  B6_YUNZHIJIA_IM_HOST // 发送消息的请求地址 eg: http://xxxxx:80

  B6_YUNZHIJIA_IM_EID // 企业id

  B6_YUNZHIJIA_IM_PUB // 公共号id

  B6_YUNZHIJIA_IM_PUBSERCET // 公共号密钥

  B6_YUNZHIJIA_IM_APPID // 轻应用ID

• 包加载环境变量

  B6_PLUGIN_PACKAGES=@builder6/node-red

  B6_PLUGIN_MODULES=@steedos-labs/yunzhijia-im,@builder6/node-red

@steedos-labs/yunzhijia-im.sendMessage 方法的参数说明

sendMessage 方法用于发送消息，其参数对象包含以下属性：

• innerTos: IInnerTo[]

  • 描述: 接收消息的目标列表。
  • 类型: 数组，每个元素是一个 IInnerTo 对象。
  • 结构 user 和 code 二选一:
    • 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 - 多条图文混排模板。

sendMessage 方法的返回结果

{
  code: 200,
  data: {
    pubId: 'XT-45ad439f-ce77-488a-91c2-6b0bc63dc4b6',
    sourceMsgId: 'XT-6762dc1cd5dec4c2bce2d435'
  },
  message: '发送成功',
  success: true
}

请求示例

const params = {
  innerTos: [
    { user: ['667aaa5dd5de8eb92bbc7cdc', '337aaa5dd5de8eb92bbc7cdd'] }
  ],
  type: 2,
  msgs: [
    { text: 'Hello, world!' }
  ]
};

imService.sendMessage(params);

注意事项

• innerTos 和 msgs 是必填项。
• type 必须是 MsgType 枚举中的一个值。
• 当 type 为 MIXED 时，model 是可选项，但建议提供以确保消息格式正确。