Удаленный доступ к телефонной книге

Содержание

1. Общие сведения
2. Работа с записной книгой
2.1. Коды ошибок
3. Добавление записи
4. Редактирование записи
5. Удаление записи
6. Просмотр всех записей
7. Поиск по телефонной книге

1.    Общие сведения

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

2.    Работа с записной книгой

Для получения ответа на запрос необходимо передать передать данные, закодированные в JSON методом POST или GET на URL:

http://api.avisosms.ru/telephone_book/

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

Код запроса	Описание
response_type	Формат данных, передаваемые сервером. Поддерживаются: xml, json. По умолчанию: json.
request_type	Тип запроса. Его значения: add (добавление записи), edit (редактирование записи), delete (удаление записи), list (список всех записей), search (поиск по номеру, имени записи и комментарию).
user	Имя пользователя

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

Код ответа и описание ошибки

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

3.    Добавление записи

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

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

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

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

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

Пример запроса и ответа
Запрос: {   'response_type': 'json',   'request_type': 'add',   'user': 'xxxx',   'access_key': '1',   'name': 'Jon',   'number': '71234567890',   'comment': 'Friend' }
Ответ: {     'code': 0,    'content': 1 }

4.    Редактирование записи

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

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

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

Имя переменной	Описание
code	Код ответа (см. таблицу кодов ответа)

Пример запроса и ответа
Запрос: {   'response_type': 'json',   'request_type': 'edit',   'access_key': '1',   'user': 'xxxx',    'id': 1,   'name': 'John',   'number': '71234567890',   'comment': 'Friend' }
Ответ: {     'code': 0 }

5.    Удаление записи

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

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

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

6.    Просмотр всех записей телефонной книги

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

Имя переменной	Описание
access_key	Ключ доступа по API

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

7.    Поиск в записях телефонной книги по полям "Телефон", "Имя" и "Комментарий"

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

Имя переменной	Описание
search	Строка для поиска
access_key	Ключ доступа по API

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