Class: MessageMediaWebhooks::WebhooksController

Inherits:
BaseController show all
Defined in:
lib/message_media_webhooks/controllers/webhooks_controller.rb

Overview

WebhooksController

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 MessageMediaWebhooks::BaseController

Class Attribute Details

.instance ⇒ Object

Returns the value of attribute instance.



8
9
10
 
# File 'lib/message_media_webhooks/controllers/webhooks_controller.rb', line 8

def instance
  @instance
end

Instance Method Details

#create_webhook(body) ⇒ Object

Create a webhook for one or more of the specified events. A webhook would typically have the following structure: “‘ {

"url": "http://webhook.com",
"method": "POST",
"encoding": "JSON",
"headers": {
  "Account": "DeveloperPortal7000"
},
"events": [
  "RECEIVED_SMS"
],
"template": "{\"id\":\"$mtId\",\"status\":\"$statusCode\"}"

} “‘ A valid webhook must consist of the following properties:

  • “‘url“` The configured URL which will trigger the webhook when a

selected event occurs.

  • “‘method“` The methods to map CRUD (create, retrieve, update, delete)

operations to HTTP requests.

  • “‘encoding“` The format in which the payload will be returned. You can

choose from “‘JSON“`, “`FORM_ENCODED“` or “`XML“`. This will automatically add the Content-Type header for you so you don’t have to add it again in the ‘headers` property.

  • “‘headers“` HTTP header fields which provide required information

about the request or response, or about the object sent in the message body. This should not include the ‘Content-Type` header.

  • “‘events“` Event or events that will trigger the webhook. Atleast one

event should be present.

  • “‘template“` The structure of the payload that will be returned.

#### Types of Events You can select all of the events (listed below) or combine them in whatever way you like but atleast one event must be used. Otherwise, the webhook won’t be created. A webhook will be triggered when any one or more of the events occur: + SMS

+ `RECEIVED_SMS` Receive an SMS
+ `OPT_OUT_SMS` Opt-out occured

+ MMS

+ `RECEIVED_MMS` Receive an MMS

+ **DR (Delivery Reports)**

+ `ENROUTE_DR` Message is enroute
+ `EXPIRED_DR` Message has expired
+ `REJECTED_DR` Message is rejected
+ `FAILED_DR` Message has failed
+ `DELIVERED_DR` Message is delivered
+ `SUBMITTED_DR` Message is submitted

#### Template Parameters You can choose what to include in the data that will be sent as the payload via the Webhook. Keep in my mind, you must escape the JSON in the template value (see example above). The table illustrates a list of all the parameters that can be included in the template and which event types it can be applied to. | Data | Parameter Name | Example | Event Type | |:–|–|–|–|–| | **Service Type** | $type| ‘SMS` | `DR` `MO` `MO MMS` | | **Message ID** | $mtId, $messageId| `877c19ef-fa2e-4cec-827a-e1df9b5509f7` | `DR` `MO` `MO MMS`| | **Delivery Report ID** |$drId, $reportId| `01e1fa0a-6e27-4945-9cdb-18644b4de043` | `DR` | | **Reply ID**| $moId, $replyId| `a175e797-2b54-468b-9850-41a3eab32f74` | `MO` `MO MMS` | | **Account ID** | $accountId| `DeveloperPortal7000` | `DR` `MO` `MO MMS` | | **Message Timestamp** | $submittedTimestamp| `2016-12-07T08:43:00.850Z` | `DR` `MO` `MO MMS` | | **Provider Timestamp** | $receivedTimestamp| `2016-12-07T08:44:00.850Z` | `DR` `MO` `MO MMS` | | **Message Status** | $status| `enroute` | `DR` | | **Status Code** | $statusCode| `200` | `DR` | | **External Metadata** | $metadata.get(’key’)| ‘name` | `DR` `MO` `MO MMS` | | **Source Address**| $sourceAddress| `+61491570156` | `DR` `MO` `MO MMS` | | **Destination Address**| $destinationAddress| `+61491593156` | `MO` `MO MMS` | | **Message Content**| $mtContent, $messageContent| `Hi Derp` | `DR` `MO` `MO MMS` | | **Reply Content**| $moContent, $replyContent| `Hello Derpina` | `MO` `MO MMS` | | **Retry Count**| $retryCount| `1` | `DR` `MO` `MO MMS` | *Note: A 400 response will be returned if the `url` is invalid, the `events`, `encoding` or `method` is null or the `headers` has a Content-Type attribute.*

Parameters:

Returns:

  • Mixed response from the API call



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/message_media_webhooks/controllers/webhooks_controller.rb', line 103

def create_webhook(body)
  begin
    @logger.info("create_webhook called.")
    # Prepare query url.
    @logger.info("Preparing query URL for create_webhook.")
    _query_builder = Configuration.base_uri.dup
    _query_builder << '/v1/webhooks/messages'
    _query_url = APIHelper.clean_url _query_builder

    # Prepare headers.
    @logger.info("Preparing headers for create_webhook.")
    _headers = {
      'accept' => 'application/json',
      'content-type' => 'application/json; charset=utf-8'
    }

    # Prepare and execute HttpRequest.
    @logger.info('Preparing and executing HttpRequest for create_webhook.')
    _request = @http_client.post(
      _query_url,
      headers: _headers,
      parameters: body.to_json
    )
    BasicAuth.apply(_request)
    _context = execute_request(_request, name: 'create_webhook')

    # Validate response against endpoint and global error codes.
    @logger.info("Validating response for create_webhook.")
    if _context.response.status_code == 400
      raise CreateWebhook400ResponseException.new(
        'Unexpected error in API call. See HTTP response body for details.',
        _context
      )
    elsif _context.response.status_code == 409
      raise CreateWebhook400ResponseException.new(
        'Unexpected error in API call. See HTTP response body for details.',
        _context
      )
    end
    validate_response(_context)

    # Return appropriate response type.
    @logger.info("Returning response for create_webhook.")
    decoded = APIHelper.json_deserialize(_context.response.raw_body) unless
      _context.response.raw_body.nil? ||
      _context.response.raw_body.to_s.strip.empty?
    decoded

  rescue Exception => e
    @logger.error(e)
    raise e
  end
end

#delete_webhook(webhook_id) ⇒ Object

Delete a webhook that was previously created for the connected account. A webhook can be cancelled by appending the UUID of the webhook to the endpoint and submitting a DELETE request to the /webhooks/messages endpoint. *Note: Only pre-created webhooks can be deleted. If an invalid or non existent webhook ID parameter is specified in the request, then a HTTP 404 Not Found response will be returned.*

Parameters:

  • webhook_id (UUID | String) —

    Required parameter: Example:

Returns:

  • void response from the API call



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/message_media_webhooks/controllers/webhooks_controller.rb', line 249

def delete_webhook(webhook_id)
  begin
    @logger.info("delete_webhook called.")
    # Prepare query url.
    @logger.info("Preparing query URL for delete_webhook.")
    _query_builder = Configuration.base_uri.dup
    _query_builder << '/v1/webhooks/messages/{webhookId}'
    _query_builder = APIHelper.append_url_with_template_parameters(
      _query_builder,
      'webhookId' => webhook_id
    )
    _query_url = APIHelper.clean_url _query_builder

    # Prepare and execute HttpRequest.
    @logger.info('Preparing and executing HttpRequest for delete_webhook.')
    _request = @http_client.delete(
      _query_url
    )
    BasicAuth.apply(_request)
    _context = execute_request(_request, name: 'delete_webhook')

    # Validate response against endpoint and global error codes.
    @logger.info("Validating response for delete_webhook.")
    if _context.response.status_code == 404
      raise APIException.new(
        '',
        _context
      )
    end
    validate_response(_context)

  rescue Exception => e
    @logger.error(e)
    raise e
  end
end

#instance ⇒ Object 



11
12
13
 
# File 'lib/message_media_webhooks/controllers/webhooks_controller.rb', line 11

def instance
  self.class.instance
end

#retrieve_webhook(page = nil, page_size = nil) ⇒ Object

Retrieve all the webhooks created for the connected account. A successful request to the retrieve webhook endpoint will return a response body as follows: “‘ 

"page": 0,
"pageSize": 100,
"pageData": [
    {
        "url": "https://webhook.com",
        "method": "POST",
        "id": "8805c9d8-bef7-41c7-906a-69ede93aa024",
        "encoding": "JSON",
        "events": [
            "RECEIVED_SMS"
        ],
        "headers": {,
        "template": "\"status\":\"$statusCode\""
    }
]

} “‘ *Note: Response 400 is returned when the `page` query parameter is not valid or the `pageSize` query parameter is not valid.*

Parameters:

  • page (Integer) (defaults to: nil) —

    Optional parameter: Example:

  • page_size (Integer) (defaults to: nil) —

    Optional parameter: Example:

Returns:

  • Mixed response from the API call



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/message_media_webhooks/controllers/webhooks_controller.rb', line 184

def retrieve_webhook(page = nil,
                     page_size = nil)
  begin
    @logger.info("retrieve_webhook called.")
    # Prepare query url.
    @logger.info("Preparing query URL for retrieve_webhook.")
    _query_builder = Configuration.base_uri.dup
    _query_builder << '/v1/webhooks/messages/'
    _query_builder = APIHelper.append_url_with_query_parameters(
      _query_builder,
      {
        'page' => page,
        'pageSize' => page_size
      },
      array_serialization: Configuration.array_serialization
    )
    _query_url = APIHelper.clean_url _query_builder

    # Prepare headers.
    @logger.info("Preparing headers for retrieve_webhook.")
    _headers = {
      'accept' => 'application/json'
    }

    # Prepare and execute HttpRequest.
    @logger.info('Preparing and executing HttpRequest for retrieve_webhook.')
    _request = @http_client.get(
      _query_url,
      headers: _headers
    )
    BasicAuth.apply(_request)
    _context = execute_request(_request, name: 'retrieve_webhook')

    # Validate response against endpoint and global error codes.
    @logger.info("Validating response for retrieve_webhook.")
    if _context.response.status_code == 400
      raise RetrieveWebhook400ResponseException.new(
        'Unexpected error in API call. See HTTP response body for details.',
        _context
      )
    end
    validate_response(_context)

    # Return appropriate response type.
    @logger.info("Returning response for retrieve_webhook.")
    decoded = APIHelper.json_deserialize(_context.response.raw_body) unless
      _context.response.raw_body.nil? ||
      _context.response.raw_body.to_s.strip.empty?
    decoded

  rescue Exception => e
    @logger.error(e)
    raise e
  end
end

#update_webhook(webhook_id, body) ⇒ Object

Update a webhook. You can update individual attributes or all of them by submitting a PATCH request to the /webhooks/messages endpoint (the same endpoint used above to delete a webhook) A successful request to the retrieve webhook endpoint will return a response body as follows: “‘ 

"url": "https://webhook.com",
"method": "POST",
"id": "04442623-0961-464e-9cbc-ec50804e0413",
"encoding": "JSON",
"events": [
    "RECEIVED_SMS"
],
"headers": {,
"template": "\"status\":\"$statusCode\""

} “‘ *Note: Only pre-created webhooks can be deleted. If an invalid or non existent webhook ID parameter is specified in the request, then a HTTP 404 Not Found response will be returned.*

Parameters:

Returns:

  • Mixed response from the API call



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/message_media_webhooks/controllers/webhooks_controller.rb', line 310

def update_webhook(webhook_id,
                   body)
  begin
    @logger.info("update_webhook called.")
    # Prepare query url.
    @logger.info("Preparing query URL for update_webhook.")
    _query_builder = Configuration.base_uri.dup
    _query_builder << '/v1/webhooks/messages/{webhookId}'
    _query_builder = APIHelper.append_url_with_template_parameters(
      _query_builder,
      'webhookId' => webhook_id
    )
    _query_url = APIHelper.clean_url _query_builder

    # Prepare headers.
    @logger.info("Preparing headers for update_webhook.")
    _headers = {
      'accept' => 'application/json',
      'content-type' => 'application/json; charset=utf-8'
    }

    # Prepare and execute HttpRequest.
    @logger.info('Preparing and executing HttpRequest for update_webhook.')
    _request = @http_client.patch(
      _query_url,
      headers: _headers,
      parameters: body.to_json
    )
    BasicAuth.apply(_request)
    _context = execute_request(_request, name: 'update_webhook')

    # Validate response against endpoint and global error codes.
    @logger.info("Validating response for update_webhook.")
    if _context.response.status_code == 400
      raise UpdateWebhook400ResponseException.new(
        'Unexpected error in API call. See HTTP response body for details.',
        _context
      )
    elsif _context.response.status_code == 404
      raise APIException.new(
        '',
        _context
      )
    end
    validate_response(_context)

    # Return appropriate response type.
    @logger.info("Returning response for update_webhook.")
    decoded = APIHelper.json_deserialize(_context.response.raw_body) unless
      _context.response.raw_body.nil? ||
      _context.response.raw_body.to_s.strip.empty?
    decoded

  rescue Exception => e
    @logger.error(e)
    raise e
  end
end