联系人资源类型contact resource type

重要

Microsoft Graph 中/beta的版本下的 api 可能会发生更改。APIs under the /beta version in Microsoft Graph are subject to change. 不支持在生产应用程序中使用这些 API。Use of these APIs in production applications is not supported.

联系人是 Outlook 中的一个项目,你可以在这里组织和保存有关你通信的人员和组织的信息。联系人包含在联系人文件夹中。A contact is an item in Outlook where you can organize and save information about the people and organizations you communicate with. Contacts are contained in contact folders.

该资源支持:This resource supports:

JSON 表示形式JSON representation

下面是资源的 JSON 表示形式。Here is a JSON representation of the resource

{
  "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"
}

属性Properties

属性Property 类型Type 说明Description
assistantNameassistantName StringString 联系人助理的姓名。The name of the contact's assistant.
birthdaybirthday DateTimeOffsetDateTimeOffset 联系人的生日。时间戳类型表示使用 ISO 8601 格式的日期和时间信息,并且始终处于 UTC 时间。例如,2014 年 1 月 1 日午夜 UTC 类似于如下形式:'2014-01-01T00:00:00Z'The contact's birthday. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'
categoriescategories String 集合String collection 与联系人关联的类别。The categories associated with the contact. 每个类别对应于为用户定义的 outlookCategorydisplayName 属性。Each category corresponds to the displayName property of an outlookCategory defined for the user.
changeKeychangeKey StringString 标识联系人的版本。每次联系人更改时,ChangeKey 也将更改。这样,Exchange 可以将更改应用于该对象的正确版本。Identifies the version of the contact. Every time the contact is changed, ChangeKey changes as well. This allows Exchange to apply changes to the correct version of the object.
childrenchildren String collectionString collection 联系人子女的姓名。The names of the contact's children.
companyNamecompanyName StringString 联系人所在公司的名称。The name of the contact's company.
createdDateTimecreatedDateTime DateTimeOffsetDateTimeOffset 创建联系人的时间。时间戳类型表示使用 ISO 8601 格式的日期和时间信息,并且始终处于 UTC 时间。例如,2014 年 1 月 1 日午夜 UTC 类似于如下形式:'2014-01-01T00:00:00Z'The time the contact was created. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'
部门department StringString 联系人所在的部门。The contact's department.
displayNamedisplayName StringString 联系人的显示名称。The contact's display name. 可以在创建更新操作中指定显示名称。You can specify the display name in a create or update operation. 请注意,对其他属性的后续更新可能会导致自动生成的值覆盖你指定的 displayName 值。Note that later updates to other properties may cause an automatically generated value to overwrite the displayName value you have specified. 若要保留预先存在的值,请始终在更新操作中将其作为 displayName。To preserve a pre-existing value, always include it as displayName in an update operation.
emailAddressesemailAddresses typedEmailAddress集合typedEmailAddress collection 联系人的电子邮件地址。The contact's email addresses.
fileAsfileAs StringString 联系人备案的姓名。The name the contact is filed under.
flagflag followupFlagfollowupFlag 指示联系人的状态、开始日期、截止日期或完成日期的标志值。The flag value that indicates the status, start date, due date, or completion date for the contact.
gendergender StringString 联系人的性别。The contact's gender.
generationgeneration StringString 联系人所属的代。The contact's generation.
givenNamegivenName StringString 联系人的名。The contact's given name.
idid 字符串String 联系人的唯一标识符。Unique identifier for the contact. 默认情况下,在将项目从一个容器(如文件夹或日历)移动到另一个容器时,此值会发生更改。By default, this value changes when the item is moved from one container (such as a folder or calendar) to another. 若要更改此行为,请Prefer: IdType="ImmutableId"使用标头。To change this behavior, use the Prefer: IdType="ImmutableId" header. 有关详细信息,请参阅获取 Outlook 资源的不可变标识符See Get immutable identifiers for Outlook resources for more information.只读。默认情况下,在将项目从一个容器(如文件夹或日历)移动到另一个容器时,此值会发生更改。By default, this value changes when the item is moved from one container (such as a folder or calendar) to another. 若要更改此行为,请Prefer: IdType="ImmutableId"使用标头。To change this behavior, use the Prefer: IdType="ImmutableId" header. 有关详细信息,请参阅获取 Outlook 资源的不可变标识符See Get immutable identifiers for Outlook resources for more information. Read-only.
imAddressesimAddresses String collectionString collection 联系人的即时消息 (IM) 地址。The contact's instant messaging (IM) addresses.
initialsinitials StringString 联系人的姓名缩写。The contact's initials.
jobTitlejobTitle StringString 联系人的职务。The contact’s job title.
lastModifiedDateTimelastModifiedDateTime DateTimeOffsetDateTimeOffset 修改联系人的时间。时间戳类型表示使用 ISO 8601 格式的日期和时间信息,并且始终处于 UTC 时间。例如,2014 年 1 月 1 日午夜 UTC 类似于如下形式:'2014-01-01T00:00:00Z'The time the contact was modified. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'
managermanager StringString 联系人经理的姓名。The name of the contact's manager.
middleNamemiddleName StringString 联系人的中间名。The contact's middle name.
nickNamenickName StringString 联系人的昵称。The contact's nickname.
officeLocationofficeLocation StringString 联系人的办公室位置。The location of the contact's office.
parentFolderIdparentFolderId StringString 联系人的父文件夹 ID。The ID of the contact's parent folder.
personalNotespersonalNotes StringString 有关联系人的用户备注。The user's notes about the contact.
phonesphones phone collectionphone collection 与联系人关联的电话号码, 例如, 家庭电话、移动电话和商务电话。Phone numbers associated with the contact, for example, home phone, mobile phone, and business phone.
postalAddressespostalAddresses physicalAddress集合physicalAddress collection 与联系人关联的地址, 例如家庭地址和公司地址。Addresses associated with the contact, for example, home address and business address.
professionprofession StringString 联系人的职业。The contact's profession.
spouseNamespouseName StringString 联系人配偶/伴侣的姓名。The name of the contact's spouse/partner.
surnamesurname StringString 联系人的姓氏。The contact's surname.
titletitle 字符串String 联系人的职位。The contact's title.
websiteswebsites website collectionwebsite collection 与联系人关联的网站。Web sites associated with the contact.
weddingAnniversaryweddingAnniversary 日期Date 联系人的婚礼周年纪念。The contact's wedding anniversary.
yomiCompanyNameyomiCompanyName StringString 联系人的注音日文公司名称。The phonetic Japanese company name of the contact.
yomiGivenNameyomiGivenName StringString 联系人的注音日文名字。The phonetic Japanese given name (first name) of the contact.
yomiSurnameyomiSurname StringString 联系人的注音日文姓氏。The phonetic Japanese surname (last name) of the contact.

关系Relationships

关系Relationship 类型Type 说明Description
extensionsextensions 扩展集合extension collection 为联系人定义的开放扩展集合。The collection of open extensions defined for the contact. 可为 Null。Nullable.
multiValueExtendedPropertiesmultiValueExtendedProperties multiValueLegacyExtendedProperty 集合multiValueLegacyExtendedProperty collection 为联系人定义的多值扩展属性的集合。只读。可为 Null。The collection of multi-value extended properties defined for the contact. Read-only. Nullable.
photophoto 照片photo 可选的联系人照片。可以获取或设置联系人的照片。Optional contact picture. You can get or set a photo for a contact.
singleValueExtendedPropertiessingleValueExtendedProperties singleValueLegacyExtendedProperty collectionsingleValueLegacyExtendedProperty collection 为联系人定义的单值扩展属性的集合。只读。可为 Null。The collection of single-value extended properties defined for the contact. Read-only. Nullable.

方法Methods

方法Method 返回类型Return Type 说明Description
获取联系人Get contact 联系人contact 读取 contact 对象的属性和关系。Read properties and relationships of contact object.
创建Create 联系人contact 将联系人添加到联系人根文件夹或其他联系人文件夹的联系人端点中。Add a contact to the root Contacts folder or to the contacts endpoint of another contact folder.
更新Update 联系人contact 更新 contact 对象。Update contact object.
删除Delete None 删除 contact 对象。Delete contact object.
deltadelta 联系人集合contact collection 获取指定文件夹中已添加、删除或更新的联系人集。Get a set of contacts that have been added, deleted, or updated in a specified folder.
开放扩展Open extensions
创建开放扩展Create open extension openTypeExtensionopenTypeExtension 创建开放扩展,并将自定义属性添加到新资源或现有资源。Create an open extension and add custom properties to a new or existing resource.
获取开放扩展Get open extension openTypeExtension 集合openTypeExtension collection 获取扩展名称标识的开放扩展。Get an open extension identified by the extension name.
架构扩展Schema extensions
添加架构扩展值Add schema extension values 创建架构扩展定义,然后使用它向资源添加自定义键入数据。Create a schema extension definition and then use it to add custom typed data to a resource.
扩展属性Extended properties
创建单值扩展属性Create single-value extended property 联系人contact 在新建或现有的联系人中创建一个或多个单值扩展属性。Create one or more single-value extended properties in a new or existing contact.
获取具有单值扩展属性的联系人Get contact with single-value extended property 联系人contact 通过使用 $expand$filter 获取包含一个单值扩展属性的联系人。Get contacts that contain a single-value extended property by using $expand or $filter.
创建多值扩展属性Create multi-value extended property 联系人contact 在新建或现有的联系人中创建一个或多个多值扩展属性。Create one or more multi-value extended properties in a new or existing contact.
获取具有多值扩展属性的联系人Get contact with multi-value extended property 联系人contact 使用 $expand 获取包含一个多值扩展属性的联系人。Get a contact that contains a multi-value extended property by using $expand.

另请参阅See also