Class: Bandwidth::MessagesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bandwidth-sdk/api/messages_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MessagesApi

Returns a new instance of MessagesApi.



19
20
21
 
# File 'lib/bandwidth-sdk/api/messages_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/bandwidth-sdk/api/messages_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_message(account_id, message_request, opts = {}) ⇒ Message

Create Message Endpoint for sending text messages and picture messages using V2 messaging.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • message_request (MessageRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/bandwidth-sdk/api/messages_api.rb', line 28

def create_message(, message_request, opts = {})
  data, _status_code, _headers = create_message_with_http_info(, message_request, opts)
  data
end

#create_message_with_http_info(account_id, message_request, opts = {}) ⇒ Array<(Message, Integer, Hash)>

Create Message Endpoint for sending text messages and picture messages using V2 messaging.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • message_request (MessageRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(Message, Integer, Hash)>) —

    Message data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/bandwidth-sdk/api/messages_api.rb', line 39

def create_message_with_http_info(, message_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagesApi.create_message ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling MessagesApi.create_message"
  end
  # verify the required parameter 'message_request' is set
  if @api_client.config.client_side_validation && message_request.nil?
    fail ArgumentError, "Missing the required parameter 'message_request' when calling MessagesApi.create_message"
  end
  # resource path
  local_var_path = '/users/{accountId}/messages'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(message_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Message'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"MessagesApi.create_message",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagesApi#create_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_messages(account_id, opts = {}) ⇒ MessagesList

List Messages Returns a list of messages based on query parameters.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :message_id (String) —

    The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.

  • :source_tn (String) —

    The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. &#39;%2B1919&#39;).

  • :destination_tn (String) —

    The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. &#39;%2B1919&#39;).

  • :message_status (MessageStatusEnum) —

    The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.

  • :message_direction (ListMessageDirectionEnum) —

    The direction of the message. One of INBOUND OUTBOUND.

  • :carrier_name (String) —

    The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&amp;T should be passed as AT%26T).

  • :message_type (MessageTypeEnum) —

    The type of message. Either sms or mms.

  • :error_code (Integer) —

    The error code of the message.

  • :from_date_time (String) —

    The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.

  • :to_date_time (String) —

    The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.

  • :campaign_id (String) —

    The campaign ID of the message.

  • :sort (String) —

    The field and direction to sort by combined with a colon. Direction is either asc or desc.

  • :page_token (String) —

    A base64 encoded value used for pagination of results.

  • :limit (Integer) —

    The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.

  • :limit_total_count (Boolean) —

    When set to true, the response&#39;s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results.

Returns:



116
117
118
119
 
# File 'lib/bandwidth-sdk/api/messages_api.rb', line 116

def list_messages(, opts = {})
  data, _status_code, _headers = list_messages_with_http_info(, opts)
  data
end

#list_messages_with_http_info(account_id, opts = {}) ⇒ Array<(MessagesList, Integer, Hash)>

List Messages Returns a list of messages based on query parameters.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :message_id (String) —

    The ID of the message to search for. Special characters need to be encoded using URL encoding. Message IDs could come in different formats, e.g., 9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6 and 1589228074636lm4k2je7j7jklbn2 are valid message ID formats. Note that you must include at least one query parameter.

  • :source_tn (String) —

    The phone number that sent the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. &#39;%2B1919&#39;).

  • :destination_tn (String) —

    The phone number that received the message. Accepted values are: a single full phone number a comma separated list of full phone numbers (maximum of 10) or a single partial phone number (minimum of 5 characters e.g. &#39;%2B1919&#39;).

  • :message_status (MessageStatusEnum) —

    The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.

  • :message_direction (ListMessageDirectionEnum) —

    The direction of the message. One of INBOUND OUTBOUND.

  • :carrier_name (String) —

    The name of the carrier used for this message. Possible values include but are not limited to Verizon and TMobile. Special characters need to be encoded using URL encoding (i.e. AT&amp;T should be passed as AT%26T).

  • :message_type (MessageTypeEnum) —

    The type of message. Either sms or mms.

  • :error_code (Integer) —

    The error code of the message.

  • :from_date_time (String) —

    The start of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.

  • :to_date_time (String) —

    The end of the date range to search in ISO 8601 format. Uses the message receive time. The date range to search in is currently 14 days.

  • :campaign_id (String) —

    The campaign ID of the message.

  • :sort (String) —

    The field and direction to sort by combined with a colon. Direction is either asc or desc.

  • :page_token (String) —

    A base64 encoded value used for pagination of results.

  • :limit (Integer) —

    The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.

  • :limit_total_count (Boolean) —

    When set to true, the response&#39;s totalCount field will have a maximum value of 10,000. When set to false, or excluded, this will give an accurate totalCount of all messages that match the provided filters. If you are experiencing latency, try using this parameter to limit your results.

Returns:

  • (Array<(MessagesList, Integer, Hash)>) —

    MessagesList data, response status code and response headers



141
142
143
144
145
146
147
148
149
150
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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/bandwidth-sdk/api/messages_api.rb', line 141

def list_messages_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MessagesApi.list_messages ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling MessagesApi.list_messages"
  end
  # resource path
  local_var_path = '/users/{accountId}/messages'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'messageId'] = opts[:'message_id'] if !opts[:'message_id'].nil?
  query_params[:'sourceTn'] = opts[:'source_tn'] if !opts[:'source_tn'].nil?
  query_params[:'destinationTn'] = opts[:'destination_tn'] if !opts[:'destination_tn'].nil?
  query_params[:'messageStatus'] = opts[:'message_status'] if !opts[:'message_status'].nil?
  query_params[:'messageDirection'] = opts[:'message_direction'] if !opts[:'message_direction'].nil?
  query_params[:'carrierName'] = opts[:'carrier_name'] if !opts[:'carrier_name'].nil?
  query_params[:'messageType'] = opts[:'message_type'] if !opts[:'message_type'].nil?
  query_params[:'errorCode'] = opts[:'error_code'] if !opts[:'error_code'].nil?
  query_params[:'fromDateTime'] = opts[:'from_date_time'] if !opts[:'from_date_time'].nil?
  query_params[:'toDateTime'] = opts[:'to_date_time'] if !opts[:'to_date_time'].nil?
  query_params[:'campaignId'] = opts[:'campaign_id'] if !opts[:'campaign_id'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  query_params[:'pageToken'] = opts[:'page_token'] if !opts[:'page_token'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'limitTotalCount'] = opts[:'limit_total_count'] if !opts[:'limit_total_count'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'MessagesList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"MessagesApi.list_messages",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MessagesApi#list_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end