Class: MessageMediaMessages::RepliesController

Inherits:
BaseController show all
Defined in:
lib/message_media_messages/controllers/replies_controller.rb

Overview

RepliesController

Class Attribute Summary collapse

Attributes inherited from BaseController

#http_call_back, #http_client

Instance Method Summary collapse

Methods inherited from BaseController

#execute_request, #initialize, #validate_parameters, #validate_response

Constructor Details

This class inherits a constructor from MessageMediaMessages::BaseController

Class Attribute Details

.instance ⇒ Object

Returns the value of attribute instance.



12
13
14
 
# File 'lib/message_media_messages/controllers/replies_controller.rb', line 12

def instance
  @instance
end

Instance Method Details

#check_replies ⇒ Object

Check for any replies that have been received. Replies are messages that have been sent from a handset in response to a message sent by an application or messages that have been sent from a handset to a inbound number associated with an account, known as a dedicated inbound number (contact <[email protected]> for more information on dedicated inbound numbers). Each request to the check replies endpoint will return any replies received that have not yet been confirmed using the confirm replies endpoint. A response from the check replies endpoint will have the following structure: “‘json {

"replies": [
    {
        "metadata": {
            "key1": "value1",
            "key2": "value2"
        },
        "message_id": "877c19ef-fa2e-4cec-827a-e1df9b5509f7",
        "reply_id": "a175e797-2b54-468b-9850-41a3eab32f74",
        "date_received": "2016-12-07T08:43:00.850Z",
        "callback_url": "https://my.callback.url.com",
        "destination_number": "+61491570156",
        "source_number": "+61491570157",
        "vendor_account_id": {
            "vendor_id": "MessageMedia",
            "account_id": "MyAccount"
        },
        "content": "My first reply!"
    },
    {
        "metadata": {
            "key1": "value1",
            "key2": "value2"
        },
        "message_id": "8f2f5927-2e16-4f1c-bd43-47dbe2a77ae4",
        "reply_id": "3d8d53d8-01d3-45dd-8cfa-4dfc81600f7f",
        "date_received": "2016-12-07T08:43:00.850Z",
        "callback_url": "https://my.callback.url.com",
        "destination_number": "+61491570157",
        "source_number": "+61491570158",
        "vendor_account_id": {
            "vendor_id": "MessageMedia",
            "account_id": "MyAccount"
        },
        "content": "My second reply!"
    }
]

} “‘ Each reply will contain details about the reply message, as well as details of the message the reply was sent in response to, including any metadata specified. Every reply will have a reply ID to be used with the confirm replies endpoint. *Note: The source number and destination number properties in a reply are the inverse of those specified in the message the reply is in response to. The source number of the reply message is the same as the destination number of the original message, and the destination number of the reply message is the same as the source number of the original message. If a source number wasn’t specified in the original message, then the destination number property will not be present in the reply message.* Subsequent requests to the check replies endpoint will return the same reply messages and a maximum of 100 replies will be returned in each request. Applications should use the confirm replies endpoint in the following pattern so that replies that have been processed are no longer returned in subsequent check replies requests.

  1. Call check replies endpoint

  2. Process each reply message

  3. Confirm all processed reply messages using the confirm replies endpoint

*Note: It is recommended to use the Webhooks feature to receive reply messages rather than polling the check replies endpoint.*

Returns:

  • CheckRepliesResponse response from the API call



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/message_media_messages/controllers/replies_controller.rb', line 102

def check_replies
  # Prepare query url.
  _path_url = '/v1/replies'
  _query_builder = Configuration.base_uri.dup
  _query_builder << _path_url
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = @http_client.get(
    _query_url,
    headers: _headers
  )
  AuthManager.apply(_request, _path_url)
  _context = execute_request(_request)
  validate_response(_context)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_context.response.raw_body)
  CheckRepliesResponse.from_hash(decoded)
end

#confirm_replies_as_received(body) ⇒ Object

Mark a reply message as confirmed so it is no longer returned in check replies requests. The confirm replies endpoint is intended to be used in conjunction with the check replies endpoint to allow for robust processing of reply messages. Once one or more reply messages have been processed they can then be confirmed using the confirm replies endpoint so they are no longer returned in subsequent check replies requests. The confirm replies endpoint takes a list of reply IDs as follows: “‘json 

"reply_ids": [
    "011dcead-6988-4ad6-a1c7-6b6c68ea628d",
    "3487b3fa-6586-4979-a233-2d1b095c7718",
    "ba28e94b-c83d-4759-98e7-ff9c7edb87a1"
]

“‘ Up to 100 replies can be confirmed in a single confirm replies request. Example:

Parameters:

Returns:

  • Mixed response from the API call



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/message_media_messages/controllers/replies_controller.rb', line 151

def confirm_replies_as_received(body)
  # Prepare query url.
  _path_url = '/v1/replies/confirmed'
  _query_builder = Configuration.base_uri.dup
  _query_builder << _path_url
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json',
    'content-type' => 'application/json; charset=utf-8'
  }

  # Prepare and execute HttpRequest.
  _request = @http_client.post(
    _query_url,
    headers: _headers,
    parameters: body.to_json
  )
  AuthManager.apply(_request, _path_url, body.to_json)
  _context = execute_request(_request)
  validate_response(_context)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_context.response.raw_body) unless
    _context.response.raw_body.nil? ||
    _context.response.raw_body.to_s.strip.empty?
  decoded
end

#instance ⇒ Object 



15
16
17
 
# File 'lib/message_media_messages/controllers/replies_controller.rb', line 15

def instance
  self.class.instance
end