You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/MediaApi.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -253,7 +253,7 @@ media_id = '14762070468292kw2fuqty55yp2b2/0/bw.png' # String | Media ID to retri
253
253
body =File.new('/path/to/some/file') # File |
254
254
opts = {
255
255
content_type:'audio/wav', # String | The media type of the entity-body.
256
-
cache_control:'no-cache'# String | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
256
+
cache_control:'no-cache'# String | General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain.
257
257
}
258
258
259
259
begin
@@ -290,7 +290,7 @@ end
290
290
|**media_id**|**String**| Media ID to retrieve. ||
291
291
|**body**|**File**|||
292
292
|**content_type**|**String**| The media type of the entity-body. |[optional]|
293
-
|**cache_control**|**String**| General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. |[optional]|
293
+
|**cache_control**|**String**| General-header field is used to specify directives that MUST be obeyed by all caching mechanisms along the request/response chain. |[optional]|
Copy file name to clipboardExpand all lines: docs/Message.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,11 @@
8
8
|**owner**|**String**| The Bandwidth phone number associated with the message. |[optional]|
9
9
|**application_id**|**String**| The application ID associated with the message. |[optional]|
10
10
|**time**|**Time**| The datetime stamp of the message in ISO 8601 |[optional]|
11
-
|**segment_count**|**Integer**| The number of segments the original message from the user is broken into before sending over to carrier networks. |[optional]|
11
+
|**segment_count**|**Integer**| The number of segments the original message from the user is broken into before sending over to carrier networks. |[optional]|
|**to**|**Array<String>**| The phone number recipients of the message. |[optional]|
14
14
|**from**|**String**| The phone number the message was sent from. |[optional]|
15
-
|**media**|**Array<String>**| The list of media URLs sent in the message. Including a `filename` field in the `Content-Disposition` header of the media linked with a URL will set the displayed file name. This is a best practice to ensure that your media has a readable file name. |[optional]|
15
+
|**media**|**Array<String>**| The list of media URLs sent in the message. Including a `filename` field in the `Content-Disposition` header of the media linked with a URL will set the displayed file name. This is a best practice to ensure that your media has a readable file name. |[optional]|
16
16
|**text**|**String**| The contents of the message. |[optional]|
17
17
|**tag**|**String**| The custom string set by the user. |[optional]|
Copy file name to clipboardExpand all lines: docs/MessageRequest.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,12 +6,12 @@
6
6
| ---- | ---- | ----------- | ----- |
7
7
|**application_id**|**String**| The ID of the Application your from number is associated with in the Bandwidth Phone Number Dashboard. ||
8
8
|**to**|**Array<String>**| The phone number(s) the message should be sent to in E164 format. ||
9
-
|**from**|**String**| Either an alphanumeric sender ID or the sender's Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message. Alphanumeric Sender IDs can contain up to 11 characters, upper-case letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -, plus +, underscore _ and ampersand &. Alphanumeric Sender IDs must contain at least one letter. ||
9
+
|**from**|**String**| Either an alphanumeric sender ID or the sender's Bandwidth phone number in E.164 format, which must be hosted within Bandwidth and linked to the account that is generating the message. Alphanumeric Sender IDs can contain up to 11 characters, upper-case letters A-Z, lower-case letters a-z, numbers 0-9, space, hyphen -, plus +, underscore _ and ampersand &. Alphanumeric Sender IDs must contain at least one letter. ||
10
10
|**text**|**String**| The contents of the text message. Must be 2048 characters or less. |[optional]|
11
-
|**media**|**Array<String>**| A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. |[optional]|
11
+
|**media**|**Array<String>**| A list of URLs to include as media attachments as part of the message. Each URL can be at most 4096 characters. |[optional]|
12
12
|**tag**|**String**| A custom string that will be included in callback events of the message. Max 1024 characters. |[optional]|
|**expiration**|**Time**| A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. Not supported on MMS. |[optional]|
14
+
|**expiration**|**Time**| A string with the date/time value that the message will automatically expire by. This must be a valid RFC-3339 value, e.g., 2021-03-14T01:59:26Z or 2021-03-13T20:59:26-05:00. Must be a date-time in the future. Not supported on MMS. |[optional]|
Copy file name to clipboardExpand all lines: docs/MessagesApi.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -103,20 +103,20 @@ end
103
103
api_instance =Bandwidth::MessagesApi.new
104
104
account_id ='9900000'# String | Your Bandwidth Account ID.
105
105
opts = {
106
-
message_id:'9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6', # 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.
107
-
source_tn:'%2B15554443333', # 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. '%2B1919').
108
-
destination_tn:'%2B15554443333', # 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. '%2B1919').
109
-
message_status:Bandwidth::MessageStatusEnum::RECEIVED, # MessageStatusEnum | The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
106
+
message_id:'9e0df4ca-b18d-40d7-a59f-82fcdf5ae8e6', # 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.
107
+
source_tn:'%2B15554443333', # 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. '%2B1919').
108
+
destination_tn:'%2B15554443333', # 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. '%2B1919').
109
+
message_status:Bandwidth::MessageStatusEnum::RECEIVED, # MessageStatusEnum | The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED.
110
110
message_direction:Bandwidth::ListMessageDirectionEnum::INBOUND, # ListMessageDirectionEnum | The direction of the message. One of INBOUND OUTBOUND.
111
-
carrier_name:'Verizon', # 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&T should be passed as AT%26T).
111
+
carrier_name:'Verizon', # 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&T should be passed as AT%26T).
112
112
message_type:Bandwidth::MessageTypeEnum::SMS, # MessageTypeEnum | The type of message. Either sms or mms.
113
113
error_code:9902, # Integer | The error code of the message.
114
-
from_date_time:'2022-09-14T18:20:16.000Z', # 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.
115
-
to_date_time:'2022-09-14T18:20:16.000Z', # 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.
114
+
from_date_time:'2022-09-14T18:20:16.000Z', # 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.
115
+
to_date_time:'2022-09-14T18:20:16.000Z', # 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.
116
116
campaign_id:'CJEUMDK', # String | The campaign ID of the message.
117
117
sort:'sourceTn:desc', # String | The field and direction to sort by combined with a colon. Direction is either asc or desc.
118
118
page_token:'gdEewhcJLQRB5', # String | A base64 encoded value used for pagination of results.
119
-
limit:50, # Integer | The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
119
+
limit:50, # Integer | The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000.
120
120
limit_total_count:true# Boolean | When set to true, the response'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.
121
121
}
122
122
@@ -152,20 +152,20 @@ end
152
152
| Name | Type | Description | Notes |
153
153
| ---- | ---- | ----------- | ----- |
154
154
|**account_id**|**String**| Your Bandwidth Account ID. ||
155
-
|**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. |[optional]|
156
-
|**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. '%2B1919'). |[optional]|
157
-
|**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. '%2B1919'). |[optional]|
158
-
|**message_status**|[**MessageStatusEnum**](.md)| The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED. |[optional]|
155
+
|**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. |[optional]|
156
+
|**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. '%2B1919'). |[optional]|
157
+
|**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. '%2B1919'). |[optional]|
158
+
|**message_status**|[**MessageStatusEnum**](.md)| The status of the message. One of RECEIVED QUEUED SENDING SENT FAILED DELIVERED ACCEPTED UNDELIVERED. |[optional]|
159
159
|**message_direction**|[**ListMessageDirectionEnum**](.md)| The direction of the message. One of INBOUND OUTBOUND. |[optional]|
160
-
|**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&T should be passed as AT%26T). |[optional]|
160
+
|**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&T should be passed as AT%26T). |[optional]|
161
161
|**message_type**|[**MessageTypeEnum**](.md)| The type of message. Either sms or mms. |[optional]|
162
162
|**error_code**|**Integer**| The error code of the message. |[optional]|
163
-
|**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. |[optional]|
164
-
|**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. |[optional]|
163
+
|**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. |[optional]|
164
+
|**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. |[optional]|
165
165
|**campaign_id**|**String**| The campaign ID of the message. |[optional]|
166
166
|**sort**|**String**| The field and direction to sort by combined with a colon. Direction is either asc or desc. |[optional]|
167
167
|**page_token**|**String**| A base64 encoded value used for pagination of results. |[optional]|
168
-
|**limit**|**Integer**| The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000. |[optional]|
168
+
|**limit**|**Integer**| The maximum records requested in search result. Default 100. The sum of limit and after cannot be more than 10000. |[optional]|
169
169
|**limit_total_count**|**Boolean**| When set to true, the response'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. |[optional]|
0 commit comments