Get Contact Details

Retrieve details of an internal user, personal contact, or company contacts for NovoOne Client.

Request URL

GET {base_url}/uc-ccontact/api/v1/contacts/detail/{id}

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.
Path parameters
Parameter Required Type Description
id Yes String The ID of the contact to retrieve.
Note: You can obtain the ID using the Query Contacts Directory interface.
Query parameters
Parameter Required Type Description
contactType Yes String

The type of the contact to retrieve.

Valid value:

  • CONTACT_TYPE_USER: Internal users.
  • CONTACT_TYPE_PERSONAL: Personal contacts.
  • CONTACT_TYPE_COMPANY: Company contacts.

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<Contact_Detail> The details of the contact.
Contact_Detail
Parameter Type Description
user Object<Internal_User>
The details of internal user.
Note: This parameter is returned with values when the contact type is CONTACT_TYPE_USER.
personal Object<Contact>
The details of personal contact.
Note: This parameter is returned with values when the contact type is CONTACT_TYPE_PERSONAL.
company Object<Contact>
The details of company contact.
Note: This parameter is returned with values when the contact type is CONTACT_TYPE_COMPANY.
Internal_User
Parameter Type Description
id String The unique identifier of the contact.
extension String The user's extension number.
firstName String The user's first name.
lastName String The user's last name.
email String The user's email address.
mobile String The user's mobile phone number.
jobTitle String The user's job title.
callerId String The caller ID of the user.
avatarUrl String The URL of the user's avatar.
currentPresence String

The user's presence status.

  • AVAILABLE
  • AWAY
  • DND
  • LUNCH
  • BUSINESS_TRIP
  • OFF_WORK
isFavorited Boolean Whether the current user has added the contact to favorites.
online Boolean Whether the user is online.
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.
isFavorited Boolean Whether the current user has added the contact to favorites.

Example

Request example

GET /uc-ccontact/api/v1/contacts/detail/346517262126862336?contactType=CONTACT_TYPE_PERSONAL HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MTc5ODcyMSwiaWF0IjoxNzkxNzc3MTIxLCJqdGkiOiI3YjRmNDQ3MC1jZmI0LTQ3NTAtYTg4Zi01ZjIxNjY5ZDI3NzUiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.Vb9Xw8-vvI689EzR9bl9jrH3BWBDrYPl9c10AzyTv-LjTxxbNdYiz-9k_FBhe3HSqSeLdDXb0py1fzUhJ-e2wIn9Sq2ZeOz4IQAJQwjmyG9-Kk0jy43iyLkcBO7LQxfVQksnKs7hB0cG9FIhoil-FiQL_mUwNHCVN-BnfoN4Dyiyp7BE8nHiehlng4SUQ5zxgQf_JlqALzcP6bNlvp4k1AfjoY2KKQ7H7g9nGSZZZ2fv_j65-j_XJKpLR4ujC7iDH6MezGg8RgOKwHE2HSgtxfiIrHF8wQVhrlKFgCGu1dvszp5mvXPXLy3WnMjuCCidLYI2NvRhfVHd1VzB13XteA
x-tenant-code: jint

Response example

HTTP/1.1 200 OK
{
  "requestId": "975578ef2a3e0f40fa819f461c4702b3",
  "code": "200",
  "message": "SUCCESS",
  "detailMessage": "",
  "result": {
    "personal": {
      "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": "",
      "isFavorited": false
    }
  }
}