Работа с телефонной книгой в системе AvisoSMS
Общие положения
РџСЂРё работе СЃ сервером 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 - Ошибка в заполнении формы
Добавление записи
Для добавления новой записи необходимо передать серверу следующие параметры:
РРјСЏ переменной Описание
При запрете анонимного добавления записи в телефонную книгу то необходимо передать параметр access_key с вашим ключом доступа к API.
Ответ передается следующими переменными:
Пример запроса и ответа
Редактирование записи
Для редактирования существующей записи необходимо передать следующие параметры:
id ID записи в нашей системе
name РРјСЏ записи РІ телефонной РєРЅРёРіРё
number Телефон
comment Комментарий к записи
access_key Ключ доступа по
API
Ответ передается следующими переменными:
Пример запроса и ответа
Удаление записи
Для удаления записи необходимо передать следующие параметры:
Ответ передается следующими переменными:
Пример запроса и ответа
Запрос
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,
]
}
РџРѕРёСЃРє РІ записях телефонной РєРЅРёРіРё РїРѕ полям "Телефон", "РРјСЏ" Рё "Комментарий"
Для поиска записей необходимо передать параметры:
В ответе передаются следующие переменные:
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,
]
}