Référence de l'API

Appels

Vérifier app.capabilities pour la prise en charge des fonctionnalités et app.access ainsi que les permissions de l’hôte pour les autorisations. Les exemples utilisent des valeurs synthétiques ; remplacer les chemins, ID, entrées et filtres avant tout appel.

Définitions de types

graphql
type Mutation {
  call(number: String!, showDialer: Boolean!): Boolean!
  deleteCalls(query: String!): ActionResult!
}

type Query {
  callCount(query: String!): Int!
  calls(query: String!, offset: Int!, limit: Int!): [Call!]!
}

type ActionResult {
	affectedCount: Int!
}

type Call {
	typeCode: Int!
	id: ID!
	number: String!
	name: String!
	photo: String!
	startedAt: Instant!
	durationSec: Int!
	type: CallType!
	accountId: ID!
	geo: PhoneGeo
	tags: [Tag!]!
}

enum CallType {
	INCOMING
	OUTGOING
	MISSED
	VOICEMAIL
	REJECTED
	BLOCKED
	ANSWERED_EXTERNALLY
	UNKNOWN
}

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

scalar Instant

type PhoneGeo {
	country: String!
	numberType: PhoneNumberType!
	carrier: String!
	description: String!
}

enum PhoneNumberType {
	FIXED_LINE
	MOBILE
	FIXED_LINE_OR_MOBILE
	TOLL_FREE
	PREMIUM_RATE
	SHARED_COST
	PERSONAL_NUMBER
	VOIP
	PAGER
	UAN
	VOICEMAIL
}

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

Opérations

mutation

call

Appeler le numéro indiqué. Définir showDialer sur true pour ouvrir le composeur de l’application Téléphone au lieu d’appeler immédiatement. Nécessite l’autorisation CALL_PHONE.

graphql
# `showDialer` hands the number to the dialer instead of placing the
# call outright.
mutation call($number: String!, $showDialer: Boolean!) {
  call(number: $number, showDialer: $showDialer)
}
mutation

deleteCalls

Supprimer les entrées du journal d’appels correspondant à une requête.

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

callCount

Compter les appels correspondant à une requête.

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

calls

Rechercher les entrées du journal d’appels. Laisser query vide pour toutes les lister.

graphql
query calls($query: String!, $offset: Int!, $limit: Int!) {
  calls(query: $query, offset: $offset, limit: $limit) { typeCode id number name photo startedAt durationSec type }
}