列出联系人

接口地址：

  • /api/contact/list

HTTP请求方式

  • GET

请求参数

  • label_id (query, optional): 标签 ID，如个人/星标/团队等

  • page (query, optional): 页码，默认 1

  • page_count (query, optional): 每页条数，默认 100

响应代码

  • 共通响应

示例:

curl -X GET "$BASE_URL/api/contact/list?label_id=1&page=1&page_count=20"

响应示例：

  • JSON:

    {
  "data": { "list": [ { "id": "1", "name": "", "email": "", "phone": "" } ] },
  "code": 0,
  "message": "OK",
  "ts": 1234567890
}

创建联系人

接口地址：

  • /api/contact/create

HTTP请求方式

  • POST

请求参数

  • first_name (form, optional): 名

  • last_name (form, optional): 姓

  • nick_name (form, optional): 昵称

  • email (form, optional): 邮箱

  • phone (form, optional): 电话

  • birthday (form, optional): 生日

  • lunar_birthday (form, optional): 农历生日

  • wechat (form, optional): 微信

  • company (form, optional): 公司

  • title (form, optional): 职位

  • 至少一项非空

响应代码

  • 共通响应

示例:

curl -X POST "$BASE_URL/api/contact/create" -d "first_name=John&last_name=Doe&email=john@example.com"

响应示例：

  • JSON:

    {
  "data": {},
  "code": 0,
  "message": "OK",
  "ts": 1234567890
}

搜索联系人

接口地址：

  • /api/contact/search

HTTP请求方式

  • GET 或 POST

请求参数

  • 查询关键词等（见实现）

响应代码

  • 共通响应

示例:

curl -X POST "$BASE_URL/api/contact/search" -d "keyword=john"

响应示例：

  • JSON:

    {
  "data": { "list": [] },
  "code": 0,
  "message": "OK"
}

更新联系人

接口地址：

  • /api/contact/update

HTTP请求方式

  • POST

请求参数

  • id (form, required): 联系人 ID

  • 其他字段同 create

响应代码

  • 共通响应

示例:

curl -X POST "$BASE_URL/api/contact/update" -d "id=1&first_name=Jane"

响应示例：

  • JSON:

    {
  "code": 0,
  "message": "OK"
}

获取联系人详情

接口地址：

  • /api/contact/detail/:id

HTTP请求方式

  • GET

请求参数

  • id (path): 联系人 ID

响应代码

  • 共通响应

示例:

curl -X GET "$BASE_URL/api/contact/detail/1"

响应示例：

  • JSON:

    {
  "data": { "id": "1", "name": "", "email": "", "phone": "", "company": "" },
  "code": 0,
  "message": "OK"
}

删除联系人

接口地址：

  • /api/contact/delete

HTTP请求方式

  • POST

请求参数

  • id (form, required): 联系人 ID

响应代码

  • 共通响应

示例:

curl -X POST "$BASE_URL/api/contact/delete" -d "id=1"

响应示例：

  • JSON:

    {
  "code": 0,
  "message": "OK"
}

列出联系人标签

接口地址：

  • /api/contact/label/list

HTTP请求方式

  • GET

请求参数
响应代码

  • 共通响应

示例:

curl -X GET "$BASE_URL/api/contact/label/list"

响应示例：

  • JSON:

    {
  "data": [ { "id": "1", "name": "" } ],
  "code": 0,
  "message": "OK"
}

创建联系人标签

接口地址：

  • /api/contact/label/create

HTTP请求方式

  • POST

请求参数

  • name (form, required): 标签名称

响应代码

  • 共通响应

示例:

curl -X POST "$BASE_URL/api/contact/label/create" -d "name=同事"

响应示例：

  • JSON:

    {
  "code": 0,
  "message": "OK",
  "data": {}
}

删除联系人标签

接口地址：

  • /api/contact/label/deletelabel

HTTP请求方式

  • POST

请求参数

  • id (form, required): 联系人 ID，多个用逗号分隔

  • label_id (form, required): 要移除的标签 ID

响应代码

  • 共通响应

示例:

curl -X POST "$BASE_URL/api/contact/label/deletelabel" -d "id=1&label_id=2"

响应示例：

  • JSON:

    {
  "code": 0,
  "message": "OK"
}

应用联系人标签

接口地址：

  • /api/contact/label/applylabel

HTTP请求方式

  • POST

请求参数

  • id (form, required): 联系人 ID，多个用逗号分隔

  • label_id (form, required): 标签 ID

响应代码

  • 共通响应

示例:

curl -X POST "$BASE_URL/api/contact/label/applylabel" -d "id=1,2&label_id=3"

响应示例：

  • JSON:

    {
  "code": 0,
  "message": "OK"
}

修改联系人星标状态

接口地址：

  • /api/contact/label/starredstate

HTTP请求方式

  • POST

请求参数

  • id (form, required): 联系人 ID

  • starred (form, required): 星标状态，true/false

响应代码

  • 共通响应

示例:

curl -X POST "$BASE_URL/api/contact/label/starredstate" -d "id=1&starred=true"

响应示例：

  • JSON:

    {
  "code": 0,
  "message": "OK"
}