Uc pm list
出自Discuz! 技术文库
uc_pm_list
- array uc_pm_list(integer uid [, integer page , integer pagesize , string folder , string filter, integer msglen])
描述
本接口函数用于获取指定文件夹的短消息列表。函数已内置分页，直接通过 page 和 pagesize 即可实现翻页。
参数
| 参数名 | 类型 | 是否必需 | 说明 | 备注 |
| uid | integer | 是 | 用户 ID | |
| page | integer | 否 | 当前页编号，默认值 1 | |
| pagesize | integer | 否 | 每页最大条目数，默认值 10 | |
| folder | string | 否 | 短消息所在的文件夹 | inbox:(默认值)，兼容之前版本，现在仅使用inbox |
| filter | string | 否 | 过滤方式 | newpm:(默认值) 未读消息 |
| msglen | integer | 否 | 截取短消息内容文字的长度，0 为不截取，默认值 0 |
返回值
| 返回值类型 | 说明 | 备注 |
| array | 返回消息总数和消息列表 | 数组结构看下方说明 |
返回值数组结构
| key | 类型 | value |
| count | integer | 消息总数 |
| data | array | 短消息列表数据，其中单条消息数据结构请查看下方 消息列表单条数组结构 |
消息列表单条数组结构
| key | 类型 | value |
| plid | integer | 会话 ID |
| uid | integer | 当前用户 ID |
| isnew | bool | 是否未读标记 |
| pmnum | integer | 该会话相对于当前用户的消息数量 |
| lastupdate | integer | 当前用户的最后更新时间 |
| lastdateline | integer | 会话最后更新时间 |
| authorid | integer | 会话发起者 ID |
| pmtype | integer | 会话类别 1: 私人消息, 2: 群聊消息 |
| subject | string | 标题 |
| members | integer | 会话参与人数 |
| touid | integer | pmtype参数为1时,该返回值表示对方用户 ID |
| tousername | string | pmtype参数为1时,该返回值表示对方用户名 |
| founddateline | integer | 会话发起时间 |
| lastauthorid | integer | 会话最后一条的发送人 ID |
| lastauthor | string | 会话最后一条的发送人用户名 |
| lastsummary | string | 会话最后一条的发送的内容截取 |
| pmid | integer | 消息ID |
| msgfromid | integer | 发件人用户 ID |
| msgfrom | string | 发件人用户名 |
| msgtoid | integer | 收件人用户 ID |
| new | integer | 1:未读短消息 0:已读短消息 |
| message | string | 内容 |
| dateline | integer | 发送时间的时间戳 |
| daterange | integer | 1:今天 2:昨天 3:前天 4:上周 5:更早 |
