class Textmagic::REST::Messages

Public Instance Methods

create(params={}) click to toggle source

Send a new outbound Message or create Scheduled message when provide sending_time parameters Returns Message object contains next attributes: 'id', 'href', 'type', 'sessionId', 'bulkId', 'message_id', 'scheduled_id'.

The following params keys are supported:

text

Message text. Required if template_id is not set.

template_id

Template used instead of message text. Required if text is not set.

sending_time

Message sending time in unix timestamp format. Default is now. Optional (required with recurrency_rule set).

contacts

Contacts ids, separated by comma, message will be sent to.

lists

Lists ids, separated by comma, message will be sent to.

phones

Phone numbers, separated by comma, message will be sent to.

cut_extra

Should sending method cut extra characters which not fit supplied parts_count or return 400 Bad request response instead. Default is false.

parts_count

Maximum message parts count (TextMagic allows sending 1 to 6 message parts). Default is 6.

reference_id

Custom message reference id which can be used in your application infrastructure.

from

One of allowed Sender ID (phone number or alphanumeric sender ID).

rrule

iCal RRULE parameter to create recurrent scheduled messages. When used, sending_time is mandatory as start point of sending.

dummy

If 1, just return message pricing. Message will not send.

Example:

@message = client.messages.create {:text => 'Hello from Ruby', :phones => '99900000, 99999999'}
Calls superclass method Textmagic::REST::ListResource#create
   # File lib/textmagic-ruby/rest/messages.rb
54 def create(params={})
55   super params
56 end
delete(uid) click to toggle source

Delete message by ID. Returns true if success.

uid

Message ID. Required.

Example:

r = client.messages.delete 1110
Calls superclass method Textmagic::REST::ListResource#delete
    # File lib/textmagic-ruby/rest/messages.rb
131 def delete(uid)
132   super uid
133 end
get(uid) click to toggle source

Get message by ID. Returns Message object.

uid

Message ID. Required.

Example:

@message = client.messages.get 987
Calls superclass method Textmagic::REST::ListResource#get
   # File lib/textmagic-ruby/rest/messages.rb
14 def get(uid)
15   super uid
16 end
list(params={}) click to toggle source

Get all user messages. Returns PaginateResource object, contains array of Message objects.

The following params keys are supported:

search

If true then search messages using `query`, `ids` and/or `session_id`. Defaults false.

page

Fetch specified results page. Defaults 1

limit

How many results on page. Defaults 10

ids

Find message by ID(s). Using with `search`=true.

session_id

Find message by Session ID. Using with `search`=true.

query

Find message by specified search query. Using with `search`=true..

Example:

@messages = client.messages.list
Calls superclass method Textmagic::REST::ListResource#list
   # File lib/textmagic-ruby/rest/messages.rb
80 def list(params={})
81   super params
82 end
price(params={}) click to toggle source

Check pricing for a new outbound message. An useful synonym for “message” command with “dummy” parameters set to true.

The following params keys are supported:

text

Message text. Required if template_id is not set.

template_id

Template used instead of message text. Required if text is not set.

sending_time

Message sending time in unix timestamp format. Default is now. Optional (required with recurrency_rule set).

contacts

Contacts ids, separated by comma, message will be sent to.

lists

Lists ids, separated by comma, message will be sent to.

phones

Phone numbers, separated by comma, message will be sent to.

cut_extra

Should sending method cut extra characters which not fit supplied parts_count or return 400 Bad request response instead. Default is false.

parts_count

Maximum message parts count (TextMagic allows sending 1 to 6 message parts). Default is 6.

reference_id

Custom message reference id which can be used in your application infrastructure.

from

One of allowed Sender ID (phone number or alphanumeric sender ID).

rrule

iCal RRULE parameter to create recurrent scheduled messages. When used, sending_time is mandatory as start point of sending.

Example:

@message = client.messages.create {:text => 'Hello from Ruby', :phones => '99900000, 99999999'}
    # File lib/textmagic-ruby/rest/messages.rb
117 def price(params={})
118   response = @client.get "#{@path}/price", params
119   @instance_class.new "#{@path}", @client, response
120 end
update(uid, params={}) click to toggle source

Updating is not supported.

    # File lib/textmagic-ruby/rest/messages.rb
137 def update(uid, params={})
138   raise '`update` method is not supported for this resource.'
139 end