1. 搜索联系人接口

接口名称 搜索联系人
功能描述 搜索联系人(服务端不需要搜索匹配常用联系人)
请求地址 http://qy-ci.fdccloud.com/api/wzs/search-contact?access_token=@access_token
请求方式 POST(HTTPS)

请求包结构

{
    "address_range":0,
    "group_id":"",
    "keyword":"zhang",
    "search_mode":"view",
    "wzs_user_id": "@wzs_user_id",
    "tenant_id": "@tenant_id",
    "version_name": "3.9.0",
    "device_id ": "@device_id",
    "device_name": "iPhone 11 Pro",
    "device_token": "@device_token",
    "platform": 1,
    "push_channel": 1,
    "os_version": "13.1",
    "__language__": "zh-CN",
    "device_id": "@device_id"
}

参数说明

参数 中文名 参数类型 说明
address_range 通讯录返回的范围 int 0:返回主通讯录和外部联系人,1:只返回主通讯录,没传或者传空默认当0处理
group_id 分组id String 如果有分组id,表明只查询对应分组下的所有数据,如果没有分组id,则返回所有分组信息,并且每个分组下最多返回5条数据
keyword 搜索关键字 String 支持中文
search_mode 搜索模式 String view,select,view模式下,服务端需要结合联系人标签是否隐藏来返回搜索结果,select模式下,直接返回搜索结果

返回结果

{
    "success": 1,
    "data": {
        "code": 1,
        "message": "",
        "group": [{
            "group_name": "总部",
            "group_id": "40",
            "org_id": "40",
            "total_count": 176,
            "contacts": [{
                "openid": "mysoft5dedad5268a2d791560356",
                "name": "张丽",
                "phone": "",
                "avatar": "https://oss-mytest.oss-cn-hangzhou.aliyuncs.com/0000/fileupload/f79d71c8e1024560292c3b58783bb34f.jpg",
                "dept": "深圳明源综管部",
                "id": "222753",
                "org_user_id": "49075905-57e8-43ee-8f07-e5c7a29e2906",
                "im": {
                    "im_user_id": ""
                },
                "wzs_user_id": "wzs5dedad52e7e52015245344",
                "tenant_id": "my56a9c966df069",
                "belong_dept": [{
                    "yzs_order_hierarchy_code": "10000.10011.10003",
                    "dept_name": "深圳明源综管部"
                }, {
                    "yzs_order_hierarchy_code": "10000.10000",
                    "dept_name": "集团管理层"
                }]
            }]
        }, {
            "group_name": "采购助手",
            "group_id": "52",
            "org_id": "52",
            "total_count": 54,
            "contacts": [{
                "openid": "mysoft59e860b38a0f2407127040",
                "name": "董事长X",
                "phone": "FC5dYxvJektL/mLCbV39BA==",
                "avatar": "",
                "dept": "采购助手",
                "id": "161524",
                "org_user_id": "195126",
                "im": {
                    "im_user_id": ""
                },
                "wzs_user_id": "wzs59e860b38be30056966626",
                "tenant_id": "my56a9c966df069"
            }]
        }]
    }
}

参数说明

参数 类型 描述
belong_dept object 所属部门信息
belong_dept.yzs_order_hierarchy_code string 层级code
belong_dept.dept_name string 部门名称
org_user_id string 个人id
org_id string 组织id
phone string 联系人手机号码
im_user_id string 用户在im账号体系中的id
wzs_user_id string 云助手平台用户id

results matching ""

    No results matching ""