Contacts
Contacts represent individuals (often humans), groups, or Glassware that can be shared with.
HTTP Methods
The contacts resource supports all major CRUD operations as RESTful HTTP methods.
| Description | Method | Path |
|---|---|---|
insert a new contact. | POST | /contacts |
get the contact with the given ID. | GET | /contacts/{contactId} |
list a user’s contacts created by this app. | GET | /contacts |
update the contact with the given ID. | PUT | /contacts/{contactId} |
patch the contact with the given ID as a partial update. | PATCH | /contacts/{contactId} |
delete the contact with the given ID. | DELETE | /contacts/{contactId} |
Read-Only Fields
id | The ID for this contact. |
kind | mirror#contact. |
source | Represents the Glassware application that created this contact. The Mirror API will always set this for you. |
Writable Fields
type | Notes whether this contact is an INDIVIDUAL or a GROUP. |
displayName | The name of this contact, be it a person’s name or a group label. |
speakableName | This should be a phonetic representation of a contact’s name, which Glass will use when you speak the name. Similar to timeline items’ speakableText, but used for input rather than output. |
imageUrls | A list of up to eight URLs that represent this person or group. One is usually sufficient for a single person. |
phoneNumber | A phone number for this contact. Usually a cell phone, since who uses landlines anymore? |
priority | An optional number used to sort contacts when displayed in a list. The higher the number, the higher chance the contact will be at the top of the list. It’s best to keep these numbers low, such as 0 for lowest and up to 10 for highest, lest you end up in an arms race against your own number system. |
acceptTypes | A list of MIME types that this contact will be capable of receiving, displayed as a contact when attempting to SHARE an item of with one of those types. For example, if your sister is in your contact list with the image/* type, her name will be shown as a potential recipient of photographs taken with Glass. |
acceptCommands | A similar idea to acceptTypes, but for voice commands. This is a list of voice commands that a contact can accept. Each list item takes an object that accepts one field type, and can be either TAKE_A_NOTE or POST_AN_UPDATE. |
sharingFeatures | When sharing an item with this contact, this is a list of extra actions that the user can take. Currently, the only valid feature is ADD_CAPTION, which lets a user add a caption to an image. |