Appearance
获取邀请信息
1 接口名称
获取邀请信息
2 接口描述
- 无
3 请求地址
plain
{apiAddress}/openapi/v2/invite_list?connectNo=e000b5743a866438&signature=5ed2a7c0186258e8023bd357c15e6fec&mobile=18912345737&appkey=cblzs&noncestr=1673233804133×tamp=1673233804133
4 请求方式
GET
5 请求参数
5.1 Query Params 参数
编号 | 字段 | 类型 | 说明 | 是否必须 |
---|---|---|---|---|
1 | inviter_id | String | 邀请人用户id(1,2,3必须有一个有值) | 否 |
2 | department | String | 部门名称(1,2,3必须有一个有值) | 否 |
3 | mobile | String | 手机号(多个手机号用英文逗号隔开,一次最多100个)(1,2,3必须有一个有值) | 否 |
4 | connectNo | String | 约定的通信connectNo(区别用户) | 是 |
5 | start | Integer | 开始时间戳(13位的毫秒时间戳) | 否 |
6 | end | Integer | 结束时间戳(13位的毫秒时间戳) | 否 |
7 | page | Integer | 页数 | 否 |
8 | size | Integer | 每页记录数(最多100条) | 否 |
6 返回参数
6.1参数描述
字段 | 类型 | 必有 | 说明 | |
---|---|---|---|---|
id | int | 是 | 记录id | |
invitee_id | string | 是 | 被邀请人id | |
invitee_nick_name | string | 是 | 被邀请人昵称 | |
register_time | string | 是 | 被邀请人注册时间(时间戳) | |
inviter_id | string | 否 | 邀请人id | |
inviter_nick_name | string | 否 | 邀请人昵称 | |
invite_time | string | 是 | 邀请日期 | |
invitee_phone | string | 是 | 被邀请人手机号 | |
department_name | string | 是 | 部门名称 | |
status | int | 是 | 邀请状态-1为待下载,0为成功 |
6.2参数示例
json
{
"code": 0,
"data": {
"listInvite": []
}
}
7 备注
成功返回code是0,非0时均为失败。