Table of contents
TOC
目次を折りたたむ
目次を展開する
最終更新日: 2017/12/21

Outlook の連絡先 REST API リファレンス

このドキュメントは、プレビュー版に含まれる連絡先 API のベータ版について説明しますプレビュー機能は、最終版までに変更される場合があり、それらの機能を使用するコードが動作しなくなる場合もあります。このため、一般に、運用コードでは運用バージョンの API のみを使用してください。入手可能な場合、現時点ではバージョン 2.0 が優先バージョンです。

Outlook REST API のバージョン 1.0 は廃止されます。 2018 年 11 月 1 日以降、アプリは v1.0 REST エンドポイント (https://outlook.office.com/api/v1.0) で基本認証を使用することができなくなります。 2019 年 11 月 1 日までに、v1.0 REST エンドポイントは完全に使用停止になり、v1.0 のドキュメントはその後間もなく削除されます。 Microsoft Graph の v1.0 での Outlook REST API を使用するように、アプリの移行を始めてください。 詳細については、このお知らせをご覧ください。

適用対象: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

Outlook 連絡先 API は、Office 365 の Azure Active Directory によって保護されているユーザーの連絡先と連絡先フォルダーへのアクセス、および Microsoft アカウントの類似したデータへのアクセスを提供します。具体的には、次のドメインです。Hotmail.com、Live.com、MSN.com、Outlook.com、および Passport.com。

リファレンスをわかりやすくするため、この記事の残りの部分では "Outlook.com" をこれらの Microsoft アカウントのドメインを含めた語として使用しています。

ベータ版の API が不要な場合右上隅のコントロールを使用して、必要なバージョンを選択します。

API v2.0 が不要な場合右上隅のコントロールを使用して、必要なバージョンを選択します。

API v1.0 が不要な場合右上隅のコントロールを使用して、必要なバージョンを選択します。

連絡先 API のすべての操作

連絡先の操作 連絡先は連絡先フォルダーに保存されます。連絡先を取得、作成、変更、削除することができます。

連絡先を取得する | 連絡先と連絡先フォルダーを同期する | 連絡先を作成する | 連絡先を更新する | 連絡先を削除する

連絡先フォルダーの操作 連絡先フォルダーには連絡先や別の連絡先フォルダーを含めることができます。連絡先フォルダーを取得し、連絡先フォルダーに連絡先を作成できます。

連絡先フォルダーの取得

連絡先の写真の操作 それぞれの連絡先に、オプションで連絡先の写真を指定できます。連絡先の写真を取得また設定することができます。

連絡先の写真を取得する | 連絡先の写真を設定する

関連項目:

REST API 連絡先リソース | REST API 連絡先フォルダーのリソース

連絡先 REST API の使用

認証

他の Outlook REST API と同様に、連絡先 API へのすべての要求に対して、有効なアクセス トークンを含める必要があります。アクセス トークンを取得するには、アプリを登録して識別させ、適切な承認を取得する必要があります。効率化された登録と承認のオプションに関しては詳細情報を参照してください。連絡先 API で特定の操作を続行する際には、この点に留意してください。

API のバージョン

連絡先 REST API は、すべてのバージョンの Outlook REST API でサポートされています。機能は、特定のバージョンによって異なる場合があります。

対象ユーザー

連絡先 API 要求は、常に現在のユーザーのために実行されます。

Outlook REST API のすべてのサブセットに共通な情報の詳細については、「Outlook REST API の使用」を参照してください。


連絡先を取得する

連絡先フォルダーから、連絡先のコレクションまたは個々の連絡先を取得できます。

最低限必要なスコープ: 次のいずれか:

連絡先のコレクションを取得する

サインインしているユーザーのメールボックス内のすべての連絡先を取得する (.../me/contacts) か、指定された連絡先フォルダーから取得します。

GET https://outlook.office.com/api/beta/me/contacts
GET https://outlook.office.com/api/beta/me/contactfolders/{contact_folder_id}/contacts
必須パラメーター説明
URL・パラメーター
contact_folder_idstring特定のフォルダーから連絡先を取得している場合は、連絡先フォルダー ID です。

既定では、応答内の各連絡先にそのプロパティがすべて含まれます。最適なパフォーマンスを得るために必要なこれらのプロパティのみを指定する場合は、$select を使用します。Id プロパティは常に返されます。パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」を参照してください。

要求のサンプル

GET https://outlook.office.com/api/beta/me/contacts?$select=EmailAddresses,GivenName,Surname

応答のサンプル

Status code: 200

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Contacts(EmailAddresses,GivenName,Surname)",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk3AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa7\"",
            "Id": "AAMkAGI2THk3AAA=",
            "GivenName": "Rob",
            "Surname": "Young",
            "EmailAddresses": [
                {
                    "Name": "roby@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "roby@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THkzAAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa3\"",
            "Id": "AAMkAGI2THkzAAA=",
            "GivenName": "Janet",
            "Surname": "Schorr",
            "EmailAddresses": [
                {
                    "Name": "janets@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "janets@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        }
    ]
}

応答の種類

要求された連絡先のコレクションです。


連絡先を取得する

最低限必要なスコープ: 次のいずれか:

連絡先 ID を使用して連絡先を取得します。

GET https://outlook.office.com/api/beta/me/contacts/{contact_id}
必須パラメーター説明
URL パラメーター
contact_idstring連絡先 ID。

応答の種類

要求された連絡先です。

要求のサンプル

GET https://outlook.office.com/api/beta/me/contacts/AAMkADlkAAAMRFUEAAA=

応答のサンプル

Status code: 200

{
    "@odata.context":"https://outlook.office365.com/api/beta/$metadata#Me/Contacts/$entity",
    "@odata.id":"https://outlook.office365.com/api/beta/Users('af183ae6-7efa-41e4-aa87-fe8790598625@9ac5b33f-49cf-45f7-9ef1-b581dce364d8')/Contacts('AAMkADlkAAAMRFUEAAA=')",
    "@odata.etag":"W/\"EQAAABYAAADDii8zlkFETIcBiRn8yAbgAAAMRdhl\"",
    "Id":"AAMkADlkAAAMRFUEAAA=",
    "CreatedDateTime":"2016-07-16T06:43:15Z",
    "LastModifiedDateTime":"2016-07-16T06:43:15Z",
    "ChangeKey":"EQAAABYAAADDii8zlkFETIcBiRn8yAbgAAAMRdhl",
    "Categories":[
    ],
    "ParentFolderId":"AAMkADlk8yAbgAAAAAAEkAAA=",
    "Birthday":null,
    "FileAs":"",
    "DisplayName":"Garret Vargas",
    "GivenName":"Garret",
    "Initials":null,
    "MiddleName":null,
    "NickName":null,
    "Surname":"Vargas",
    "Title":null,
    "YomiGivenName":null,
    "YomiSurname":null,
    "YomiCompanyName":null,
    "Generation":null,
    "EmailAddresses":[
        {
            "Name":"Garret Vargas",
            "Address":"GarretV@contoso.onmicrosoft.com"
        }
    ],
    "Websites":[
    ],
    "ImAddresses":[
        "sip:garretv@contoso.onmicrosoft.com"
    ],
    "JobTitle":"CVP Operations",
    "CompanyName":"",
    "Department":"Operations",
    "OfficeLocation":"36/2121",
    "Profession":null,
    "AssistantName":null,
    "Manager":null,
    "Phones":[
        {
            "Type":"Home",
            "Number":""
        },
        {
            "Type":"Business",
            "Number":"+1 206 555 0105"
        },
        {
            "Type":"Mobile",
            "Number":""
        }
    ],
    "PostalAddresses":[
        {
            "Type":"Business",
            "City":"Seattle"
        }
    ],
    "SpouseName":null,
    "PersonalNotes":null,
    "Children":[
    ],
    "Gender":null,
    "IsFavorite":null,
    "Flag":{
        "FlagStatus":"NotFlagged"
    }
}

既定では、応答に連絡先のすべてのプロパティが含まれます。最適なパフォーマンスを得るために必要なこれらのプロパティのみを指定する場合は、$select を使用します。Id プロパティは常に返されます。パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」を参照してください。

次の例は、$select を使用して、応答内の連絡先のEmailAddressesGivenName、および Surname プロパティのみを返すように指定する方法を示しています。

要求のサンプル

GET https://outlook.office.com/api/beta/me/contacts/AAMkAGI2THk0AAA=?$select=EmailAddresses,GivenName,Surname

応答のサンプル

Status code: 200

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Contacts(EmailAddresses,GivenName,Surname)/$entity",
    "@odata.id": "https://outlook.office.com/api/beta/Users('af183ae6-7efa-41e4-aa87-fe8790598625@9ac5b33f-49cf-45f7-9ef1-b581dce364d8')/Contacts('AAMkADlkAAAMRFUEAAA=')",
    "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4\"",
    "Id": "AAMkADlkAAAMRFUEAAA=",
    "GivenName": "Garth",
    "Surname": "Vargas",
    "EmailAddresses": [
       {
            "Name":"Garret Vargas",
            "Address":"GarretV@contoso.onmicrosoft.com"
        }
    ]
}

最低限必要なスコープ: 次のいずれか:

連絡先のコレクションを取得する

サインイン中のユーザーの既定の連絡先フォルダーから連絡先のコレクションを取得する (.../me/contacts) か、指定した連絡先フォルダーから取得します。

GET https://outlook.office.com/api/v2.0/me/contacts
GET https://outlook.office.com/api/v2.0/me/contactfolders/{contact_folder_id}/contacts
必須パラメーター説明
URL・パラメーター
contact_folder_idstring特定のフォルダーから連絡先を取得している場合は、連絡先フォルダー ID です。

既定では、応答内の各連絡先にそのプロパティがすべて含まれます。最適なパフォーマンスを得るために必要なこれらのプロパティのみを指定する場合は、$select を使用します。Id プロパティは常に返されます。パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」を参照してください。

要求のサンプル

GET https://outlook.office.com/api/v2.0/me/contacts?$select=EmailAddresses,GivenName,Surname

応答のサンプル

Status code: 200

{
    "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Contacts(EmailAddresses,GivenName,Surname)",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk3AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa7\"",
            "Id": "AAMkAGI2THk3AAA=",
            "GivenName": "Rob",
            "Surname": "Young",
            "EmailAddresses": [
                {
                    "Name": "roby@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "roby@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THkzAAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa3\"",
            "Id": "AAMkAGI2THkzAAA=",
            "GivenName": "Janet",
            "Surname": "Schorr",
            "EmailAddresses": [
                {
                    "Name": "janets@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "janets@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        }
    ]
}

応答の種類

要求された連絡先のコレクションです。


連絡先を取得する

最低限必要なスコープ: 次のいずれか:

連絡先 ID を使用して連絡先を取得します。

GET https://outlook.office.com/api/v2.0/me/contacts/{contact_id}
必須パラメーター説明
URL パラメーター
contact_idstring連絡先の ID。

要求のサンプル

GET https://outlook.office.com/api/v2.0/me/contacts/AAMkAGI2THk0AAA=

応答のサンプル

Status code: 200

{
    "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Contacts/$entity",
    "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
    "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4\"",
    "Id": "AAMkAGI2THk0AAA=",
    "CreatedDateTime": "2014-10-19T23:08:24Z",
    "LastModifiedDateTime": "2014-10-19T23:08:24Z",
    "ChangeKey": "EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4",
    "Categories": [],
    "ParentFolderId": "AAMkAGI2AAEOAAA=",
    "Birthday": null,
    "FileAs": "Fort, Garth",
    "DisplayName": "Garth Fort",
    "GivenName": "Garth",
    "Initials": "G.F.",
    "MiddleName": null,
    "NickName": "Garth",
    "Surname": "Fort",
    "Title": null,
    "YomiGivenName": null,
    "YomiSurname": null,
    "YomiCompanyName": null,
    "Generation": null,
    "EmailAddresses": [
        {
            "Name": "Garth",
            "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
        }
    ],
    "ImAddresses": [
        "sip:garthf@a830edad9050849nda1.onmicrosoft.com"
    ],
    "JobTitle": "Web Marketing Manager",
    "CompanyName": "Contoso, Inc.",
    "Department": "Sales & Marketing",
    "OfficeLocation": "20/1101",
    "Profession": null,
    "BusinessHomePage": "http://www.contoso.com",
    "AssistantName": null,
    "Manager": null,
    "HomePhones": [],
    "MobilePhone1": null,
    "BusinessPhones": [
        "+1 918 555 0101"
    ],
    "HomeAddress": {},
    "BusinessAddress": {
      "Street": "10 Contoso Way",
      "City": "Redmond",
      "State": "WA",
      "CountryOrRegion": "USA",
      "PostalCode": "98075"  
    },
    "OtherAddress": {},
    "SpouseName": null,
    "PersonalNotes": null,
    "Children": []
}

応答の種類

要求された連絡先です。

既定では、応答に連絡先のすべてのプロパティが含まれます。最適なパフォーマンスを得るために必要なこれらのプロパティのみを指定する場合は、$select を使用します。Id プロパティは常に返されます。パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」を参照してください。

次の例は、$select を使用して、応答内の連絡先のEmailAddressesGivenName、および Surname プロパティのみを返すように指定する方法を示しています。

要求のサンプル

GET https://outlook.office.com/api/v2.0/me/contacts/AAMkAGI2THk0AAA=?$select=EmailAddresses,GivenName,Surname

応答のサンプル

Status code: 200

{
    "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Contacts(EmailAddresses,GivenName,Surname)/$entity",
    "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
    "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4\"",
    "Id": "AAMkAGI2THk0AAA=",
    "GivenName": "Garth",
    "Surname": "Fort",
    "EmailAddresses": [
        {
            "Name": "garthf@a830edad9050849NDA1.onmicrosoft.com",
            "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
        }
    ]
}

連絡先のコレクションを取得する | 連絡先を取得する

連絡先のコレクションを取得する

最低限必要なスコープ: 次のいずれか:

サインイン中のユーザーの既定の連絡先フォルダーから連絡先のコレクションを取得する (.../me/contacts) か、指定した連絡先フォルダーから取得します。

GET https://outlook.office.com/api/v1.0/me/contacts
GET https://outlook.office.com/api/v1.0/me/contactfolders/{contact_folder_id}/contacts
必須パラメーター説明
URL・パラメーター
contact_folder_idstring特定のフォルダーから連絡先を取得している場合は、連絡先フォルダー ID です。

既定では、応答内の各連絡先にそのプロパティがすべて含まれます。最適なパフォーマンスを得るために必要なこれらのプロパティのみを指定する場合は、$select を使用します。Id プロパティは常に返されます。パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」を参照してください。

次の例は、$select を使用して、応答内の各連絡先の EmailAddressesGivenNameSurname プロパティのみを返すように指定する方法を示しています。$select を使用しない場合の連絡先に返されるプロパティの完全な一覧については、「連絡先を取得する」の最初の応答サンプルを参照してください。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/contacts?$select=EmailAddresses,GivenName,Surname

応答のサンプル

状態コード:200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Contacts(EmailAddresses,GivenName,Surname)",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Contacts(EmailAddresses,GivenName,Surname)",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa7\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk3AAA=",
            "GivenName": "Rob",
            "Surname": "Young",
            "EmailAddresses": [
                {
                    "Name": "roby@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "roby@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa6\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk2AAA=",
            "GivenName": "Pavel",
            "Surname": "Bansky",
            "EmailAddresses": [
                {
                    "Name": "pavelb@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "pavelb@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa5\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk1AAA=",
            "GivenName": "Katie",
            "Surname": "Jordan",
            "EmailAddresses": [
                {
                    "Name": "katiej@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk0AAA=",
            "GivenName": "Garth",
            "Surname": "Fort",
            "EmailAddresses": [
                {
                    "Name": "garthf@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa3\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHkzAAA=",
            "GivenName": "Janet",
            "Surname": "Schorr",
            "EmailAddresses": [
                {
                    "Name": "janets@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "janets@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        }
    ]
}
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa7\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk3AAA=",
            "GivenName": "Rob",
            "Surname": "Young",
            "EmailAddresses": [
                {
                    "Name": "roby@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "roby@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa6\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk2AAA=",
            "GivenName": "Pavel",
            "Surname": "Bansky",
            "EmailAddresses": [
                {
                    "Name": "pavelb@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "pavelb@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa5\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk1AAA=",
            "GivenName": "Katie",
            "Surname": "Jordan",
            "EmailAddresses": [
                {
                    "Name": "katiej@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "katiej@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk0AAA=",
            "GivenName": "Garth",
            "Surname": "Fort",
            "EmailAddresses": [
                {
                    "Name": "garthf@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        },
        {
            "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
            "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa3\"",
            "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHkzAAA=",
            "GivenName": "Janet",
            "Surname": "Schorr",
            "EmailAddresses": [
                {
                    "Name": "janets@a830edad9050849NDA1.onmicrosoft.com",
                    "Address": "janets@a830edad9050849NDA1.onmicrosoft.com"
                }
            ]
        }
    ]
}

応答の種類

要求された連絡先のコレクションです。


連絡先を取得する

最低限必要なスコープ: 次のいずれか:

連絡先 ID を使用して連絡先を取得します。

GET https://outlook.office.com/api/{version}/me/contacts/{contact_id}
必須パラメーター説明
URL パラメーター
versionstringAPI のバージョン
contact_idstring連絡先の ID。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/contacts/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop

応答のサンプル

状態コード:200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Contacts/$entity",
    "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
    "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4\"",
    "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHk0AAA=",
    "DateTimeCreated": "2014-10-19T23:08:24Z",
    "DateTimeLastModified": "2014-10-19T23:08:24Z",
    "ChangeKey": "EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4",
    "Categories": [],
    "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEOAAA=",
    "Birthday": null,
    "FileAs": "Fort, Garth",
    "DisplayName": "Garth Fort",
    "GivenName": "Garth",
    "Initials": null,
    "MiddleName": null,
    "NickName": null,
    "Surname": "Fort",
    "Title": null,
    "YomiGivenName": null,
    "YomiSurname": null,
    "YomiCompanyName": null,
    "Generation": null,
    "EmailAddresses": [
        {
            "Name": "garthf@a830edad9050849NDA1.onmicrosoft.com",
            "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
        }
    ],
    "ImAddresses": [
        "sip:garthf@a830edad9050849nda1.onmicrosoft.com"
    ],
    "JobTitle": "Web Marketing Manager",
    "CompanyName": null,
    "Department": "Sales & Marketing",
    "OfficeLocation": "20/1101",
    "Profession": null,
    "BusinessHomePage": null,
    "AssistantName": null,
    "Manager": null,
    "HomePhones": [],
    "MobilePhone1": null,
    "BusinessPhones": [
        "+1 918 555 0101"
    ],
    "HomeAddress": {},
    "BusinessAddress": {},
    "OtherAddress": {},
    "SpouseName": null,
    "PersonalNotes": null,
    "Children": []
}

応答の種類

要求された連絡先です。

既定では、応答に連絡先のすべてのプロパティが含まれます。最適なパフォーマンスを得るために必要なこれらのプロパティのみを指定する場合は、$select を使用します。Id プロパティは常に返されます。パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」を参照してください。

次の例は、$select を使用して、応答内の連絡先のEmailAddressesGivenName、および Surname プロパティのみを返すように指定する方法を示しています。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/contacts/AAMkAGI2THk0AAA=?$select=EmailAddresses,GivenName,Surname

応答のサンプル

状態コード:200

{
    "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Contacts(EmailAddresses,GivenName,Surname)/$entity",
    "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THk0AAA=')",
    "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa4\"",
    "Id": "AAMkAGI2THk0AAA=",
    "GivenName": "Garth",
    "Surname": "Fort",
    "EmailAddresses": [
        {
            "Name": "garthf@a830edad9050849NDA1.onmicrosoft.com",
            "Address": "garthf@a830edad9050849NDA1.onmicrosoft.com"
        }
    ]
}

連絡先と連絡先フォルダーを同期する

ローカルの連絡先の一覧とサーバーの連絡先を同期できます。Contactssynchronization はフォルダーごとの操作であり、たとえばルート連絡先フォルダーのすべての連絡先を同期できます。その他の連絡先フォルダーがある場合は、各フォルダーを個別に同期する必要があります。

同期は、完全同期のみサポートしています。各要求には、指定したフォルダー内のすべての連絡先が返されます。

通常、連絡先フォルダーを同期するには、2 つ以上の GET 要求が必要です。GET 要求は連絡先を取得すると同じ方法で実行できますが、次の要求ヘッダーを追加する必要があります。

  • すべての同期要求で、Prefer: odata.track-changes ヘッダーを指定する必要があります。
  • Prefer: odata.maxpages={n} ヘッダーを指定して、要求ごとに返される連絡先の最大数を指定することができます。

    2 番目以降の GET 要求は、前の応答で受信した deltaToken または skipToken のいずれかを含むため、最初の GET 要求とは異なります。

    同期要求に対する最初の応答では、常に deltaToken が返されます 追加の連絡先がある場合は、2 番目の GET 要求には常に deltaToken を使用します。2 番目の要求は、追加の連絡先、および他にも連絡先がある場合は skipToken、最後の連絡先が送信された場合は deltaToken が返されます。

最低限必要なスコープ: 次のいずれか:

GET https://outlook.office.com/api/beta/me/Contacts
GET https://outlook.office.com/api/beta/me/ContactFolders/{folderName}
必須パラメーター説明
Header parameters
Preferodata.track-changes要求が同期要求であることを示します。
Preferodata.maxpagesize各応答で返される連絡先の数を設定します。
URL・パラメーター
folderNamestring同期するフォルダーの名前。
odata.deltaLinkString前回フォルダーが同期されたことを示すトークン。
odata.skiptokenStringダウンロードするメッセージがまだあることを示すトークン。

応答の種類

要求された連絡先と、サーバーからの連絡先データの追加ページを要求し、増分同期を要求するために使用する deltaToken を含むコレクションです。返された連絡先の数が odata.maxpagesize ヘッダーで指定した値より多い場合、応答は複数のページで返されます。

応答には Preference-Applied: odata.track-changes ヘッダーが含まれます。サポートされていないリソースを同期しようとすると、応答でこのヘッダーが返されません。エラーを回避するには、応答を処理する前にこのヘッダーを確認します。

既定では、応答に指定された連絡先のすべてのプロパティが含まれます。最適なパフォーマンスを得るために必要なプロパティのみを指定する場合は、$select を使用します。Id プロパティは常に返されます。$filter、$orderby、$search、または $top は使用しないでください。これらは連絡先または連絡先フォルダーの同期ではサポートされません。詳細については、「OData クエリ パラメーター」を参照してください。

** 例 **

完全な同期の最初の要求

GET https://outlook.office.com/api/beta/Me/Contacts

次のヘッダーが含まれています。

  • Prefer: odata.track-changes
  • Prefer: odata.maxpagesize=100

完全な同期要求に続くサーバーへの 2 番目の要求です。

https://outlook.office.com/api/beta/Me/Contacts/?%24deltatoken=169ca50467d34d9fb8adb664961b9836

次のヘッダーが含まれています。

  • Prefer: odata.track-changes
  • Prefer: odata.maxpagesize=100

追加ページのある、サーバーからの 2 番目の応答です。

ヘッダー

Preference-Applied: odata.track-changes

本文

@odata.deltaLink=https://outlook.office.com/api/beta/me/Contacts/messages/?%24skiptoken=169ca50467d34d9fb8adb664961b9836

ペイロード メッセージ

すべての連絡先が送信された場合の、2 番目以降のサーバーからの応答です。

ヘッダー

Preference-Applied: odata.track-changes

本文

@odata.deltaLink=https://outlook.office.com/api/beta/me/Contacts/?%24deltatoken=169ca50467d34d9fb8adb664961b9836

ペイロード メッセージ

追加ページがある場合のサーバーへの要求です。

https://outlook.office.com/api/beta/Me/Contacts/?%24skiptoken=169ca50467d34d9fb8adb664961b9836

次のヘッダーが含まれています。

  • Prefer: odata.track-changes
  • Prefer: odata.maxpagesize=100

最低限必要なスコープ: 次のいずれか:

GET https://outlook.office.com/api/v2.0/me/Contacts
GET https://outlook.office.com/api/v2.0/me/ContactFolders/{folderName}
必須パラメーター説明
Header parameters
Preferodata.track-changes要求が同期要求であることを示します。
Preferodata.maxpagesize各応答で返される連絡先の数を設定します。
URL・パラメーター
folderNamestring同期するフォルダーの名前。
odata.deltaLinkString前回フォルダーが同期されたことを示すトークン。
odata.skiptokenStringダウンロードするメッセージがまだあることを示すトークン。

応答の種類

要求された連絡先と、サーバーからの連絡先データの追加ページを要求し、増分同期を要求するために使用する deltaToken を含むコレクションです。返された連絡先の数が odata.maxpagesize ヘッダーで指定した値より多い場合、応答は複数のページで返されます。

応答には Preference-Applied: odata.track-changes ヘッダーが含まれます。サポートされていないリソースを同期しようとすると、応答でこのヘッダーが返されません。エラーを回避するには、応答を処理する前にこのヘッダーを確認します。

既定では、応答に指定された連絡先のすべてのプロパティが含まれます。最適なパフォーマンスを得るために必要なプロパティのみを指定する場合は、$select を使用します。Id プロパティは常に返されます。$filter、$orderby、$search、または $top は使用しないでください。これらは連絡先または連絡先フォルダーの同期ではサポートされません。詳細については、「OData クエリ パラメーター」を参照してください。

** 例 **

完全な同期の最初の要求

GET https://outlook.office.com/api/v2.0/Me/Contacts

次のヘッダーが含まれています。

  • Prefer: odata.track-changes
  • Prefer: odata.maxpagesize=100

完全な同期要求に続くサーバーへの 2 番目の要求です。

https://outlook.office.com/api/v2.0/Me/Contacts/?%24deltatoken=169ca50467d34d9fb8adb664961b9836

次のヘッダーが含まれています。

  • Prefer: odata.track-changes
  • Prefer: odata.maxpagesize=100

追加ページのある、サーバーからの 2 番目の応答です。

ヘッダー

Preference-Applied: odata.track-changes

本文

@odata.deltaLink=https://outlook.office.com/api/v2.0/me/Contacts/messages/?%24skiptoken=169ca50467d34d9fb8adb664961b9836

ペイロード メッセージ

すべての連絡先が送信された場合の、2 番目以降のサーバーからの応答です。

ヘッダー

Preference-Applied: odata.track-changes

本文

@odata.deltaLink=https://outlook.office.com/api/v2.0/me/Contacts/?%24deltatoken=169ca50467d34d9fb8adb664961b9836

ペイロード メッセージ

追加ページがある場合のサーバーへの要求です。

https://outlook.office.com/api/v2.0/Me/Contacts/?%24skiptoken=169ca50467d34d9fb8adb664961b9836

次のヘッダーが含まれています。

  • Prefer: odata.track-changes
  • Prefer: odata.maxpagesize=100

最低限必要なスコープ: 次のいずれか:

GET https://outlook.office.com/api/v1.0/me/Contacts
GET https://outlook.office.com/api/v1.0/me/ContactFolders/{folderName}
必須パラメーター説明
Header parameters
Preferodata.track-changes要求が同期要求であることを示します。
Preferodata.maxpagesize各応答で返される連絡先の数を設定します。
URL・パラメーター
folderNamestring同期するフォルダーの名前。
odata.deltaLinkString前回フォルダーが同期されたことを示すトークン。
odata.skiptokenStringダウンロードするメッセージがまだあることを示すトークン。

応答の種類

要求された連絡先と、サーバーからの連絡先データの追加ページを要求し、増分同期を要求するために使用する deltaToken を含むコレクションです。返された連絡先の数が odata.maxpagesize ヘッダーで指定した値より多い場合、応答は複数のページで返されます。

応答には Preference-Applied: odata.track-changes ヘッダーが含まれます。サポートされていないリソースを同期しようとすると、応答でこのヘッダーが返されません。エラーを回避するには、応答を処理する前にこのヘッダーを確認します。

既定では、応答に指定された連絡先のすべてのプロパティが含まれます。最適なパフォーマンスを得るために必要なプロパティのみを指定する場合は、$select を使用します。Id プロパティは常に返されます。$filter、$orderby、$search、または $top は使用しないでください。これらは連絡先または連絡先フォルダーの同期ではサポートされません。詳細については、「OData クエリ パラメーター」を参照してください。

** 例 **

完全な同期の最初の要求

GET https://outlook.office.com/api/v1.0/Me/Contacts

次のヘッダーが含まれています。

  • Prefer: odata.track-changes
  • Prefer: odata.maxpagesize=100

完全な同期要求に続くサーバーへの 2 番目の要求です。

https://outlook.office.com/api/v1.0/Me/Contacts/?%24deltatoken=169ca50467d34d9fb8adb664961b9836

次のヘッダーが含まれています。

  • Prefer: odata.track-changes
  • Prefer: odata.maxpagesize=100

追加ページのある、サーバーからの 2 番目の応答です。

ヘッダー

Preference-Applied: odata.track-changes

本文

@odata.deltaLink=https://outlook.office.com/api/v1.0/me/Contacts/messages/?%24skiptoken=169ca50467d34d9fb8adb664961b9836

ペイロード メッセージ

すべての連絡先が送信された場合の、2 番目以降のサーバーからの応答です。

ヘッダー

Preference-Applied: odata.track-changes

本文

@odata.deltaLink=https://outlook.office.com/api/v1.0/me/Contacts/?%24deltatoken=169ca50467d34d9fb8adb664961b9836

ペイロード メッセージ

追加ページがある場合のサーバーへの要求です。

https://outlook.office.com/api/v1.0/Me/Contacts/?%24skiptoken=169ca50467d34d9fb8adb664961b9836

次のヘッダーが含まれています。

  • Prefer: odata.track-changes
  • Prefer: odata.maxpagesize=100

連絡先を作成する

指定した連絡先フォルダーに連絡先を作成します。

連絡先を作成する

連絡先を作成する

最低限必要なスコープ: 次のいずれか:

連絡先をルート連絡先フォルダーまたは別の連絡先フォルダーの contacts エンドポイントに追加します。

POST https://outlook.office.com/api/beta/me/contacts
POST https://outlook.office.com/api/beta/me/contactfolders/{contact_folder_id}/contacts
必須パラメーター説明
URL・パラメーター
contact_folder_idstring特定の連絡先フォルダーに連絡先を作成する場合は連絡先フォルダー ID です。
本文のパラメーター
GivenNamestring連絡先の名前。

要求本文に GivenName パラメーターと任意の書き込み可能な連絡先プロパティを指定します。

要求のサンプル

POST https://outlook.office.com/api/beta/me/contacts
Content-Type: application/json

{
  "GivenName": "Pavel",
  "Surname": "Bansky",
  "EmailAddresses": [
    {
      "Address": "pavelb@contoso.onmicrosoft.com",
      "Name": "Pavel Bansky"
    }
  ],
  "Phones": [
    {
      "Type": "Business",
      "Number": "+1 732 555 0102"
    }
  ]
}

応答のサンプル

Status code: 201

{
  "@odata.context":"https://outlook.office365.com/api/beta/$metadata#Me/Contacts/$entity",
  "@odata.id":"https://outlook.office365.com/api/beta/Users('af183ae6-7efa-41e4-aa87-fe8790598625@9ac5b33f-49cf-45f7-9ef1-b581dce364d8')/Contacts('AAMkADlkAAARKMK7AAA=')",
  "@odata.etag":"W/\"EQAAABYAAADDii8zlkFETIcBiRn8yAbgAAARKpia\"",
  "Id":"AAMkADlkAAARKMK7AAA=",
  "CreatedDateTime":"2016-07-20T23:59:37Z",
  "LastModifiedDateTime":"2016-07-20T23:59:38Z",
  "ChangeKey":"EQAAABYAAADDii8zlkFETIcBiRn8yAbgAAARKpia",
  "Categories":[
  ],
  "ParentFolderId":"AAMkADlk8yAbgAAAAAAEOAAA=",
  "Birthday":null,
  "FileAs":"",
  "DisplayName":"Pavel Bansky",
  "GivenName":"Pavel",
  "Initials":null,
  "MiddleName":null,
  "NickName":null,
  "Surname":"Bansky",
  "Title":null,
  "YomiGivenName":null,
  "YomiSurname":null,
  "YomiCompanyName":null,
  "Generation":null,
  "EmailAddresses":[
    {
      "Name":"Pavel Bansky",
      "Address":"pavelb@contoso.onmicrosoft.com"
    }
  ],
  "Websites":[
  ],
  "ImAddresses":[
  ],
  "JobTitle":null,
  "CompanyName":null,
  "Department":null,
  "OfficeLocation":null,
  "Profession":null,
  "AssistantName":null,
  "Manager":null,
  "Phones":[
    {
      "Type":"Business",
      "Number":"+1 732 555 0102"
    }
  ],
  "PostalAddresses":[
  ],
  "SpouseName":null,
  "PersonalNotes":null,
  "Children":[
  ],
  "Gender":null,
  "IsFavorite":null,
  "Flag":{
    "FlagStatus":"NotFlagged"
  }
}

応答の種類

新しい連絡先です。

最低限必要なスコープ: 次のいずれか:

連絡先をルート連絡先フォルダーまたは別の連絡先フォルダーの contacts エンドポイントに追加します。

POST https://outlook.office.com/api/v2.0/me/contacts
POST https://outlook.office.com/api/v2.0/me/contactfolders/{contact_folder_id}/contacts
必須パラメーター説明
URL・パラメーター
contact_folder_idstring特定の連絡先フォルダーに連絡先を作成する場合は連絡先フォルダー ID です。
本文のパラメーター
GivenNamestring連絡先の名前。

要求本文に GivenName パラメーターと任意の書き込み可能な連絡先プロパティを指定します。

要求のサンプル

POST https://outlook.office.com/api/v2.0/me/contacts
Content-Type: application/json

{
  "GivenName": "Pavel",
  "Surname": "Bansky",
  "EmailAddresses": [
    {
      "Address": "pavelb@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Pavel Bansky"
    }
  ],
  "BusinessPhones": [
    "+1 732 555 0102"
  ]
}

応答のサンプル

Status code: 201

{
  "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Contacts/$entity",
  "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGE0M4xqVAAA=')",
  "@odata.etag": "W/\"EQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAV41eC\"",
  "Id": "AAMkAGE0M4xqVAAA=",
  "ChangeKey": "EQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAV41eC",
  "Categories": [],
  "CreatedDateTime": "2014-10-22T20:38:18Z",
  "LastModifiedDateTime": "2014-10-22T20:38:19Z",
  "ParentFolderId": "AAMkAGE0MAAEOAAA=",
  "Birthday": null,
  "FileAs": "",
  "DisplayName": "Pavel Bansky",
  "GivenName": "Pavel",
  "Initials": null,
  "MiddleName": null,
  "NickName": null,
  "Surname": "Bansky",
  "Title": null,
  "Generation": null,
  "EmailAddresses": [
    {
      "Address": "pavelb@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Pavel Bansky"
    },
    null,
    null
  ],
  "ImAddresses": [
    null,
    null,
    null
  ],
  "JobTitle": null,
  "CompanyName": null,
  "Department": null,
  "OfficeLocation": null,
  "Profession": null,
  "BusinessHomePage": null,
  "AssistantName": null,
  "Manager": null,
  "HomePhones": [
    null,
    null
  ],
  "BusinessPhones": [
    "+1 732 555 0102",
    null
  ],
  "MobilePhone1": null,
  "HomeAddress": {
    "Street": null,
    "City": null,
    "State": null,
    "CountryOrRegion": null,
    "PostalCode": null
  },
  "BusinessAddress": {
    "Street": null,
    "City": null,
    "State": null,
    "CountryOrRegion": null,
    "PostalCode": null
  },
  "OtherAddress": {
    "Street": null,
    "City": null,
    "State": null,
    "CountryOrRegion": null,
    "PostalCode": null
  },
  "SpouseName": null,
  "PersonalNotes": null,
  "Children": [],
  "YomiSurname": null,
  "YomiGivenName": null,
  "YomiCompanyName": null
}

応答の種類

新しい連絡先です。

最低限必要なスコープ: 次のいずれか:

連絡先をルート連絡先フォルダーまたは別の連絡先フォルダーの contacts エンドポイントに追加します。

POST https://outlook.office.com/api/v1.0/me/contacts
POST https://outlook.office.com/api/v1.0/me/contactfolders/{contact_folder_id}/contacts
必須パラメーター説明
URL・パラメーター
contact_folder_idstring特定の連絡先フォルダーに連絡先を作成する場合は連絡先フォルダー ID です。
本文のパラメーター
GivenNamestring連絡先の名前。

要求本文に GivenName パラメーターと任意の書き込み可能な連絡先プロパティを指定します。

要求のサンプル

POST https://outlook.office.com/api/v1.0/me/contacts
Content-Type: application/json
{
  "GivenName": "Pavel",
  "Surname": "Bansky",
  "EmailAddresses": [
    {
      "Address": "pavelb@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Pavel Bansky"
    }
  ],
  "BusinessPhones": [
    "+1 732 555 0102"
  ]
}

応答のサンプル

状態コード:201

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Contacts/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"EQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAV41eC\"",
  "Id": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MABGAAAAAAC_0WfqSjt_SqLtNkuO-bj1BwAmP1Ln1wcHRariNdTMGAO9AAAAAAEOAAAmP1Ln1wcHRariNdTMGAO9AAAV4xqVAAA=",
  "ChangeKey": "EQAAABYAAAAmP1Ln1wcHRariNdTMGAO9AAAV41eC",
  "Categories": [],
  "DateTimeCreated": "2014-10-22T20:38:18Z",
  "DateTimeLastModified": "2014-10-22T20:38:19Z",
  "ParentFolderId": "AAMkAGE0MGM1Y2M5LWEzMmUtNGVlNy05MjRlLTk0YmJjYzVkN2I5MAAuAAAAAAC_0WfqSjt_SqLtNkuO-bj1AQAmP1Ln1wcHRariNdTMGAO9AAAAAAEOAAA=",
  "Birthday": null,
  "FileAs": "",
  "DisplayName": "Pavel Bansky",
  "GivenName": "Pavel",
  "Initials": null,
  "MiddleName": null,
  "NickName": null,
  "Surname": "Bansky",
  "Title": null,
  "Generation": null,
  "EmailAddresses": [
    {
      "Address": "pavelb@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "Pavel Bansky"
    },
    null,
    null
  ],
  "ImAddresses": [
    null,
    null,
    null
  ],
  "JobTitle": null,
  "CompanyName": null,
  "Department": null,
  "OfficeLocation": null,
  "Profession": null,
  "BusinessHomePage": null,
  "AssistantName": null,
  "Manager": null,
  "HomePhones": [
    null,
    null
  ],
  "BusinessPhones": [
    "+1 732 555 0102",
    null
  ],
  "MobilePhone1": null,
  "HomeAddress": {
    "Street": null,
    "City": null,
    "State": null,
    "CountryOrRegion": null,
    "PostalCode": null
  },
  "BusinessAddress": {
    "Street": null,
    "City": null,
    "State": null,
    "CountryOrRegion": null,
    "PostalCode": null
  },
  "OtherAddress": {
    "Street": null,
    "City": null,
    "State": null,
    "CountryOrRegion": null,
    "PostalCode": null
  },
  "YomiSurname": null,
  "YomiGivenName": null,
  "YomiCompanyName": null
}

応答の種類

新しい連絡先です。


連絡先を更新する

連絡先のプロパティを変更します。

連絡先を更新する

連絡先を更新する

最低限必要なスコープ: 次のいずれか:

要求本文に任意の書き込み可能な連絡先プロパティを指定します。指定したプロパティのみが変更されます。

PATCH https://outlook.office.com/api/beta/me/contacts/{contact_id}
必須パラメーター説明
URL パラメーター
contact_idstring連絡先の ID。

要求のサンプル

次の例では、連絡先の住所とフォロー アップ フラグを設定します。

メモ:Flag.FlagStatusFlagged に設定されている場合、Flag.CompletedDate を設定することはできません。

PATCH https://outlook.office.com/api/beta/me/contacts/AAMkADlkAAARKMK7AAA=
Content-Type: application/json

{
  "PostalAddresses": [
    {
      "Type": "Business",
      "Street": "Some street",
      "City": "Seattle",
      "State": "WA",
      "PostalCode": "98121"
    }
  ],
  "Birthday": "1974-07-22",
  "Flag": {
    "FlagStatus": "Flagged",
       "DueDateTime": {
            "DateTime": "2017-12-22T08:00:00.0000000",
            "TimeZone": "UTC"
        },
        "StartDateTime": {
            "DateTime": "2017-12-18T08:00:00.0000000",
            "TimeZone": "UTC"
        }
    }
}

応答のサンプル

Status code: 200

{
  "@odata.context":"https://outlook.office365.com/api/beta/$metadata#Me/Contacts/$entity",
  "@odata.id":"https://outlook.office365.com/api/beta/Users('af183ae6-7efa-41e4-aa87-fe8790598625@9ac5b33f-49cf-45f7-9ef1-b581dce364d8')/Contacts('AAMkADlkAAARKMK7AAA=')",
  "@odata.etag":"W/\"EQAAABYAAADDii8zlkFETIcBiRn8yAbgAAARKpia\"",
  "Id":"AAMkADlkAAARKMK7AAA=",
  "CreatedDateTime":"2016-07-20T23:59:37Z",
  "LastModifiedDateTime":"2016-07-20T23:59:38Z",
  "ChangeKey":"EQAAABYAAADDii8zlkFETIcBiRn8yAbgAAARKpia",
  "Categories":[
  ],
  "ParentFolderId":"AAMkADlk8yAbgAAAAAAEOAAA=",
  "Birthday":"1974-07-22T00:00:00Z",
  "FileAs":"",
  "DisplayName":"Pavel Bansky",
  "GivenName":"Pavel",
  "Initials":null,
  "MiddleName":null,
  "NickName":null,
  "Surname":"Bansky",
  "Title":null,
  "YomiGivenName":null,
  "YomiSurname":null,
  "YomiCompanyName":null,
  "Generation":null,
  "EmailAddresses":[
    {
      "Name":"Pavel Bansky",
      "Address":"pavelb@contoso.onmicrosoft.com"
    }
  ],
  "Websites":[
  ],
  "ImAddresses":[
  ],
  "JobTitle":null,
  "CompanyName":null,
  "Department":null,
  "OfficeLocation":null,
  "Profession":null,
  "AssistantName":null,
  "Manager":null,
  "Phones":[
    {
      "Type":"Business",
      "Number":"+1 732 555 0102"
    }
  ],
  "PostalAddresses":[
    {
      "Type": "Business",
      "Street": "Some street",
      "City": "Seattle",
      "State": "WA",
      "PostalCode": "98121"
    }
  ],
  "SpouseName":null,
  "PersonalNotes":null,
  "Children":[
  ],
  "Gender":null,
  "IsFavorite":null,
  "Flag": {
        "FlagStatus": "Flagged",
        "DueDateTime": {
            "DateTime": "2017-12-22T08:00:00.0000000",
            "TimeZone": "UTC"
        },
        "StartDateTime": {
            "DateTime": "2017-12-18T08:00:00.0000000",
            "TimeZone": "UTC"
        }
  }
}

要求のサンプル

次の例では、以前にフラグが設定された連絡先を Complete に設定します。

PATCH https://outlook.office.com/api/beta/me/contacts/AAMkADlkAAARKMK7AAA=
Content-Type: application/json

{
  "Flag": {
    "CompletedDateTime":{
      "DateTime": "2018-02-05T18:00:00",
      "TimeZone": "Pacific Standard Time"
    },
    "FlagStatus": "Complete"
  }
}

応答のサンプル

Status code: 200

{
  "@odata.context":"https://outlook.office365.com/api/beta/$metadata#Me/Contacts/$entity",
  "@odata.id":"https://outlook.office365.com/api/beta/Users('af183ae6-7efa-41e4-aa87-fe8790598625@9ac5b33f-49cf-45f7-9ef1-b581dce364d8')/Contacts('AAMkADlkAAARKMK7AAA=')",
  "@odata.etag":"W/\"EQAAABYAAADDii8zlkFETIcBiRn8yAbgAAARKpia\"",
  "Id":"AAMkADlkAAARKMK7AAA=",
  "CreatedDateTime":"2016-07-20T23:59:37Z",
  "LastModifiedDateTime":"2016-07-20T23:59:38Z",
  "ChangeKey":"EQAAABYAAABmngqUDhbeSLkRkXbBznTvAAEw/xwn",
  "Categories":[
  ],
  "ParentFolderId":"AAMkADlk8yAbgAAAAAAEOAAA=",
  "Birthday":"1974-07-22T00:00:00Z",
  "FileAs":"",
  "DisplayName":"Pavel Bansky",
  "GivenName":"Pavel",
  "Initials":null,
  "MiddleName":null,
  "NickName":null,
  "Surname":"Bansky",
  "Title":null,
  "YomiGivenName":null,
  "YomiSurname":null,
  "YomiCompanyName":null,
  "Generation":null,
  "EmailAddresses":[
    {
      "Name":"Pavel Bansky",
      "Address":"pavelb@contoso.onmicrosoft.com"
    }
  ],
  "Websites":[
  ],
  "ImAddresses":[
  ],
  "JobTitle":null,
  "CompanyName":null,
  "Department":null,
  "OfficeLocation":null,
  "Profession":null,
  "AssistantName":null,
  "Manager":null,
  "Phones":[
    {
      "Type":"Business",
      "Number":"+1 732 555 0102"
    }
  ],
  "PostalAddresses":[
    {
      "Type": "Business",
      "Street": "Some street",
      "City": "Seattle",
      "State": "WA",
      "PostalCode": "98121"
    }
  ],
  "SpouseName":null,
  "PersonalNotes":null,
  "Children":[
  ],
  "Gender":null,
  "IsFavorite":null,
  "Flag": {
    "FlagStatus": "Complete",
    "CompletedDateTime": {
        "DateTime": "2018-02-06T00:00:00.0000000",
        "TimeZone": "UTC"
    }
  }
}

応答の種類

更新された連絡先です。

最低限必要なスコープ: 次のいずれか:

要求本文に任意の書き込み可能な連絡先プロパティを指定します。指定したプロパティのみが変更されます。

PATCH https://outlook.office.com/api/v2.0/me/contacts/{contact_id}
必須パラメーター説明
URL パラメーター
contact_idstring連絡先の ID。

要求のサンプル

PATCH https://outlook.office.com/api/v2.0/me/contacts/AAMkAGI2THkzAAA=
Content-Type: application/json

{
  "HomeAddress": {
    "Street": "Some street",
    "City": "Seattle",
    "State": "WA",
    "PostalCode": "98121"
  },
  "Birthday": "1974-07-22"
}

応答のサンプル

Status code: 200

{
  "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Contacts/$entity",
  "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Contacts('AAMkAGI2THkzAAA=')",
  "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa3\"",
  "Id": "AAMkAGI2THkzAAA=",
  "ChangeKey": "EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa3",
  "Categories": [],
  "CreatedDateTime": "2014-10-19T23:08:18Z",
  "LastModifiedDateTime": "2014-10-19T23:08:18Z",
  "ParentFolderId": "AAMkAGI2AAEOAAA=",
  "Birthday": "1974-07-22T00:00:00Z",
  "FileAs": "Schorr, Janet",
  "DisplayName": "Janet Schorr",
  "GivenName": "Janet",
  "Initials": null,
  "MiddleName": null,
  "NickName": null,
  "Surname": "Schorr",
  "Title": null,
  "Generation": null,
  "EmailAddresses": [
    {
      "Address": "janets@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "janets@a830edad9050849NDA1.onmicrosoft.com"
    },
    null,
    null
  ],
  "ImAddresses": [
    "sip:janets@a830edad9050849nda1.onmicrosoft.com",
    null,
    null
  ],
  "JobTitle": "Product Marketing Manager",
  "CompanyName": null,
  "Department": "Sales & Marketing",
  "OfficeLocation": "18/2111",
  "Profession": null,
  "BusinessHomePage": null,
  "AssistantName": null,
  "Manager": null,
  "HomePhones": [
    null,
    null
  ],
  "BusinessPhones": [
    "+1 425 555 0109",
    null
  ],
  "MobilePhone1": null,
  "HomeAddress": {
    "Street": "Some street",
    "City": "Seattle",
    "State": "WA",
    "CountryOrRegion": null,
    "PostalCode": "98121"
  },
  "BusinessAddress": {
    "Street": null,
    "City": null,
    "State": null,
    "CountryOrRegion": null,
    "PostalCode": null
  },
  "OtherAddress": {
    "Street": null,
    "City": null,
    "State": null,
    "CountryOrRegion": null,
    "PostalCode": null
  },
  "SpouseName": null,
  "PersonalNotes": null,
  "Children": [],
  "YomiSurname": null,
  "YomiGivenName": null,
  "YomiCompanyName": null
}

応答の種類

更新された連絡先です。

最低限必要なスコープ: 次のいずれか:

要求本文に任意の書き込み可能な連絡先プロパティを指定します。指定したプロパティのみが変更されます。

PATCH https://outlook.office.com/api/v1.0/me/contacts/{contact_id}
必須パラメーター説明
URL パラメーター
contact_idstring連絡先の ID。

要求のサンプル

PATCH https://outlook.office.com/api/v1.0/me/contacts/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHkzAAA=
Content-Type: application/json
{
  "HomeAddress": {
    "Street": "Some street",
    "City": "Seattle",
    "State": "WA",
    "PostalCode": "98121"
  },
  "Birthday": "1974-07-22"
}

応答のサンプル

状態コード:200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/Contacts/$entity",
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "@odata.etag": "W/\"EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa3\"",
  "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQBGAAAAAADUuTJK1K9aTpCdqXop_4NaBwCd9nJ-tVysQos2hTfspaWRAAAAAAEOAACd9nJ-tVysQos2hTfspaWRAAADTHkzAAA=",
  "ChangeKey": "EQAAABYAAACd9nJ/tVysQos2hTfspaWRAAADTIa3",
  "Categories": [],
  "DateTimeCreated": "2014-10-19T23:08:18Z",
  "DateTimeLastModified": "2014-10-19T23:08:18Z",
  "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEOAAA=",
  "Birthday": "1974-07-22T00:00:00Z",
  "FileAs": "Schorr, Janet",
  "DisplayName": "Janet Schorr",
  "GivenName": "Janet",
  "Initials": null,
  "MiddleName": null,
  "NickName": null,
  "Surname": "Schorr",
  "Title": null,
  "Generation": null,
  "EmailAddresses": [
    {
      "Address": "janets@a830edad9050849NDA1.onmicrosoft.com",
      "Name": "janets@a830edad9050849NDA1.onmicrosoft.com"
    },
    null,
    null
  ],
  "ImAddresses": [
    "sip:janets@a830edad9050849nda1.onmicrosoft.com",
    null,
    null
  ],
  "JobTitle": "Product Marketing Manager",
  "CompanyName": null,
  "Department": "Sales & Marketing",
  "OfficeLocation": "18/2111",
  "Profession": null,
  "BusinessHomePage": null,
  "AssistantName": null,
  "Manager": null,
  "HomePhones": [
    null,
    null
  ],
  "BusinessPhones": [
    "+1 425 555 0109",
    null
  ],
  "MobilePhone1": null,
  "HomeAddress": {
    "Street": "Some street",
    "City": "Seattle",
    "State": "WA",
    "CountryOrRegion": null,
    "PostalCode": "98121"
  },
  "BusinessAddress": {
    "Street": null,
    "City": null,
    "State": null,
    "CountryOrRegion": null,
    "PostalCode": null
  },
  "OtherAddress": {
    "Street": null,
    "City": null,
    "State": null,
    "CountryOrRegion": null,
    "PostalCode": null
  },
  "YomiSurname": null,
  "YomiGivenName": null,
  "YomiCompanyName": null
}

応答の種類

更新された連絡先です。


連絡先を削除する

連絡先を削除します。削除した内容を回復できない可能性があります。詳細については、「アイテムの削除」を参照してください。

連絡先を削除する

連絡先を削除する

最低限必要なスコープ: 次のいずれか:

DELETE https://outlook.office.com/api/beta/me/contacts/{contact_id}
必須パラメーター説明
URL パラメーター
contact_idstring連絡先の ID。

要求のサンプル

DELETE https://outlook.office.com/api/beta/me/contacts/AAMkAGE0Myy2hAAA=

応答のサンプル

Status code: 204

最低限必要なスコープ: 次のいずれか:

DELETE https://outlook.office.com/api/v2.0/me/contacts/{contact_id}
必須パラメーター説明
URL パラメーター
contact_idstring連絡先の ID。

要求のサンプル

DELETE https://outlook.office.com/api/v2.0/me/contacts/AAMkAGE0Myy2hAAA=

応答のサンプル

Status code: 204

最低限必要なスコープ: 次のいずれか:

DELETE https://outlook.office.com/api/v1.0/me/contacts/{contact_id}
必須パラメーター説明
URL パラメーター
contact_idstring連絡先の ID。

要求のサンプル

DELETE https://outlook.office.com/api/v1.0/me/contacts/AAMkAGE0Myy2hAAA=

応答のサンプル

Status code: 204

連絡先フォルダーの取得

連絡先フォルダーのコレクションを取得したり、連絡先フォルダーを取得したりすることができます。

連絡先フォルダーのコレクションを取得する | 連絡先フォルダーを取得する

連絡先フォルダーのコレクションを取得する

最低限必要なスコープ: 次のいずれか:

サインインしているユーザーのメールボックス内のすべての連絡先フォルダーを取得する (.../me/contactfolders) か、指定された連絡先フォルダーから取得します。

GET https://outlook.office.com/api/beta/me/contactfolders
GET https://outlook.office.com/api/beta/me/contactfolders/{contact_folder_id}/childfolders

メモ パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」を参照してください。

必須パラメーター説明
URL・パラメーター
contact_folder_idstring特定の連絡先フォルダーから連絡先フォルダーを取得している場合は、連絡先フォルダー ID です。

要求のサンプル

GET https://outlook.office.com/api/beta/me/contactfolders

応答のサンプル

状態コード:200

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/ContactFolders",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/ContactFolders('AAMkAGI2TKI5AAA=')",
            "Id": "AAMkAGI2TKI5AAA=",
            "ParentFolderId": "AAMkAGI2AAEOAAA=",
            "DisplayName": "Finance",
            "WellKnownName": null
        },
        {
            "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/ContactFolders('AQMkADA1MTgAAAA==')",
            "Id": "AQMkADA1MTgAAAA==",
            "ParentFolderId": "AAMkAGI2AAEOAAA=",
            "DisplayName": "Contacts",
            "WellKnownName": "contacts"
        }
    ]
}

応答の種類

要求された連絡先フォルダーのコレクションです。


連絡先フォルダーを取得する

最低限必要なスコープ: 次のいずれか:

連絡先フォルダー ID を使用して連絡先フォルダーを取得します。

GET https://outlook.office.com/api/beta/me/contactfolders/{contact_folder_id}

メモ パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」を参照してください。

必須パラメーター説明
URL・パラメーター
contact_folder_idstring連絡先フォルダー ID。

要求のサンプル

GET https://outlook.office.com/api/beta/me/contactfolders/AAMkAGI2TKI5AAA=

応答のサンプル

状態コード:200

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/ContactFolders/$entity",
    "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/ContactFolders('AAMkAGI2TKI5AAA=')",
    "Id": "AAMkAGI2TKI5AAA=",
    "ParentFolderId": "AAMkAGI2AAEOAAA=",
    "DisplayName": "Finance",
    "WellKnownName": null
}

応答の種類

要求された連絡先フォルダーです。

連絡先フォルダーのコレクションを取得する

最低限必要なスコープ: 次のいずれか:

サインイン中のユーザーの既定の連絡先フォルダーから連絡先フォルダーのコレクションを取得する (.../me/contactfolders) か、指定した連絡先フォルダーから取得します。

GET https://outlook.office.com/api/v2.0/me/contactfolders
GET https://outlook.office.com/api/v2.0/me/contactfolders/{contact_folder_id}/childfolders

メモ パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」を参照してください。

必須パラメーター説明
URL・パラメーター
contact_folder_idstring特定の連絡先フォルダーから連絡先フォルダーを取得している場合は、連絡先フォルダー ID です。

要求のサンプル

GET https://outlook.office.com/api/v2.0/me/contactfolders

応答のサンプル

状態コード:200

{
    "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/ContactFolders",
    "value": [
        {
            "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/ContactFolders('AAMkAGI2TKI5AAA=')",
            "Id": "AAMkAGI2TKI5AAA=",
            "ParentFolderId": "AAMkAGI2AAEOAAA=",
            "DisplayName": "Finance"
        }
    ]
}

応答の種類

要求された連絡先フォルダーのコレクションです。


連絡先フォルダーを取得する

最低限必要なスコープ: 次のいずれか:

連絡先フォルダー ID を使用して連絡先フォルダーを取得します。

GET https://outlook.office.com/api/v2.0/me/contactfolders/{contact_folder_id}

メモ パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」を参照してください。

必須パラメーター説明
URL・パラメーター
contact_folder_idstring連絡先フォルダー ID。

要求のサンプル

GET https://outlook.office.com/api/v2.0/me/contactfolders/AAMkAGI2TKI5AAA=

応答のサンプル

Status code: 200

{
    "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/ContactFolders/$entity",
    "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/ContactFolders('AAMkAGI2TKI5AAA=')",
    "Id": "AAMkAGI2TKI5AAA=",
    "ParentFolderId": "AAMkAGI2AAEOAAA=",
    "DisplayName": "Finance"
}

応答の種類

要求された連絡先フォルダーです。

連絡先フォルダーのコレクションを取得する

最低限必要なスコープ: 次のいずれか:

サインイン中のユーザーの既定の連絡先フォルダーから連絡先フォルダーのコレクションを取得する (.../me/contactfolders) か、指定した連絡先フォルダーから取得します。

GET https://outlook.office.com/api/v1.0/me/contactfolders
GET https://outlook.office.com/api/v1.0/me/contactfolders/{contact_folder_id}/childfolders

メモ パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」を参照してください。

必須パラメーター説明
URL・パラメーター
contact_folder_idstring特定の連絡先フォルダーから連絡先フォルダーを取得している場合は、連絡先フォルダー ID です。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/contactfolders

応答のサンプル

状態コード:200

{
  "@odata.context": "https://outlook.office.com/api/v1.0/$metadata#Me/ContactFolders",
  "value": [
    {
      "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
      "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAADTKI5AAA=",
      "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEOAAA=",
      "DisplayName": "Finance"
    }
  ]
}

応答の種類

要求された連絡先フォルダーのコレクションです。


連絡先フォルダーを取得する

最低限必要なスコープ: 次のいずれか:

連絡先フォルダー ID を使用して連絡先フォルダーを取得します。

GET https://outlook.office.com/api/v1.0/me/contactfolders/{contact_folder_id}

メモ パラメーターのフィルタリング、並べ替え、およびページングについては、「OData クエリ パラメーター」を参照してください。

必須パラメーター説明
URL・パラメーター
contact_folder_idstring連絡先フォルダー ID。

要求のサンプル

GET https://outlook.office.com/api/v1.0/me/contactfolders/AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAADTKI5AAA=

応答のサンプル

状態コード:200

{
  "@odata.id": "https://outlook.office.com/api/v1.0/Users('ddfcd489-628b-40d7-b48b-57002df800e5@1717622f-1d94-4d0c-9d74-709fad664b77')/Events('AAMkAGE4v1RAAA=')",
  "Id": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAADTKI5AAA=",
  "ParentFolderId": "AAMkAGI2NGVhZTVlLTI1OGMtNDI4My1iZmE5LTA5OGJiZGEzMTc0YQAuAAAAAADUuTJK1K9aTpCdqXop_4NaAQCd9nJ-tVysQos2hTfspaWRAAAAAAEOAAA=",
  "DisplayName": "Finance"
}

応答の種類

要求された連絡先フォルダーです。


連絡先の写真とメタデータを取得する

連絡先の写真を取得する | 連絡先の写真のメタデータを取得する

連絡先の写真を取得する

最低限必要なスコープ: 次のいずれか:

指定したサインインしているユーザーの連絡先の写真を取得します。

GET https://outlook.office.com/api/beta/me/contacts('{contact_id}')/photo/$value
必須パラメーター説明
URL パラメーター
contact_idstringサインインしているユーザーの特定の連絡先を指定する ID です。

要求のサンプル

GET https://outlook.office.com/api/beta/me/contacts('AAMkAGE1M2IyNGNm===')/photo/$value
Content-Type: image/jpg

応答データ

要求した写真のバイナリ データが含まれています。HTTP 応答コードは 200 です。

この操作では、Exchange Online で連絡先に連絡先の写真がまだない場合に、HTTP 404 を返します。


連絡先の写真のメタデータを取得する

最低限必要なスコープ: 次のいずれか:

コンテンツの種類、幅および高さがピクセル単位で含まれている連絡先の写真のメタデータを取得します。

GET https://outlook.office.com/api/beta/me/contacts('{contact_id}')/photo
必須パラメーター説明
URL パラメーター
contact_idstringサインインしているユーザーの特定の連絡先を指定する ID です。

要求のサンプル

GET https://outlook.office.com/api/beta/me/contacts('AAMkAGE1M2IyNGNm')/photo

応答データのサンプル

成功した要求は、HTTP 200 を返します。

{
    "@odata.context": "https://outlook.office.com/api/beta/$metadata#Me/Contacts('AAMkAGE1M2IyNGNm')/photo/$entity",
    "@odata.id": "https://outlook.office.com/api/beta/Users('ddfcd489-b826-40d7-b48b-57002df800e5@1717622f-49d1-4d0c-9d74-709fad664b77')/contacts('AAMkAGE1M2IyNGNm')/photo",
    "@odata.readLink": "https://outlook.office.com/api/beta/Users('ddfcd489-b826-40d7-b48b-57002df800e5@1717622f-49d1-4d0c-9d74-709fad664b77')/contacts('AAMkAGE1M2IyNGNm')/photo",
    "@odata.mediaContentType": "image/jpeg",
    "Id": "103X77",
    "Width": 103,
    "Height": 77
}

連絡先の写真を取得する | 連絡先の写真のメタデータを取得する

連絡先の写真を取得する

最低限必要なスコープ: 次のいずれか:

指定したサインインしているユーザーの連絡先の写真を取得します。

GET https://outlook.office.com/api/v2.0/me/contacts('{contact_id}')/photo/$value
必須パラメーター説明
URL パラメーター
contact_idstringサインインしているユーザーの特定の連絡先を指定する ID です。

要求のサンプル

GET https://outlook.office.com/api/v2.0/me/contacts('AAMkAGE1M2IyNGNm===')/photo/$value
Content-Type: image/jpg

応答データ

要求した写真のバイナリ データが含まれています。HTTP 応答コードは 200 です。

この操作では、Exchange Online で連絡先に連絡先の写真がまだない場合に、HTTP 404 を返します。


連絡先の写真のメタデータを取得する

最低限必要なスコープ: 次のいずれか:

コンテンツの種類、幅および高さがピクセル単位で含まれている連絡先の写真のメタデータを取得します。

GET https://outlook.office.com/api/v2.0/me/contacts('{contact_id}')/photo
必須パラメーター説明
URL パラメーター
contact_idstringサインインしているユーザーの特定の連絡先を指定する ID です。

要求のサンプル

GET https://outlook.office.com/api/v2.0/me/contacts('AAMkAGE1M2IyNGNm')/photo

応答データのサンプル

成功した要求は、HTTP 200 を返します。

{
    "@odata.context": "https://outlook.office.com/api/v2.0/$metadata#Me/Contacts('AAMkAGE1M2IyNGNm')/photo/$entity",
    "@odata.id": "https://outlook.office.com/api/v2.0/Users('ddfcd489-b826-40d7-b48b-57002df800e5@1717622f-49d1-4d0c-9d74-709fad664b77')/contacts('AAMkAGE1M2IyNGNm')/photo",
    "@odata.readLink": "https://outlook.office.com/api/v2.0/Users('ddfcd489-b826-40d7-b48b-57002df800e5@1717622f-49d1-4d0c-9d74-709fad664b77')/contacts('AAMkAGE1M2IyNGNm')/photo",
    "@odata.mediaContentType": "image/jpeg",
    "Id": "103X77",
    "Width": 103,
    "Height": 77
}

この機能は V2.0 とベータ版で利用できます。詳細については、記事の右上隅にコントロールを使用して、どちらかのバージョンを選択します。


連絡先の写真を設定する

最低限必要なスコープ: 次のいずれか:

指定したサインインしているユーザーの連絡先に写真を割り当てます。写真はバイナリ形式にする必要があります。該当する連絡先の既存の写真と置き換えられます

ベータ版では、この操作に PUT のみを使用します。

PUT https://outlook.office.com/api/beta/me/contacts('{contact_id}')/photo/$value
必須パラメーター説明
URL パラメーター
contact_idstringサインインしているユーザーの特定の連絡先を指定する ID です。

要求のサンプル

PUT https://outlook.office.com/api/beta/me/contacts('AAMkAGE1M2IyNGNm===')/photo/$value
Content-Type: image/jpeg

要求の本文に、写真のバイナリ データを含めます。

応答データ

成功した要求は、HTTP 200 を返します。

最低限必要なスコープ: 次のいずれか:

指定したサインインしているユーザーの連絡先に写真を割り当てます。写真はバイナリ形式にする必要があります。該当する連絡先の既存の写真と置き換えられます

バージョン 2.0 では、この操作に PATCH または PUT を使用できます。

PATCH https://outlook.office.com/api/v2.0/me/contacts('{contact_id}')/photo/$value

PUT https://outlook.office.com/api/v2.0/me/contacts('{contact_id}')/photo/$value
必須パラメーター説明
URL パラメーター
contact_idstringサインインしているユーザーの特定の連絡先を指定する ID です。

要求のサンプル

PUT https://outlook.office.com/api/v2.0/me/contacts('AAMkAGE1M2IyNGNm===')/photo/$value
Content-Type: image/jpeg

要求の本文に、写真のバイナリ データを含めます。

応答データ

成功した要求は、HTTP 200 を返します。

この機能は V2.0 とベータ版で利用できます。詳細については、記事の右上隅にコントロールを使用して、どちらかのバージョンを選択します。


次の手順

アプリケーション開発を開始する準備ができている方にも、単に詳しい情報を必要としている方にも、最適なコンテンツをご用意しています。

Office 365 プラットフォームの使い方の詳細については、次のリンク先をご覧ください。

© 2018 Microsoft