Документация по API

Оглавление


Обзор

В этом разделе описаны API, которые могут применяться в приложении TIUN. С помощью этих API пользовательская программа (Клиент) может выполнять команды и получать различную информацию из приложения TIUN (Сервер). При использовании API соединение между Клиентом и Сервером устанавливается с помощью стандартного сокета TCP/IP. Соединение с сокетом может быть реализовано на любом языке программирования, поддерживающем сокеты (например, на Java, C/C++, C#, Visual Basic, Delphi, NodeJS, PHP и другие). Вы можете ознакомится с нашими примерами перейдя в раздел примеры.
Используемые понятия:


Версия для профессионалов (Tiun Pro)

Внимание! Если Вы используете версию Tiun Pro, перед каждой командой необходимо добавить символ p. Пример: pgetsms, pgetversion


1. Настройки

Для подключения к Серверу убедитесь, что Ваше устройство использует Wi-Fi. При необходимости настройте его для работы в сети. Затем выполните предварительные настройки в приложении:


2. Подключение и авторизация

Для того чтобы начать общаться с сервером, отправлять команды и получать ответы, необходимо сразу после инициализации подключения отправить пароль на сервер. Если отправленный пароль совпал с паролем установленным на сервере, то клиент считается авторизованным. При этом сервер не отправит клиенту результата об успешной или неудачной авторизации.

2.1. Справка, инструкция по использованию

cmdlist

Возвращает список поддерживаемых команд в виде массива JSON объектов.

2.2. Версия

getversion

Возвращает версию мобильного приложения.

3. SMS команды

3.1. Подсчет SMS по типу

getsmscount [TYPE]

Возвращает количество смс указанного типа TYPE, если TYPE не указан, количество всех смс
  • TYPE - тип сообщения, (draft, failed, inbox, outbox, queued, sent)

3.2. Информация о SMS

getsms [N] [TYPE]

Возвращает информацию о сообщении под номером N указанного типа TYPE
  • N - номер сообщения
  • TYPE - тип сообщения, (draft, failed, inbox, outbox, queued, sent)

Оба параметра не обязательны.

3.3. Информация о последних SMS

getsmslast [CNT] [TYPE]

Возвращает информацию о последних CNT сообщениях указанного типа TYPE
  • CNT - количество последних сообщений
  • TYPE - тип сообщения, (draft, failed, inbox, outbox, queued, sent)

Оба параметра не обязательны.

3.4. Информация о SMS после определенной даты

getsmsafter [DATE] [TYPE]

Возвращает информацию о сообщениях после DATE типа TYPE
  • DATE - время в миллисекундах
  • TYPE - тип сообщения, (draft, failed, inbox, outbox, queued, sent)

Параметр DATE обязательный, TYPE не обязательный.

3.5. Отправить SMS

sendsms [JSON]

Формат JSON объекта для отправки сообщения:
{ address: 'номер получателя',
body: 'текст сообщения' }

4. Команды для работы с телефонными вызовами

4.1. Подсчет вызовов по типу

getcallcount [TYPE]

Возвращает количество вызовов указанного типа TYPE, если TYPE не указан, количество всех вызовов
  • TYPE - тип вызова, (incoming, outgoing, missed, voicemail)

4.2. Информация о вызове

getcall [N] [TYPE]

Возвращает информацию о вызове под номером N указанного типа TYPE
  • N - номер вызова
  • TYPE - тип вызова, (incoming, outgoing, missed, voicemail)

Оба параметра не обязательны.

4.3. Информация о последних вызовах

getcalllast [CNT] [TYPE]

Возвращает информацию о последних CNT вызовах указанного типа TYPE
  • CNT - количество последних вызовов
  • TYPE - тип вызова, (incoming, outgoing, missed, voicemail)

Оба параметра не обязательны.

4.4. Информация о вызовах после определенной даты

getcallafter [DATE] [TYPE]

Возвращает информацию о сообщениях после DATE типа TYPE
  • DATE - время в миллисекундах
  • TYPE - тип вызова, (incoming, outgoing, missed, voicemail)

Параметр DATE обязательный, TYPE не обязательный.

4.5. Создать вызов

makecall [NUM]

Инициирует исходящий вызов на номер NUM
Параметр NUM обязателен.

5. Команды для работы с контактами

5.1. Поиск контактов

getcontact [NAME]

Возвращает информацию о контактах с именем содержащим NAME, без NAME возвращает все контакты

5.2. Добавить контакт

addcontact [JSON]

Добавляет контакт. Формат JSON объекта для добавления нового контакта:
{ display_name: 'отображаемое имя',
given_name: 'имя',
family_name: 'фамилия',
middle_name: 'отчество',
prefix: 'Префикс (друг, муж, брат)',
suffix: 'Суффикс',
group: 'название группы',
company: {
name: 'организация',
job_title: 'должность',
},
phones: [{number:'номер', type:тип номера)}],
emails:[{email:'email', type:тип email}] }

6. Команды для работы с группами

6.1. Список групп

getgroup

Возвращает список групп контактов

6.2. Добавить группу

addgroup [JSON]

Добавляет группу. Формат JSON объекта для добавления новой группы:
{ account: 'аккаунт (google email) пользователя для добавления группы',
title: 'название группы' }

7. Типы данных

Типы телефонных номеров

1-домашний, 2-мобильный, 3-рабочий, 4-факс рабочий, 5-факс домашний, 6-пейджер, 7-другой, 8-обратный вызов,
9-автомобильный, 10-компании, 11-ISDN, 12-основной, 13-факс другой, 14-радио, 15-телекс, 16-tty tdd,
17-рабочий мобильный, 18-рабочий пейджер, 19-ассистент, 20-mms

Типы e-mail адресов

1-домашний, 2-рабочий, 3-другой, 4-мобильный

8. Примеры


Контакты

softfreegate@gmail.com

+7 (9021) 690095

VOTAK.ORG

Реквизиты

ООО "Фрегат"
ИНН 0326478071, ОГРН 1080326008333
670031, г. Улан-Удэ, ул. Бабушкина, 13А