This API will soon be deprecated. Please use another API.
Get Private Contacts during Migration
Gets contacts when a specified user's private contacts are migrated.
★ Caution: It is strongly recommended to use this API only for migration. |
---|
API Type
Server API
Request URL
https://apis.worksmobile.com/migration/{API ID}/contact/listPrivateContact/v1
HTTP Method
POST(Content-Type: application/x-www-form-urlencoded; charset=UTF-8)
Request
Parameter | Type | Required | Description |
---|---|---|---|
targetMemberEmail | String | Y | Email address of a user whose contact information is to be migrated |
pageIndex | Integer | Y | Page number to get |
pagePerLength | Integer | Y | Number of contacts per page (up to 500 contacts) |
Request Example
"targetMemberEmail": "test@example.com"
"pageIndex": 1
"pagePerLength": 10
Response
If the API call is successful, it returns the contact information in JSON format in "data."
Property | Type | Description |
---|---|---|
totalLength | Integer | The number of contacts |
resultData | List | List of contacts |
contactNo | Long | Contact UUID |
name | String | Name |
tel | String | Default phone number |
String | Default email address | |
organization | String | Default company name |
department | String | Default department name |
jobTitle | String | Default position name |
photoUrl | String | Photo thumbnail URL |
importantContactYn | String | Indicates whether it is an important contact or not. ● Y: Important contact ● N: Not an important contact |
worksAt | Map | External contact information (returned only when it is an external contact) |
serviceType | String | External contact type ● line: LINE contact ● worksat: Worksat contact of another domain |
worksAtContactNo | Long | External contact UUID |
Response Example
{
"message": "",
"data": {
"totalLength": 10,
"resultData": [{
"contactNo": 100000000000001,
"name": "Name",
"tel": "000-1111",
"email": "email@test.com",
"organization": "organization",
"department": "department",
"jobTitle": "title",
"photoUrl": "https://api.contact.worksmobile.com/mobile/personalPhoto.nhn?path=111.jpg&type=m320",
"importantContactYn": "N",
"worksAt": {
"serviceType": "line",
"worksAtContactNo": 901000000011000
}
}]
},
"code": "SUCCESS",
"failType": null
}