Типы данных

обновленный более недели назад

Результаты, data для опросов типов data по API, будут возвращать информацию в одном из форматов, описанных ниже.

Эти документы до сих пор заполняются информацией. Если у вас есть какие - либо вопросы, не стесняйтесь связаться .

Результат полезной нагрузки

Атрибуты

Корневая структура данных JSON имеет следующие атрибуты.

имя	тип	описание
`data`	список объектов данных	Данные получены из источника.
`metadata`	объект метаданных	Метаданные, связанные с `data` .

Метаданные

Атрибуты

имя	тип	описание
`count`	ИНТ	Количество объектов в `data` .

файлы

Тип данных file виден во всем API, так как это ссылка на файл, который можно загрузить из API посредством опроса типа files .

Атрибуты

название	тип	описание
`id`	строка	Идентификатор, используемый для запроса файла из API. Это значение гарантированно будет уникальным только в области действия текущего источника.
`data_type`	строка, всегда `file`	Спецификатор типа данных.
`name`	строка	Имя файла, исключая расширение.
`extension`	строка, необязательно	Расширение файла, если доступно.
`mime_type`	строка, необязательно	MIME-тип файла, если он доступен.
`size`	int, необязательно	Размер файла, если имеется.
`checksum`	строка, необязательно	Контрольная сумма md5, если доступна.

пример

{
  "id": "abc123",
  "data_type": "file",
  "name": "IMG_0003",
  "extension": "jpg",
  "mime_type": "image/jpeg",
  "size": 2505426,
}

Изображений

Расширяет файлы .

название	тип	описание
`file_name`	строка	Исходное имя файла. Расширение в этом имени файла должно соответствовать расширению файла.
`file_path`	строка	Путь к файлу относительно других файлов в его службе. Например, путь в резервной копии.
`width`	int, необязательно	Ширина файла, если доступно.
`height`	int, необязательно	Высота файла, если доступно.

пример

{
  "id": "abc123",
  "data_type": "image",
  "file_name": "IMG_0003.JPG",
  "file_path": "Media/DCIM/100APPLE/IMG_0003.JPG",
  "name": "IMG_0003",
  "extension": "jpg",
  "mime_type": "image/jpeg",
  "width": 3000,
  "height": 2002,
  "size": 2505426,
}

Видео

Расширяет файлы .

название	тип	описание
`file_name`	строка	Исходное имя файла. Расширение в этом имени файла должно соответствовать расширению файла.
`file_path`	строка	Путь к файлу относительно других файлов в его службе. Например, путь в резервной копии.
`width`	int, необязательно	Ширина файла, если доступно.
`height`	int, необязательно	Высота файла, если доступно.
`duration`	int, необязательно	Продолжительность видео, если доступно.

пример

{
  "id": "abc123",
  "data_type": "image",
  "file_name": "IMG_0009.MOV",
  "file_path": "Media/DCIM/100APPLE/IMG_0009.MOV",
  "name": "IMG_0009",
  "extension": "mov",
  "mime_type": "video/quicktime",
  "width": 1920,
  "height": 1080,
  "size": 5421796,
  "duration": 9.135623
}

Сообщения

Атрибуты

название	тип	описание
`id`	строка	Уникальный идентификатор сообщения. Используйте это для дедупликации возвращаемых данных, если это необходимо.
`data_type`	строка, всегда `message`	Спецификатор типа данных.
`conversation_id`	строка	Идентификатор группировки сообщений по разговору.
`date`	Дата и время	Когда сообщение было отправлено или получено.
`text`	строка	Тело сообщения.
`from_me`	BOOL	Было ли сообщение отправлено или получено.
`handle`	строка	2-я сторона разговора.
`attachments`	список файлов, необязательно	Массив значений `file_id` который можно использовать с методом `download_file` . Если сообщение не содержит вложений, возвращается пустой массив.
`group_handles`	список строк, необязательно	Это значение равно `null` для личных сообщений, а в групповых беседах - это массив строк, представляющих номера телефонов или адреса электронной почты iMessage.
`group`	строка, необязательно	Название группы на момент отправки сообщения .
`group_id`	строка, необязательно	Уникальный идентификатор группы в контексте этого приложения. Это может быть не целое число, и, если оно присутствует, предоставляет только информацию в дополнение к `conversation_id` .
`group_contacts`	строка, необязательно	Массив объектов, ссылающихся на контакты iOS в группе.
`user`	строка, необязательно	Пользователь приложения обмена сообщениями в случае, когда несколько пользователей / учетных записей могут использовать приложение обмена сообщениями с устройства.
`type`	строка, необязательно	Используется, когда служба сообщений обрабатывает различные типы сообщений. Например, `SMS` и `iMessage` в случае сообщений iOS.
`deleted`	bool, необязательно	Логическое значение, указывающее, было ли сообщение удалено.
`contact`	вложенный контакт, необязательно	Объект, ссылающийся на контакт iOS второго участника разговора.

пример

{
  "id": 6,
  "data_type": "message",
  "type": "SMS",
  "conversation_id": "vodafone",
  "handle": "vodafone",
  "from_me": false,
  "group_handles": [
    "+441234567890",
    "renate@reincubate.com"
  ],
  "text": "Hi from Vodafone!",
  "attachments": [],
  "deleted": false,
  "date": "2015-10-28 09:18:17.000000"
}

контакты

пример

{
  "id": "89CFD201-817E-4D8B-B1E1-18F4B737E889",
  "first_name": "John",
  "last_name": "Appleseed",
  "middle_name": "",
  "nickname": null,
  "prefix": "",
  "suffix": "",
  "birthday": "1980-06-22 00:00:00.000000",
  "note": "College roommate",
  "organisation": null,
  "department": null,
  "job_title": null,
  "records": [
    {
      "type": "Phone",
      "name": "Cell",
      "value": "888-555-5512"
    }, {
      "type": "Phone",
      "name": "Home",
      "value": "888-555-1212"
    }, {
      "type": "Email",
      "name": "Internet",
      "value": "John-Appleseed@mac.com"
    }, {
      "type": "Address",
      "name": "Work",
      "City": "Atlanta",
      "ZIP": "30303",
      "Country": "USA",
      "CountryCode": "US",
      "State": "GA",
      "Street": "3494 Kuhl Avenue"
    }, {
      "type": "Address",
      "name": "Home",
      "City": "Atlanta",
      "ZIP": "30303",
      "Country": "USA",
      "CountryCode": "US",
      "State": "GA",
      "Street": "1234 Laurel Street"
    }
  ],
  "created": "2018-10-30 11:57:39.000000",
  "modified": "2018-10-30 11:57:39.000000"
}

Вызовы

{
  "id": "24116c5b16b85217",
  "data_type": "call",
  "duration": 5.131359,
  "answered": false,
  "from_me": true,
  "date": "2015-07-20 10:23:27.538011",
  "address": "07123456789",
  "call_type": "Phone"
}

Записи календаря

Заметки

{
  "title": "Monday meeting:",
  "note": "Monday meeting:\n Discuss X,\n discuss Y.",
  "summary": null,
  "folder": "icloud",
  "sub_folder": "work",
  "attachments": [
    {
      "type": "image",
      "file_id": "8e22cf6e524357b4eb3da775d193072ebba9543f",
      "file_path": "Media/80DDDEAD-B33F-37B2-7219432C0359/Image.jpeg"
    }
  ],
  "creation_date": "2016-06-06 13:23:20.000000",
  "last_modified": "2016-06-07 15:21:25.000000"
}

Записи истории браузера

{
  "url": "http://www.amazon.co.uk/",
  "last_visit": "2015-09-10 10:30:53.413244",
  "title": "Amazon.co.uk: Low Prices in Electronics, Books, Sports Equipment & more"
}

Места

{
  "id": "",
  "latitude": 51.51440460583699,
  "longitude": -0.09058943950483185,
  "altitude": 0.0,
  "positioning_type": "Wifi",
  "horizontal_accuracy": 65.0,
  "vertical_accuracy": 0.0,
  "date_created": "2017-07-31T11:47:01.883000"
}

Результат полезной нагрузки

Метаданные

файлы

Изображений

Видео

Сообщения

контакты

Вызовы

Записи календаря

Заметки

Записи истории браузера

Места

Как мы можем помочь?