Module: SmsMasking::PhoneBook

Included in:
Base
Defined in:
lib/sms_masking/phone_book.rb

Instance Method Summary collapse

Instance Method Details

#add_phone_book(params = {}) ⇒ Object

Attributes

  • name : Contact Name

  • mobile : Recipient

  • group : Contact Group Name

  • address (optional) : Contact Address

  • birth (optional) : Contact Birthday (YYYYMMDD)

  • desc (optional) : Contact Description

Example

sms.add_phone_book({
  name: "John Doe", 
  mobile: "085699999999", 
  group: "My Group", 
  address: "My Address",
  birth: "19900101",
  desc: "My Description"
})


24
25
26
27
28
29
# File 'lib/sms_masking/phone_book.rb', line 24

def add_phone_book(params = {})
  params[:username] = @username
  params[:auth] = auth(params[:mobile]+@password.to_s)
  res = self.class.get(@base_path+"/phbkAdd.aspx", query: params)
  print_response res
end

#contact_detail(params = {}) ⇒ Object

Attributes

  • id : Contact ID Number

Example

sms.contact_detail({id: 1})


123
124
125
126
127
128
# File 'lib/sms_masking/phone_book.rb', line 123

def contact_detail(params = {})
  params[:username] = @username
  params[:auth] = auth(@username.to_s+@password.to_s)
  res = self.class.get(@base_path+"/phbk_getCompleteData.aspx", query: params)
  print_response res
end

#delete_phone_book(params = {}) ⇒ Object

Attributes

  • id : Contact ID Number

Example

sms.delete_phone_book({id: 1})


68
69
70
71
72
73
# File 'lib/sms_masking/phone_book.rb', line 68

def delete_phone_book(params = {})
  params[:username] = @username
  params[:auth] = auth(params[:id].to_s+@password.to_s)
  res = self.class.get(@base_path+"/phbkDelete.aspx", query: params)
  print_response res
end

#edit_phone_book(params = {}) ⇒ Object

Attributes

  • id : Contact ID Number

  • name : Contact Name

  • mobile : Recipient

  • group : Contact Group Name

  • address (optional) : Contact Address

  • birth (optional) : Contact Birthday (YYYYMMDD)

  • desc (optional) : Contact Description

Example

sms.edit_phone_book({
  id: 1,
  name: "John Doe", 
  mobile: "085699999999", 
  group: "My Group", 
  address: "My Address",
  birth: "19900101",
  desc: "My Description"
})


53
54
55
56
57
58
# File 'lib/sms_masking/phone_book.rb', line 53

def edit_phone_book(params = {})
  params[:username] = @username
  params[:auth] = auth(params[:id].to_s+@password.to_s)
  res = self.class.get(@base_path+"/phbkEdit.aspx", query: params)
  print_response res
end

#find_contact(params = {}) ⇒ Object

Attributes

  • name : Name to search

Example

sms.find_contact({name: "John Doe"})


138
139
140
141
142
143
# File 'lib/sms_masking/phone_book.rb', line 138

def find_contact(params = {})
  params[:username] = @username
  params[:auth] = auth(@username.to_s+@password.to_s)
  res = self.class.get(@base_path+"/phbk_findName.aspx", query: params)
  print_response res
end

#find_number(params = {}) ⇒ Object

Attributes

  • number : Number to search

Example

sms.find_number({number: "085699999999"})


153
154
155
156
157
158
# File 'lib/sms_masking/phone_book.rb', line 153

def find_number(params = {})
  params[:username] = @username
  params[:auth] = auth(@username.to_s+@password.to_s)
  res = self.class.get(@base_path+"/phbk_findPhNumber.aspx", query: params)
  print_response res
end

#list_phone_book(params = {}) ⇒ Object

Attributes

  • page : Page Number (default=1)

  • size : number of records per page (default=10)

Example

sms.list_phone_book({
  page: 1, 
  size: 10
})


87
88
89
90
91
92
# File 'lib/sms_masking/phone_book.rb', line 87

def list_phone_book(params = {})
  params[:username] = @username
  params[:auth] = auth(@username.to_s+@password.to_s)
  res = self.class.get(@base_path+"/phbk_getList.aspx", query: params)
  print_response res
end

#list_phone_book_by_group(params = {}) ⇒ Object

Attributes

  • page : Page Number (default=1)

  • size : number of records per page (default=10)

  • group : Group Name

Example

sms.list_phone_book_by_group({
  page: 1, 
  size: 10,
  group: "My Group"
})


108
109
110
111
112
113
# File 'lib/sms_masking/phone_book.rb', line 108

def list_phone_book_by_group(params = {})
  params[:username] = @username
  params[:auth] = auth(@username.to_s+@password.to_s)
  res = self.class.get(@base_path+"/phbk_getListbyGroup.aspx", query: params)
  print_response res
end