API リファレンス

連絡先

機能の対応状況は app.capabilities、認可は app.access とホストの権限で確認してください。例は合成値を使用しています。呼び出す前にパス、ID、入力、フィルターを置き換えてください。

型定義

graphql
type Mutation {
  createContact(input: ContactInput!): Contact!
  createContactGroup(name: String!, accountName: String!, accountType: String!): ContactGroup!
  deleteContactGroup(id: ID!): Boolean!
  deleteContacts(query: String!): ActionResult!
  updateContact(id: ID!, input: ContactInput!): Contact!
  updateContactGroup(id: ID!, name: String!): ContactGroup!
}

type Query {
  contactCount(query: String!): Int!
  contactGroups: [ContactGroup!]!
  contactSources: [ContactSource!]!
  contacts(query: String!, offset: Int!, limit: Int!): [Contact!]!
}

type ActionResult {
	affectedCount: Int!
}

type Contact {
	id: ID!
	prefix: String!
	firstName: String!
	middleName: String!
	lastName: String!
	suffix: String!
	nickname: String!
	photoId: String!
	phoneNumbers: [ContactPhoneNumber!]!
	emails: [ContactEmail!]!
	addresses: [ContactAddress!]!
	events: [ContactEvent!]!
	source: String!
	starred: Boolean!
	contactId: ID!
	thumbnailId: String!
	notes: String!
	groups: [ContactGroup!]!
	organization: ContactOrganization
	websites: [ContactWebsite!]!
	ims: [ContactIm!]!
	ringtone: String!
	updatedAt: Instant!
	tags: [Tag!]!
}

type ContactAddress {
	typeCode: Int!
	value: String!
	type: ContactPostalType!
	label: String!
}

input ContactAddressInput {
	value: String!
	type: ContactPostalType!
	label: String!
}

type ContactEmail {
	typeCode: Int!
	value: String!
	type: ContactEmailType!
	label: String!
}

input ContactEmailInput {
	value: String!
	type: ContactEmailType!
	label: String!
}

enum ContactEmailType {
	CUSTOM
	HOME
	WORK
	OTHER
	MOBILE
}

type ContactEvent {
	typeCode: Int!
	value: String!
	type: ContactEventType!
	label: String!
}

input ContactEventInput {
	value: String!
	type: ContactEventType!
	label: String!
}

enum ContactEventType {
	CUSTOM
	ANNIVERSARY
	BIRTHDAY
	OTHER
}

type ContactGroup {
	id: ID!
	name: String!
	contactCount: Int!
}

type ContactIm {
	typeCode: Int!
	value: String!
	protocol: ContactImProtocol!
	customProtocol: String!
}

input ContactImInput {
	value: String!
	protocol: ContactImProtocol!
	customProtocol: String!
}

enum ContactImProtocol {
	CUSTOM
	AIM
	MSN
	YAHOO
	SKYPE
	QQ
	GOOGLE_TALK
	ICQ
	JABBER
	NETMEETING
}

input ContactInput {
	prefix: String!
	firstName: String!
	middleName: String!
	lastName: String!
	suffix: String!
	nickname: String!
	phoneNumbers: [ContactPhoneInput!]!
	emails: [ContactEmailInput!]!
	addresses: [ContactAddressInput!]!
	events: [ContactEventInput!]!
	source: String!
	starred: Boolean!
	notes: String!
	groupIds: [ID!]!
	organization: ContactOrganizationInput
	websites: [ContactWebsiteInput!]!
	ims: [ContactImInput!]!
}

type ContactOrganization {
	company: String!
	title: String!
}

input ContactOrganizationInput {
	company: String!
	title: String!
}

input ContactPhoneInput {
	value: String!
	type: ContactPhoneType!
	label: String!
}

type ContactPhoneNumber {
	typeCode: Int!
	value: String!
	type: ContactPhoneType!
	label: String!
	normalizedNumber: String!
}

enum ContactPhoneType {
	CUSTOM
	HOME
	MOBILE
	WORK
	FAX_WORK
	FAX_HOME
	PAGER
	OTHER
	CALLBACK
	CAR
	COMPANY_MAIN
	ISDN
	MAIN
	OTHER_FAX
	RADIO
	TELEX
	TTY_TDD
	WORK_MOBILE
	WORK_PAGER
	ASSISTANT
}

enum ContactPostalType {
	CUSTOM
	HOME
	WORK
	OTHER
}

type ContactSource {
	name: String!
	type: String!
}

type ContactWebsite {
	typeCode: Int!
	value: String!
	type: ContactWebsiteType!
	label: String!
}

input ContactWebsiteInput {
	value: String!
	type: ContactWebsiteType!
	label: String!
}

enum ContactWebsiteType {
	CUSTOM
	HOMEPAGE
	BLOG
	FTP
	HOME
	WORK
	OTHER
}

enum DataType {
	DEFAULT
	AUDIO
	VIDEO
	IMAGE
	SMS
	CONTACT
	NOTE
	FEED_ENTRY
	CALL
	PACKAGE
	FILE
	APP_FILE
	DOC
}

scalar Instant

type Tag {
	id: ID!
	name: String!
	type: DataType!
	count: Int!
}

操作

mutation

createContact

新しい連絡先を作成します。

graphql
mutation createContact($input: ContactInput!) {
  createContact(input: $input) { id prefix firstName middleName lastName suffix nickname photoId }
}
mutation

createContactGroup

特定のアカウントに連絡先グループを作成します。

graphql
mutation createContactGroup($name: String!, $accountName: String!, $accountType: String!) {
  createContactGroup(name: $name, accountName: $accountName, accountType: $accountType) { id name contactCount }
}
mutation

deleteContactGroup

連絡先グループを削除します。グループ内の連絡先は削除せず、グループ分けのみ解除します。

graphql
mutation deleteContactGroup($id: ID!) {
  deleteContactGroup(id: $id)
}
mutation

deleteContacts

クエリに一致するすべての連絡先を削除します。

graphql
mutation deleteContacts($query: String!) {
  deleteContacts(query: $query) { affectedCount }
}
mutation

updateContact

既存の連絡先を更新します。指定されたフィールドのみ変更します。

graphql
mutation updateContact($id: ID!, $input: ContactInput!) {
  updateContact(id: $id, input: $input) { id prefix firstName middleName lastName suffix nickname photoId }
}
mutation

updateContactGroup

連絡先グループの名前を変更します。

graphql
mutation updateContactGroup($id: ID!, $name: String!) {
  updateContactGroup(id: $id, name: $name) { id name contactCount }
}
query

contactCount

クエリに一致する連絡先数を数えます。

graphql
query contactCount($query: String!) {
  contactCount(query: $query)
}
query

contactGroups

すべての連絡先グループを一覧表示します。

graphql
query contactGroups {
  contactGroups { id name contactCount }
}
query

contactSources

利用可能な連絡先アカウントのソースを一覧表示します。

graphql
query contactSources {
  contactSources { name type }
}
query

contacts

連絡先を検索します。すべて表示するには query を空にします。

graphql
query contacts($query: String!, $offset: Int!, $limit: Int!) {
  contacts(query: $query, offset: $offset, limit: $limit) { id prefix firstName middleName lastName suffix nickname photoId }
}