Tipos de dados

Atualizada mais de uma semana atras

Os resultados retornados para pesquisas de tipo de data na API retornarão informações em um dos formatos descritos abaixo.

Esses documentos ainda estão sendo preenchidos com informações. Se você tiver alguma dúvida, não hesite em entrar em contato .

arquivos

O tipo de dados do file é visto em toda a API, pois é uma referência a um arquivo que pode ser baixado da API por meio de uma pesquisa de tipo de files .

Atributos

nome	tipo	descrição
`id`	corda	Identificador usado para solicitar o arquivo da API. O valor só é garantido como único no escopo da fonte atual.
`data_type`	string, sempre `file`	Especificador de tipo de dados.
`name`	corda	O nome do arquivo, excluindo a extensão.
`extension`	string, opcional	A extensão do arquivo, se disponível.
`mime_type`	string, opcional	O tipo MIME do arquivo, se disponível.
`size`	int, opcional	O tamanho do arquivo, se disponível.
`checksum`	string, opcional	A soma de verificação md5, se disponível.

Exemplo

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

Imagens

Estende arquivos .

nome	tipo	descrição
`file_name`	corda	O nome do arquivo original do arquivo. A extensão neste nome de arquivo precisa corresponder à extensão do arquivo.
`file_path`	corda	O caminho do arquivo em relação a outros arquivos dentro de seu serviço. Por exemplo, o caminho dentro de um backup.
`width`	int, opcional	A largura do arquivo, se disponível.
`height`	int, opcional	A altura do arquivo, se disponível.

Exemplo

{
  "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,
}

Vídeos

Estende arquivos .

nome	tipo	descrição
`file_name`	corda	O nome do arquivo original do arquivo. A extensão neste nome de arquivo precisa corresponder à extensão do arquivo.
`file_path`	corda	O caminho do arquivo em relação a outros arquivos dentro de seu serviço. Por exemplo, o caminho dentro de um backup.
`width`	int, opcional	A largura do arquivo, se disponível.
`height`	int, opcional	A altura do arquivo, se disponível.
`duration`	int, opcional	A duração do vídeo, se disponível.

Exemplo

{
  "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
}

Mensagens

Atributos

nome	tipo	descrição
`id`	corda	Um identificador exclusivo para a mensagem. Use isso para desduplicar os dados retornados, se necessário.
`data_type`	string, sempre `message`	Especificador de tipo de dados.
`conversation_id`	corda	Identificador agrupando mensagens por conversa.
`date`	data hora	Quando a mensagem foi enviada ou recebida.
`text`	corda	O corpo da mensagem.
`from_me`	bool	Se a mensagem foi enviada ou recebida.
`handle`	corda	A segunda parte da conversa.
`attachments`	lista de arquivos, opcional	Uma matriz de valores de `file_id` que podem ser usados com o método `download_file` . Se a mensagem não incluir nenhum anexo, será retornada uma matriz vazia.
`group_handles`	lista de strings, opcional	Esse valor é `null` para mensagens de pessoa para pessoa e, em conversas de grupo, é uma matriz de cadeias que representa números de telefone ou endereços de e-mail do iMessage.
`group`	string, opcional	O nome do grupo no momento em que a mensagem foi enviada .
`group_id`	string, opcional	O identificador exclusivo do grupo no contexto desse aplicativo. Isso pode não ser um número inteiro e, se presente, fornece apenas informações além de `conversation_id` .
`group_contacts`	string, opcional	Uma matriz de objetos que fazem referência aos contatos do iOS no grupo.
`user`	string, opcional	O usuário do aplicativo de mensagens no caso de vários usuários / contas poderem estar usando um aplicativo de mensagens do dispositivo.
`type`	string, opcional	Usado quando um serviço de mensagens lida com vários tipos de mensagens. Por exemplo, `SMS` e `iMessage` no caso de mensagens do iOS.
`deleted`	bool, opcional	Um valor booleano para indicar se a mensagem foi excluída.
`contact`	contato aninhado, opcional	Um objeto que faz referência a um contato do iOS da segunda parte da conversa.

Exemplo

{
  "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"
}

Contatos

Exemplo

{
  "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"
}

Chamadas

{
  "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"
}

Entradas na agenda

Notas

{
  "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"
}

Entradas do histórico do navegador

{
  "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"
}

Localizações

{
  "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"
}

arquivos

Imagens

Vídeos

Mensagens

Contatos

Chamadas

Entradas na agenda

Notas

Entradas do histórico do navegador

Localizações

Como podemos ajudar?