Версия 1.1.

При работе с сервером AvisoSMS передаются значения описанным ниже переменным методами POST и GET. Метод POST позволяет посылать на сервер данные в запросе клиента. Метод GET - этот метод передачи параметров запроса HTTP от браузера серверу. Этот метод помещает параметры, обычно разделяемые специальными символами, такими как амперсанды («&»), непосредственно в сам URL, который может просматриваться пользователями браузера. Имеется PHP-библиотека и готовый пример для работы с записной книгой и описание ее работы.

Для получения ответа на запрос необходимо передать передать данные методом POST, или GET на URL: http://api.avisosms.ru/telephone_book/

Обмен данными происходит в кодировке UTF-8. Ниже описаны обязательные параметры каждого запроса:

user - Имя пользователя response_type - Формат данных, передаваемые сервером. Поддерживаются: xml, json. По умолчанию: json. request_type - Тип запроса. Его значения:

• add (добавление записи),
• edit (редактирование записи),
• delete (удаление записи),
• list (список всех записей),
• search (поиск по номеру, имени записи и комментарию).

Ответом сервера будет значение кода описанное ниже.

• 0 - Всё хорошо
• 1 - Неверный access_key или user
• 2 - Неверный request_type
• 3 - Запрещена работа без access_key
• 4 - Запись не найдена
• 5 - Ошибка в заполнении формы

Для добавления новой записи необходимо передать серверу следующие параметры: Имя переменной Описание

• name Имя записи в телефонной книги
• number Телефон
• comment Комментарий к записи

При запрете анонимного добавления записи в телефонную книгу то необходимо передать параметр access_key с вашим ключом доступа к API.

Ответ передается следующими переменными:

• code Код ответа (см. таблицу кодов ответа)
• content ID записи в нашей системе

Запрос

http://api.avisosms.ru/telephone_book/?response_type=json&request_type=add&user=xxxx&access_key=1&name=Jon&number=71234567890&comment=Friend

Ответ

{ 
   'code': 0,
   'content': 1
}

Для редактирования существующей записи необходимо передать следующие параметры:

• id ID записи в нашей системе
• name Имя записи в телефонной книги
• number Телефон
• comment Комментарий к записи
• access_key Ключ доступа по API

Ответ передается следующими переменными:

• code Код ответа (см. таблицу кодов ответа)

Запрос

http://api.avisosms.ru/telephone_book/?response_type=json&request_type=edit&user=xxxx&access_key=1&id=1&name=Jon&number=71234567890&comment=Friend

Ответ

{ 
   'code': 0
}

Для удаления записи необходимо передать следующие параметры:

• id ID записи в нашей системе
• access_key Ключ доступа по API

Ответ передается следующими переменными:

• code Код ответа (см. таблицу кодов ответа)

Запрос

http://api.avisosms.ru/telephone_book/?response_type=json&request_type=delete&user=xxxx&access_key=1&id=1

Ответ

{ 
   'code': 0
}

Для просмотра всех записей телефонной книги необходимо передать следущие параметры:

• access_key Ключ доступа по API

В ответе передаются следующие переменные:

• code Код ответа (см. таблицу кодов ответа)
• content Список словарей с элементами, доступными по ключам:

• id(ID записи в нашей системе),
• date (дата добавления в систему),
• name(Имя пользователя),
• number(Телефон),
• comment (комментарий),
• count(Количество SMS)

Запрос

http://api.avisosms.ru/telephone_book/?response_type=json&request_type=list&user=xxxx&access_key=1

Ответ

{ 
   'code': 0,
   'content': [
                   'id': 1,
                   'date': '2010-08-27 00:03:00',
                   'name': 'John',
                   'number': '791234567890',
                   'comment': 'Friend',
                   'count': 1,
   ]
}

Для поиска записей необходимо передать параметры:

• search Строка для поиска
• access_key Ключ доступа по API

В ответе передаются следующие переменные:

• code Код ответа (см. таблицу кодов ответа)
• content Список словарей с элементами, доступными по ключам:

• id(ID записи в нашей системе),
• date (дата добавления в систему),
• name(Имя пользователя),
• number(Телефон),
• comment (комментарий),
• count(Количество SMS)

Запрос

http://api.avisosms.ru/telephone_book/?response_type=json&request_type=search&user=xxxx&access_key=1&search=0

Ответ

{ 
   'code': 0,
   'content': [
                   'id': 1,
                   'date': '2010-08-27 00:03:00',
                   'name': 'John',
                   'number': '791234567890',
                   'comment': 'Friend',
                   'count': 1,
   ]
}