このAPIのサポートはまもなく終了します。最新バージョンもしくは他のAPIを利用してください。
移行の際、個人アドレス帳にある連絡先のリスト照会
指定したメンバーのマイアドレス帳の連絡先データをエクスポートするために、連絡先のリストを照会します。
★ 注意:この API は他システムからの移行時のみ使用することを推奨します。 |
---|
API の種類
サーバー 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
パラメータ | タイプ | 必須 | 説明 |
---|---|---|---|
targetMemberEmail | String | Y | 対象のメンバーアカウント |
pageIndex | Integer | Y | 照会するページ番号 |
pagePerLength | Integer | Y | 1ページあたりの連絡先の件数 (最大:500個) |
Request Example
"targetMemberEmail": "test@example.com"
"pageIndex": 1
"pagePerLength": 10
Response
呼び出しに成功したら、data値に連絡先のリスト情報がJSON形式で返されます。
プロパティ | タイプ | 説明 |
---|---|---|
totalLength | Integer | 連絡先の総数 |
resultData | List | 連絡先リスト |
contactNo | Long | 連絡先の UUID |
name | String | 名前 |
tel | String | (代表)電話番号 |
String | (代表)メールアドレス | |
organization | String | (代表)会社名 |
department | String | (代表)部署 |
jobTitle | String | (代表)役職 |
photoUrl | String | サムネイル写真の URL |
importantContactYn | String | 重要な連絡先かどうか ● Y: 重要な連絡先 ● N: 一般の連絡先 |
worksAt | Map | 外部ユーザー情報(外部ユーザーの場合のみ返す) |
serviceType | String | 外部ユーザーのタイプ ● line:LINE ユーザー ● worksat:別テナントのユーザー |
worksAtContactNo | Long | 外部ユーザー 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
}