Search Personal Contacts

Search personal contacts of the current user.

Request URL

POST {base_url}/uc-ccontact/api/v1/personal-contacts/search-page

Request parameters

Headers


Parameter	Required	Type	Description
Authorization	Yes	String	The access token used for authentication. Format: Bearer `{access_token}`.
x-tenant-code	Yes	String	The tenant name. Note: You can obtain tenant name using the Query Tenants interface.

Body parameters


Parameter	Required	Type	Description
pageNumber	Yes	Integer	The page number to retrieve.
pageSize	Yes	Integer	The number of records to retrieve per page.
contactTypes	Yes	Array<String>	The types of contacts to query. Valid value: `CONTACT_TYPE_USER`: Internal users. `CONTACT_TYPE_PERSONAL`: Personal contacts. `CONTACT_TYPE_COMPANY`: Company contacts.
query	No	String	The keyword used to search for contacts.
isFavorited	No	Boolean	Whether to filter contacts by favorite status. Valid value: `true`: Return only the contacts added to favorites. `false`: Return only the contacts not added to favorites. Note: If this parameter is not provided, contacts are returned regardless of their favorite status.
sorts	No	Array<Sort_Condition>	The sort conditions.

Sort_Condition


Parameter	Required	Type	Description
property	No	String	The name of the field to sort by. Valid value: `contact_name` `extension`
direction	No	String	The sort order. Valid value: `asc`: Sort in ascending order. `desc`: Sort in descending order.

Response parameters


Parameter	Type	Description
requestId	String	The unique ID of the request, which can be used to quickly locate the request.
code	String	The HTTP status code of the request. `200`: Request succeeded. Non-200 value: Request failed.
message	String	The status message of the request.
detailMessage	String	The detailed error information. When the request is successful, this parameter returns empty.
result	Object<Search_Result>	The search result of personal contacts.

Search_Result


Parameter	Type	Description
pageSize	Integer	The number of records per page.
pageNumber	Integer	The current page number.
count	String	The total number of matching records.
limit	Integer	The maximum number of personal contacts that can be added.
preference	Object<Tenant_Preference>	The tenant's display preferences.
results	Array<Personal_Contact>	The list of matching personal contacts.

Tenant_Preference


Parameter	Type	Description
nameDisplayFormat	String	The format used to display a contact name. `fls`: First Name Last Name with Space Inbetween `lfs`: Last Name First Name with Space Inbetween `lf`: Last Name First Name without Space Inbetween
phoneFormat	String	The format used to display a phone number. `local`: Display numbers in domestic format, using the area code and local number without the country code. `international`: Display numbers in international format, starting with a plus sign (`+`) followed by the country code, area code, and local number.

Personal_Contact


Parameter	Type	Description
id	String	The unique identifier of the contact.
firstName	String	The contact's first name.
lastName	String	The contact's last name.
company	String	The name of the company to which the contact belongs.
email	String	The contact's email address.
organization	String	The organization or department to which the contact belongs.
jobTitle	String	The contact's job title.
position	String	The contact's position.
industry	String	The industry associated with the contact's organization.
supervisor	String	The contact's supervisor.
remark	String	Additional notes about the contact.
street	String	The street address of the contact.
city	String	The city where the contact's address is located.
state	String	The state or province where the contact's address is located.
country	String	The country where the contact's address is located.
zipCode	String	The postal code for the contact's address.
mobilePhone	String	The contact's primary mobile phone number.
businessPhone	String	The contact's primary business phone number.
homePhone	String	The contact's primary home phone number.
businessFax	String	The contact's primary business fax number.
homeFax	String	The contact's primary home fax number.
mobile2Phone	String	The contact's secondary mobile phone number.
business2Phone	String	The contact's secondary business phone number.
home2Phone	String	The contact's secondary home phone number.
otherPhone	String	The contact's additional phone number.
extension	String	The extension number of the contact. Note: This parameter is returned with a value when the contact type is `CONTACT_TYPE_USER`.
presenceStatus	String	The presence status of the contact (internal user). `AVAILABLE` `AWAY` `DND` `LUNCH` `BUSINESS_TRIP` `OFF_WORK`
avatarUrl	String	The URL of the contact avatar. Note: This parameter returns with a value only when the contact type is `CONTACT_TYPE_USER`.
contactType	String	The type of the contact. `CONTACT_TYPE_USER`: Internal users. `CONTACT_TYPE_PERSONAL`: Personal contacts. `CONTACT_TYPE_COMPANY`: Company contacts.
contactName	String	The display name of the contact.
isFavorited	Boolean	Whether the current user has added the contact to favorites.
online	Boolean	Whether the contact is online. Note: This parameter returns with a value only when the contact type is `CONTACT_TYPE_USER`.

Example

Request example

POST /uc-ccontact/api/v1/personal-contacts/search-page HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MTY0MjQyMiwiaWF0IjoxNzkxNjIwODIyLCJqdGkiOiIyOGE3MmE2YS00N2RkLTQ1MTQtOGI0MC1kNTkzNGI2N2I4NmYiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.W0_22hu-nAYYmB_5evw8lmqlKsYChzcVHH7ZDz4GC0eA2AH6mGu--3v4tnYilWRJGIMQtHVlCe0eGRaBjuwYNEETX7sJOjX8-86qm34eJmgWfjbNGu9wDWA1C-RyFc39Re0AFMXl7Uw5RjhhbdEWLj6QKCKxgUfSZHD-4icUTByZHQ7HhRxwmbGFhV97S6W8fyVGFTuEnf5pIPNfn-nZiHu-z-238gPyKeueDOg_7zKxyGuibzrBthtmrjmYaZzZ2viu-kllZW51UEXAofSOGfbtYmwLEZ4MRMR3-TOPK1ZcBvghKiqGF3zS0sH99THVdhro-LqG7rY-jxW6LhS6Mw
Content-Type: application/json
x-tenant-code: jint
{
  "pageNumber": 1,
  "pageSize": 2,
  "contactTypes": [
    "CONTACT_TYPE_PERSONAL"
  ]
}

Response example

HTTP/1.1 200 OK
{
  "requestId": "8c321a0aa724974c093361abc1135ab6",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "results": [
{
        "id": "346517262126862336",
        "firstName": "judy",
        "lastName": "",
        "company": "",
        "email": "",
        "organization": "",
        "jobTitle": "",
        "position": "",
        "industry": "",
        "supervisor": "",
        "remark": "",
        "street": "",
        "city": "",
        "state": "",
        "country": "",
        "zipCode": "",
        "mobilePhone": "+8615880123456",
        "businessPhone": "",
        "homePhone": "",
        "businessFax": "",
        "homeFax": "",
        "mobile2Phone": "",
        "business2Phone": "",
        "home2Phone": "",
        "otherPhone": "",
        "extension": "",
        "presenceStatus": "AVAILABLE",
        "avatarUrl": "",
        "contactType": "CONTACT_TYPE_PERSONAL",
        "contactName": "judy",
        "isFavorited": false,
        "online": false
      }
    ],
    "count": "1",
    "limit": 0,
    "pageNumber": 1,
    "pageSize": 2,
    "preference": {
      "nameDisplayFormat": "fls",
      "phoneFormat": "international"
    }
  }
}