list contact

interface address:

• /api/contact/list

HTTP request method:

• GET

request params:

• label_id (query, optional): label ID, such as personal/starred/team

• page (query, optional): page number, default 1

• page_count (query, optional): number of items per page, default 100

response code:

• common response

example:

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

response example：

• JSON:

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

create contact

interface address:

• /api/contact/create

HTTP request method:

• POST

request params:

• first_name (form, optional): first name

• last_name (form, optional): last name

• nick_name (form, optional): nickname

• email (form, optional): email

• phone (form, optional): phone

• birthday (form, optional): birthday

• lunar_birthday (form, optional): lunar birthday

• wechat (form, optional): WeChat

• company (form, optional): company

• title (form, optional): job title

• At least one field must be non-empty

response code:

• common response

example:

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

response example：

• JSON:

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

search contact

interface address:

• /api/contact/search

HTTP request method:

• GET or POST

request params:

• Search keyword, etc. (see the implementation)

response code:

• common response

example:

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

response example：

• JSON:

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

update contact

interface address:

• /api/contact/update

HTTP request method:

• POST

request params:

• id (form, required): contact ID

• The other fields are the same as create

response code:

• common response

example:

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

response example：

• JSON:

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

get contact detail

interface address:

• /api/contact/detail/:id

HTTP request method:

• GET

request params:

• id (path): contact ID

response code:

• common response

example:

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

response example：

• JSON:

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

delete contact

interface address:

• /api/contact/delete

HTTP request method:

• POST

request params:

• id (form, required): contact ID

response code:

• common response

example:

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

response example：

• JSON:

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

list contact label

interface address:

• /api/contact/label/list

HTTP request method:

• GET

request params:

response code:

• common response

example:

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

response example：

• JSON:

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

create contact label

interface address:

• /api/contact/label/create

HTTP request method:

• POST

request params:

• name (form, required): label name

response code:

• common response

example:

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

response example：

• JSON:

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

delete contact label

interface address:

• /api/contact/label/deletelabel

HTTP request method:

• POST

request params:

• id (form, required): contact ID, multiple IDs separated by commas

• label_id (form, required): ID of the label to remove

response code:

• common response

example:

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

response example：

• JSON:

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

apply contact label

interface address:

• /api/contact/label/applylabel

HTTP request method:

• POST

request params:

• id (form, required): contact ID, multiple IDs separated by commas

• label_id (form, required): label ID

response code:

• common response

example:

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

response example：

• JSON:

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

modify contact starred state

interface address:

• /api/contact/label/starredstate

HTTP request method:

• POST

request params:

• id (form, required): contact ID

• starred (form, required): starred state, true/false

response code:

• common response

example:

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

response example：

• JSON:

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