Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Namespace: microsoft.graph
Importante
As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Um contato é um item no Outlook no qual você pode organizar e salvar informações sobre as pessoas e organizações com quem se comunica. Os contatos estão contidos em pastas de contatos.
Esse recurso permite:
- Adicionar seus próprios dados às propriedades personalizadas como extensions.
- Assinar as notificações de alteração.
- Usar a consulta delta para controlar adições, exclusões e atualizações incrementais oferecendo uma função delta.
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| Get | contact | Leia as propriedades e as relações do objeto contact. |
| Create | contact | Adicione um contato na pasta de Contatos raiz ou no ponto de extremidade de contatos de outra pasta de contatos. |
| Update | contact | Atualize o objeto contact. |
| Delete | Nenhuma | Exclua um objeto contact. |
| Excluir permanentemente | Nenhum | Elimine permanentemente um contacto e coloque-o na pasta Remoção na pasta Itens Recuperáveis na caixa de correio do utilizador. |
| Obter intervalo de contato | Coleção Contact | Obtenha um conjunto de contatos que foram adicionados, excluídos ou atualizados em uma pasta especificada. |
| Extensões abertas | ||
| Criar extensão aberta | openTypeExtension | Crie uma extensão aberta e adicione propriedades personalizadas a uma instância nova ou existente de um recurso. |
| Obter extensão aberta | Coleção openTypeExtension | Obtenha uma extensão aberta identificada pelo nome da extensão. |
| Propriedades estendidas | ||
| Criar uma propriedade de valor único | contact | Criar uma ou mais propriedades estendidas de valor único em um contato novo ou existente. |
| Obter uma propriedade de valor único | contact | Obter contatos que contenham uma propriedade estendida de valor único usando $expand ou $filter. |
| Criar propriedade com múltiplos valores | contact | Criar uma ou mais propriedades estendidas de vários valores em um contato novo ou existente. |
| Obter propriedade de múltiplos valores | contact | Obter um contato que contenha uma propriedade estendida de vários valores usando $expand. |
Propriedades
| Propriedade | Tipo | Descrição |
|---|---|---|
| assistantName | String | O nome do assistente do contato. |
| birthday | DateTimeOffset | O aniversário do contato. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre no horário UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z |
| categories | Coleção de cadeias de caracteres | As categorias associadas ao contato. Cada categoria corresponde à propriedade displayName de uma outlookCategory definida para o usuário. |
| changeKey | String | Identifica a versão do contato. Sempre que o contacto é alterado, changeKey também é alterado, o que permite ao Exchange aplicar alterações à versão correta do objeto. |
| children | Coleção de cadeias de caracteres | Os nomes dos filhos do contato. |
| nomeDaEmpresa | String | O nome da empresa do contato. |
| createdDateTime | DateTimeOffset | A hora em que o contato foi criado. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre no horário UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z |
| department | String | O departamento do contato. |
| displayName | String | O nome para exibição do contato. Você pode especificar o nome de exibição em uma operação criar ou atualizar. As atualizações posteriores a outras propriedades podem fazer com que um valor gerado automaticamente substitua o valor displayName que especificou. Para preservar a um valor preexistente, inclua-o como o displayName na operação atualizar. |
| emailAddresses | coleção typedEmailAddress | Os endereços de email do contato. |
| fileAs | String | O nome com o qual o contato está arquivado. |
| flag | followupFlag | O valor do sinalizador que indica o status, a data de início, a data para conclusão ou a data de conclusão do contacto. |
| gender | Cadeia de caracteres | O sexo do contacto. |
| generation | String | O sufixo do contacto. |
| givenName | String | O nome do contato. |
| id | Cadeia de caracteres | Identificador exclusivo do contacto.
Por padrão, esse valor muda quando o item é transferido de um contêiner (como uma pasta ou calendário) para outro. Para alterar esse comportamento, use o cabeçalho Prefer: IdType="ImmutableId". Para obter mais informações, consulte o artigo Obter identificadores imutáveis para recursos do Outlook. Somente leitura. |
| imAddresses | Coleção de cadeias de caracteres | Os endereços de mensagens instantâneas do contato. |
| initials | String | As iniciais do contato. |
| jobTitle | String | O cargo do contato. |
| lastModifiedDateTime | DateTimeOffset | A hora em que o contato foi modificado. O tipo Timestamp representa informações de data e hora usando o formato ISO 8601 e está sempre no horário UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z |
| manager | String | O nome do gerente do contato. |
| middleName | String | O nome do meio do contato. |
| nickName | String | O apelido do contato. |
| officeLocation | String | O local do escritório do contato. |
| parentFolderId | String | A ID da pasta pai do contato. |
| personalNotes | String | As anotações do usuário sobre o contato. |
| telefones | Coleção phone | Números de telefone associados ao contacto, por exemplo, telefone de casa, telemóvel e telefone da empresa. |
| postalAddresses | coleção physicalAddress | Endereços associados ao contacto, por exemplo, endereço de casa e endereço comercial. |
| primaryEmailAddress | emailAddress | A endereço de email principal do contacto. |
| profession | String | A profissão do contato. |
| secondaryEmailAddress | emailAddress | O endereço de e-mail secundário do contacto. |
| spouseName | String | O nome do cônjuge/parceiro do contato. |
| surname | String | O sobrenome do contato. |
| tertiaryEmailAddress | emailAddress | O endereço de e-mail terciário do contacto. |
| title | String | O título do contato. |
| websites | Coleção website | Web sites associados ao contacto. |
| weddingAnniversary | Data | O aniversário de casamento do contacto. |
| yomiCompanyName | String | O nome de empresa japonês fonético do contato. |
| yomiGivenName | String | O nome japonês fonético do contato. |
| yomiSurname | String | O sobrenome japonês fonético (apelido) do contacto. |
Relações
| Relação | Tipo | Descrição |
|---|---|---|
| extensions | Coleção extension | A coleção de extensões abertas definidas para o contacto. Anulável. |
| multiValueExtendedProperties | Coleção multiValueLegacyExtendedProperty | A coleção de propriedades estendidas de vários valores definidas para o contato. Somente leitura. Anulável. |
| photo | photo | Imagem de contato opcional. Você pode obter ou definir uma foto de um contato. |
| singleValueExtendedProperties | Coleção singleValueLegacyExtendedProperty | A coleção de propriedades estendidas de valor único definidas para o contato. Somente leitura. Anulável. |
Representação JSON
A representação JSON seguinte mostra o tipo de recurso.
{
"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"}],
"primaryEmailAddress": {"@odata.type": "microsoft.graph.emailAddress"},
"profession": "string",
"secondaryEmailAddress": {"@odata.type": "microsoft.graph.emailAddress"},
"spouseName": "string",
"surname": "string",
"tertiaryEmailAddress": {"@odata.type": "microsoft.graph.emailAddress"},
"title": "string",
"websites": [{"@odata.type": "microsoft.graph.website"}],
"weddingAnniversary": "date",
"yomiCompanyName": "string",
"yomiGivenName": "string",
"yomiSurname": "string"
}
Conteúdo relacionado
- Usar a consulta delta para controlar alterações nos dados do Microsoft Graph
- Obter as alterações incrementais para as mensagens em uma pasta
- Adicionar dados personalizados a recursos usando extensões
- Adicionar dados personalizados aos usuários usando extensões abertas
- Adicionar dados personalizados a grupos usando as extensões do esquema