В этом разделе описаны API, которые могут применяться в приложении TIUN. С помощью этих API пользовательская программа (Клиент) может выполнять команды и получать различную информацию из приложения TIUN (Сервер). При использовании API соединение между Клиентом и Сервером устанавливается с помощью стандартного сокета TCP/IP. Соединение с сокетом может быть реализовано на любом языке программирования, поддерживающем сокеты (например, на Java, C/C++, C#, Visual Basic, Delphi, NodeJS, PHP и другие). Вы можете ознакомится с нашими примерами перейдя в раздел примеры.
Используемые понятия:
Внимание! Если Вы используете версию Tiun Pro, перед каждой командой необходимо добавить символ p. Пример: pgetsms, pgetversion
Для подключения к Серверу убедитесь, что Ваше устройство использует Wi-Fi. При необходимости настройте его для работы в сети. Затем выполните предварительные настройки в приложении:
Для того чтобы начать общаться с сервером, отправлять команды и получать ответы, необходимо сразу после инициализации подключения отправить пароль на сервер. Если отправленный пароль совпал с паролем установленным на сервере, то клиент считается авторизованным. При этом сервер не отправит клиенту результата об успешной или неудачной авторизации.
cmdlist
Возвращает список поддерживаемых команд в виде массива JSON объектов.
getversion
Возвращает версию мобильного приложения.
getsmscount [TYPE]
Возвращает количество смс указанного типа TYPE, если TYPE не указан, количество всех смс
getsms [N] [TYPE]
Возвращает информацию о сообщении под номером N указанного типа TYPE
getsmslast [CNT] [TYPE]
Возвращает информацию о последних CNT сообщениях указанного типа TYPE
getsmsafter [DATE] [TYPE]
Возвращает информацию о сообщениях после DATE типа TYPE
sendsms [JSON]
Формат JSON объекта для отправки сообщения:
{ address: 'номер получателя',
body: 'текст сообщения' }
getcallcount [TYPE]
Возвращает количество вызовов указанного типа TYPE, если TYPE не указан, количество всех вызовов
getcall [N] [TYPE]
Возвращает информацию о вызове под номером N указанного типа TYPE
getcalllast [CNT] [TYPE]
Возвращает информацию о последних CNT вызовах указанного типа TYPE
getcallafter [DATE] [TYPE]
Возвращает информацию о сообщениях после DATE типа TYPE
makecall [NUM]
Инициирует исходящий вызов на номер NUM
Параметр NUM обязателен.
getcontact [NAME]
Возвращает информацию о контактах с именем содержащим NAME, без NAME возвращает все контакты
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}] }
getgroup
Возвращает список групп контактов
addgroup [JSON]
Добавляет группу. Формат JSON объекта для добавления новой группы:
{ account: 'аккаунт (google email) пользователя для добавления группы',
title: 'название группы' }
1-домашний, 2-мобильный, 3-рабочий, 4-факс рабочий, 5-факс домашний, 6-пейджер, 7-другой, 8-обратный вызов,
9-автомобильный, 10-компании, 11-ISDN, 12-основной, 13-факс другой, 14-радио, 15-телекс, 16-tty tdd,
17-рабочий мобильный, 18-рабочий пейджер, 19-ассистент, 20-mms
1-домашний, 2-рабочий, 3-другой, 4-мобильный
ООО "Фрегат"
ИНН 0326478071, ОГРН 1080326008333
670031, г. Улан-Удэ, ул. Бабушкина, 13А