联系人资源类型
命名空间：microsoft.graph
重要
Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。
联系人是 Outlook 中的一个项目，你可以在这里组织和保存有关你通信的人员和组织的信息。 联系人包含在联系人文件夹中。
该资源支持：
方法
| 方法 | 返回类型 | 说明 |
|---|---|---|
| Get | 联系人 | 读取 contact 对象的属性和关系。 |
| 创建 | 联系人 | 将联系人添加到联系人根文件夹或其他联系人文件夹的联系人端点中。 |
| 更新 | 联系人 | 更新 contact 对象。 |
| 删除 | 无 | 删除 contact 对象。 |
| 永久删除 | None | 永久删除联系人并将其置于用户邮箱的“可恢复邮件”文件夹中的“清除”文件夹中。 |
| 获取联系人 Delta | 联系人集合 | 获取指定文件夹中已添加、删除或更新的联系人集。 |
| 开放扩展 | ||
| 创建开放扩展 | openTypeExtension | 创建开放扩展，并将自定义属性添加到新资源或现有资源。 |
| 获取开放扩展 | openTypeExtension 集合 | 获取扩展名称标识的开放扩展。 |
| 扩展属性 | ||
| 创建单值属性 | 联系人 | 在新建或现有的联系人中创建一个或多个单值扩展属性。 |
| 获取单值属性 | 联系人 | 通过使用 $expand 或 $filter 获取包含一个单值扩展属性的联系人。 |
| 创建多值属性 | 联系人 | 在新建或现有的联系人中创建一个或多个多值扩展属性。 |
| 获取多值属性 | 联系人 | 使用 $expand 获取包含一个多值扩展属性的联系人。 |
属性
| 属性 | 类型 | 说明 |
|---|---|---|
| assistantName | String | 联系人助理的姓名。 |
| birthday | DateTimeOffset | 联系人的生日。 时间戳类型表示采用 ISO 8601 格式的日期和时间信息，始终采用 UTC 时区。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z |
| 类别 | String collection | 与联系人关联的类别。 每个类别对应于为用户定义的 outlookCategory 的 displayName 属性。 |
| changeKey | String | 标识联系人的版本。 每次更改联系人时， changeKey 也会更改，这样 Exchange 就可以将更改应用到对象的正确版本。 |
| children | String collection | 联系人子女的姓名。 |
| CompanyName | String | 联系人所在公司的名称。 |
| createdDateTime | DateTimeOffset | 创建联系人的时间。 时间戳类型表示采用 ISO 8601 格式的日期和时间信息，始终采用 UTC 时区。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z |
| department | String | 联系人所在的部门。 |
| displayName | String | 联系人的显示名称。 可以在创建或更新操作中指定显示名称。 以后对其他属性的更新可能会导致自动生成的值覆盖指定的 displayName 值。 若要保留预先存在的值，请始终在更新操作中将其作为 displayName。 |
| emailAddresses | typedEmailAddress 集合 | 联系人的电子邮件地址。 |
| fileAs | String | 联系人备案的姓名。 |
| flag | followupFlag | 指示联系人的状态、开始日期、截止日期或完成日期的标志值。 |
| gender | String | 联系人的性别。 |
| generation | String | 联系人的后缀。 |
| givenName | String | 联系人的名。 |
| id | String | 联系人的唯一标识符。
默认情况下，当项从一个容器（如文件夹或日历）移动到另一个容器时，此值会更改。 若要更改此行为，请使用 Prefer: IdType="ImmutableId"头。 有关详细信息，请参阅获取 Outlook 资源的不可变标识符。 此为只读属性。 |
| imAddresses | String collection | 联系人的即时消息 (IM) 地址。 |
| initials | String | 联系人的姓名缩写。 |
| jobTitle | String | 联系人的职务。 |
| lastModifiedDateTime | DateTimeOffset | 修改联系人的时间。 时间戳类型表示采用 ISO 8601 格式的日期和时间信息，始终采用 UTC 时区。 例如，2014 年 1 月 1 日午夜 UTC 为 2014-01-01T00:00:00Z |
| manager | String | 联系人经理的姓名。 |
| middleName | String | 联系人的中间名。 |
| nickName | String | 联系人的昵称。 |
| officeLocation | String | 联系人的办公室位置。 |
| parentFolderId | String | 联系人的父文件夹 ID。 |
| personalNotes | String | 有关联系人的用户备注。 |
| phones | phone collection | 与联系人关联的电话号码，例如家庭电话、移动电话和商务电话。 |
| postalAddresses | physicalAddress 集合 | 与联系人关联的地址，例如家庭地址和公司地址。 |
| profession | String | 联系人的职业。 |
| spouseName | String | 联系人配偶/伴侣的姓名。 |
| surname | String | 联系人的姓氏。 |
| title | String | 联系人的职位。 |
| websites | website collection | 与联系人关联的网站。 |
| weddingAnniversary | 日期 | 联系人的结婚纪念日。 |
| yomiCompanyName | String | 联系人的注音日文公司名称。 |
| yomiGivenName | String | 联系人的注音日文名字。 |
| yomiSurname | String | 日语拼音姓氏 (联系人) 。 |
关系
| 关系 | 类型 | 说明 |
|---|---|---|
| extensions | 扩展集合 | 为联系人定义的开放扩展集合。 可为 Null。 |
| multiValueExtendedProperties | multiValueLegacyExtendedProperty 集合 | 为联系人定义的多值扩展属性的集合。 只读。 可为 NULL。 |
| photo | 照片 | 可选的联系人照片。 可以获取或设置联系人的照片。 |
| singleValueExtendedProperties | singleValueLegacyExtendedProperty collection | 为联系人定义的单值扩展属性的集合。 只读。 可为 Null。 |
JSON 表示形式
以下 JSON 表示形式显示了资源类型。
{
"assistantName": "string",
"birthday": "String (timestamp)",
"categories": ["string"],
"changeKey": "string",
"children": ["string"],
"companyName": "string",
"createdDateTime": "String (timestamp)",
"department": "string",
"displayName": "string",
"emailAddresses": [{"@odata.type": "microsoft.graph.typedEmailAddress"}],
"fileAs": "string",
"flag": {"@odata.type": "microsoft.graph.followupFlag"},
"gender": "string",
"generation": "string",
"givenName": "string",
"id": "string (identifier)",
"imAddresses": ["string"],
"initials": "string",
"jobTitle": "string",
"lastModifiedDateTime": "String (timestamp)",
"manager": "string",
"middleName": "string",
"nickName": "string",
"officeLocation": "string",
"parentFolderId": "string",
"personalNotes": "string",
"phones": [{"@odata.type": "microsoft.graph.phone"}],
"postalAddresses": [{"@odata.type": "microsoft.graph.physicalAddress"}],
"profession": "string",
"spouseName": "string",
"surname": "string",
"title": "string",
"websites": [{"@odata.type": "microsoft.graph.website"}],
"weddingAnniversary": "date",
"yomiCompanyName": "string",
"yomiGivenName": "string",
"yomiSurname": "string"
}