外部人员搜索

1.概述

企业员工搜索添加外部人员时，美团企业版通过【外部人员搜索接口】获取企业员工的外部联系人列表，获取结果会在外部人员选择页中展示，引导企业员工添加外部人员。

对接说明：

2.接口基本信息

名称	描述
请求方式	POST
调用地址	客户平台提供
调用方	美团企业版
响应方	客户平台
响应超时时间	3秒， 客户平台需要保证此接口性能与稳定性，避免超时或异常导致员工无法添加外部人员

2.1.请求体

名称	类型	是否必填	示例	说明
accessKey	String	是	B3GFJIEHNEM1RLV-TK	美团企业版分配给客户的接入秘钥
content	String	是	UgxoCGPQIzoP	请求体内容，将请求参数JSON序列化后进行加密的结果值， 参照：签名实例

content加密前数据结构

名称	类型	是否必填	示例	说明
ts	Long	是	1617085650321	13位时间戳。若请求发起时间与平台接受请求时间相差大于10分钟，平台将直接拒绝本次请求
traceId	String	是	-9164046349443560550	日志查询ID
entId	Long	是	46574	企业ID
queryParam	Object	是	见queryParam	业务具体请求内容

queryParam字段说明

名称	类型	是否必填	示例	说明
keyword	String	是	张三	搜索关键词，支持外部人员姓名、公司、部门的模糊搜索
offset	Integer	是	1	偏移数
pageSize	Integer	是	50	分页大小，默认50，最大100

2.2.响应参数

名称	类型	是否必填	示例	说明
traceId	String	是	-9164046349443560550	日志查询ID，用于排查问题
status	Integer	是	0	请求响应状态，0：成功，其他：失败
msg	String	否		错误描述信息
data	String	是	UgxoCGPQIzoP	响应数据，将响应参数JSON序列化后进行加密的结果值，加密秘钥使用secretKey参数，参照：签名实例

data解密后数据结构

类型	是否必填	示例	说明
List<GuestInfo>	是	见GuestInfo	外部人员列表

GuestInfo字段说明

名称	类型	是否必填	示例	说明
guestName	String	是	张三	姓名，不可超过128个字符
guestPhone	String	否	13812345678	手机号，仅支持大陆11位手机号
guestCompany	String	否	xx公司	公司，不可超过128个字符
guestOrg	String	否	xx部门	部门，不可超过128个字符
externalGuestId	String	是	347547381331939330	客户侧针对外部人员的唯一标识(必须为非0开头纯数字，美团侧后续会转换为Long类型处理)

3.示例

3.1.请求示例

3.1.1.请求示例

{
  "accessKey": "B3GFJIEHNEM1RLV-TK",
  "content": "UgJn07uNgW7S7fJK0R0xVbaLxoCGPQIzoP-_K4Hmp4RduGszhm2mbUs2toZhCtXKP5JGXVTZ9kGts2Wx3IJQCd90ptMoJTDB0vu7mkedEr4KZCvZn77EZLssMC5SpXilmQ-5RXHzvMIT0ASH-IXepTP_O16U37QqCkEb5L1WLy4"
}

3.1.2.请求参数content解析

{
  "traceId": "-8783223091504994686",
  "entId": 617,
  "ts": 1621222860,
  "queryParam": {
    "keyword": "张三",
    "offset": 0,
    "pageSize": 50
  }
}

3.2.响应示例

{
  "traceId": "-9164046349443560550",
  "status": 0,
  "msg": null,
  "data": "UgJn07uNgW7S7fJK0R0xVbaLxoCGPQIzoP-_K4Hmp4RduGszhm2mbUs2toZhCtXKP5JGXVTZ9kGts2Wx3IJQCd90ptMoJTDB0vu7mkedEr4KZCvZn77EZLssMC5SpXilmQ-5RXHzvMIT0ASH-IXepTP_O16U37QqCkEb5L1WLy4"
}

data明文示例

[
    {
      "guestName": "张三",
      "guestPhone": "13812345678",
      "guestCompany": "xx公司",
      "guestOrg": "xx部门",
      "externalGuestId": "347547381331939330"
    },
    {
      "guestName": "李四",
      "guestPhone": "13812345600",
      "guestCompany": "xx公司",
      "guestOrg": "xx部门",
      "externalGuestId": "347547381331939331"
    }
]

4.版本记录

版本号	版本日期	更新内容
v1.0	2023-09-15	新增外部人员搜索接口