Module: IfreeSms::SMSDirectAPIMethods

Included in:
SMSDirectAPI
Defined in:
lib/ifree_sms/smsdirect_api.rb

Constant Summary collapse

SMSDIRECT_SERVER = 
"https://www.smsdirect.ru"

Instance Method Summary collapse

Instance Method Details

#delete_db(uid) ⇒ Object

Удаление базы Параметры запроса: id - ID базы подлежащей удалению;



62
63
64
 
# File 'lib/ifree_sms/smsdirect_api.rb', line 62

def delete_db(uid)
  call("delete_db", {:id => uid})
end

#edit_db(uid, phones) ⇒ Object

Удаление записей из базы абонентов Параметры запроса: id - ID базы; msisdn - список номеров телефонов подлежащих удалению, разделенные запятой (,).



40
41
42
 
# File 'lib/ifree_sms/smsdirect_api.rb', line 40

def edit_db(uid, phones)
  call('edit_db', {:id => uid, :msisdn => phones.join(',')})
end

#get_db ⇒ Object

Получение списка созданных баз



54
55
56
 
# File 'lib/ifree_sms/smsdirect_api.rb', line 54

def get_db
  call("get_db")  
end

#status_db(uid) ⇒ Object

Получение статуса базы Параметры запроса: id - ID базы;



48
49
50
 
# File 'lib/ifree_sms/smsdirect_api.rb', line 48

def status_db(uid)
  call('status_db', {:id => uid})
end

#status_message(message_id) ⇒ Object

Получение статуса сообщения Параметры запроса: mid - ID сообщения полученный с помощью вызова submit_message



17
18
19
 
# File 'lib/ifree_sms/smsdirect_api.rb', line 17

def status_message(message_id)
  call("status_message", {:mid => message_id})
end

#submit_db(uid, qfile, name = '') ⇒ Object

Создание/обновление базы абонентов Параметры запроса: id - ID базы (может быть пустым при создании новой базы); lname - название базы (может быть пустым); qfile - список записей разделенных переводом строк, со следующими полями (поля разделяются знаком ;): msisdn;name;secondname;lastname;city;date;sex поле msisdn - номер телефона абонента; поля name;secondname;lastname;city;sex - текстовые, по указанным именам их можно использовать в п.8 в поле mess, для подстановки значений (при указании поля pattern = 1); поле date - дата в формате ДД-ММ-ГГГГ;



31
32
33
 
# File 'lib/ifree_sms/smsdirect_api.rb', line 31

def submit_db(uid, qfile, name = '')
  call("submit_db", {:id => uid, :qfile => qfile, :lname => name})
end

#submit_dispatch(params = {}) ⇒ Object

Отправка смс-рассылки по созданной базе пользователей Параметры запроса: typelist – тип данных (значения: 1 - база, 2 - список телефонов) list - ID базывыборки; msisdn - список телефонов через запятую “,” mess - текст сообщения, в случае если параметр pattern=1, название полей для последующей подстановки, 

необходимо использовать в виде %ИМЯ ПОЛЯ%. Например, подстановка поля name будет выглядеть следующим образом: 
«Уважаемый %name% поздравляем Вас с днём рождения.»;

isurl - признак wap-push (значения: 0 - отправлять как обычное сообщение, 1 - отправлять сообщения как push); wappushheader - заголовок wap-push (в случае если тип isurl = 1); max_mess - максимальное количество сообщений в день, оставить пустым, если не ограничено; max_mess_per_hour - максимальное количество сообщений в час, оставить пустым, если не ограничено;



78
79
80
 
# File 'lib/ifree_sms/smsdirect_api.rb', line 78

def submit_dispatch(params = {})
  call('submit_dispatch', params)
end

#submit_message(phone, text, from = 'test') ⇒ Object

Send SMS message Sample request:

GET /submit_message?login=demo&pass=demo&from=test&to=380503332211&text=smsdirect_submit_sm



9
10
11
 
# File 'lib/ifree_sms/smsdirect_api.rb', line 9

def submit_message(phone, text, from = 'test')
  call("submit_message", {:from => from, :to => phone, :text => text})
end