Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions api/messages-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ export const MessagesApiAxiosParamCreator = function (configuration?: Configurat
};
},
/**
* Returns a list of messages based on query parameters.
* Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
* @summary List Messages
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} [messageId] 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.
Expand Down Expand Up @@ -293,7 +293,7 @@ export const MessagesApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Returns a list of messages based on query parameters.
* Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
* @summary List Messages
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} [messageId] 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.
Expand Down Expand Up @@ -353,7 +353,7 @@ export const MessagesApiFactory = function (configuration?: Configuration, baseP
return localVarFp.createMessage(accountId, messageRequest, options).then((request) => request(axios, basePath));
},
/**
* Returns a list of messages based on query parameters.
* Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
* @summary List Messages
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} [messageId] 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.
Expand Down Expand Up @@ -409,7 +409,7 @@ export class MessagesApi extends BaseAPI {
}

/**
* Returns a list of messages based on query parameters.
* Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.
* @summary List Messages
* @param {string} accountId Your Bandwidth Account ID.
* @param {string} [messageId] 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.
Expand Down
33 changes: 28 additions & 5 deletions bandwidth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,13 @@ paths:
/users/{accountId}/messages:
get:
summary: List Messages
description: Returns a list of messages based on query parameters.
description: >
Returns a list of messages based on query parameters.


**Rate Limit:** This endpoint is rate limited to 3500 requests per 5
minutes per Source IP address. Exceeding the limit returns HTTP 429 with
a `Retry-After` header.
operationId: listMessages
tags:
- Messages
Expand Down Expand Up @@ -207,10 +213,12 @@ paths:
$ref: '#/components/responses/messagingForbiddenError'
'404':
$ref: '#/components/responses/messagingNotFoundError'
'405':
$ref: '#/components/responses/messagingMethodNotAllowedError'
'415':
$ref: '#/components/responses/messagingInvalidMediaTypeError'
'429':
$ref: '#/components/responses/messagingTooManyRequestsError'
$ref: '#/components/responses/listMessagesTooManyRequestsError'
'500':
$ref: '#/components/responses/messagingInternalServerError'
post:
Expand Down Expand Up @@ -2257,7 +2265,9 @@ components:
type: object
properties:
media:
$ref: '#/components/schemas/rbmMessageContentFile'
type: array
items:
$ref: '#/components/schemas/rbmMessageContentFile'
suggestions:
$ref: '#/components/schemas/multiChannelFullActions'
required:
Expand Down Expand Up @@ -5875,15 +5885,13 @@ components:
type: object
internalTicketNumber:
type: string
format: uuid
description: >-
Unique identifier (UUID) generated by Bandwidth to assist in tracking
the verification status of a toll-free number - included in all webhook
payloads.
example: acde070d-8c4c-4f0d-9d8a-162843c10333
internalTicketNumberForWebhook:
type: string
format: uuid
description: >-
Unique identifier (UUID) generated by Bandwidth to assist in tracking
the verification status of a toll-free number.
Expand Down Expand Up @@ -6752,6 +6760,21 @@ components:
- type: internal-server-error
description: Internal server error. No further information available
source: {}
listMessagesTooManyRequestsError:
description: Too Many Requests
headers:
Retry-After:
description: The number of seconds to wait before retrying the request.
schema:
type: integer
example: 300
content:
application/json:
schema:
$ref: "#/components/schemas/messagingRequestError"
example:
type: rate_limit_exceeded
description: Rate limit exceeded. Wait for Retry-After time before sending another request.
createCallResponse:
description: Created
headers:
Expand Down
5 changes: 3 additions & 2 deletions docs/MessagesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ const { status, data } = await apiInstance.createMessage(
# **listMessages**
> MessagesList listMessages()

Returns a list of messages based on query parameters.
Returns a list of messages based on query parameters. **Rate Limit:** This endpoint is rate limited to 3500 requests per 5 minutes per Source IP address. Exceeding the limit returns HTTP 429 with a `Retry-After` header.

### Example

Expand Down Expand Up @@ -204,8 +204,9 @@ const { status, data } = await apiInstance.listMessages(
|**401** | Unauthorized | - |
|**403** | Forbidden | - |
|**404** | Not Found | - |
|**405** | Method Not Allowed | - |
|**415** | Unsupported Media Type | - |
|**429** | Too Many Requests | - |
|**429** | Too Many Requests | * Retry-After - The number of seconds to wait before retrying the request. <br> |
|**500** | Internal Server Error | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/MultiChannelChannelListRBMObjectAllOfContent.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**text** | **string** | The text associated with the message. Must be 3270 characters or less | [default to undefined]
**suggestions** | [**Array&lt;MultiChannelAction&gt;**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] [default to undefined]
**media** | [**RbmMessageContentFile**](RbmMessageContentFile.md) | | [default to undefined]
**media** | [**Array&lt;RbmMessageContentFile&gt;**](RbmMessageContentFile.md) | | [default to undefined]
**orientation** | [**StandaloneCardOrientationEnum**](StandaloneCardOrientationEnum.md) | | [default to undefined]
**thumbnailImageAlignment** | [**ThumbnailAlignmentEnum**](ThumbnailAlignmentEnum.md) | | [default to undefined]
**cardContent** | [**RbmCardContent**](RbmCardContent.md) | | [default to undefined]
Expand Down
2 changes: 1 addition & 1 deletion docs/RbmMessageMedia.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**media** | [**RbmMessageContentFile**](RbmMessageContentFile.md) | | [default to undefined]
**media** | [**Array&lt;RbmMessageContentFile&gt;**](RbmMessageContentFile.md) | | [default to undefined]
**suggestions** | [**Array&lt;MultiChannelAction&gt;**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] [default to undefined]

## Example
Expand Down
2 changes: 1 addition & 1 deletion models/rbm-message-media.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import type { MultiChannelAction } from './multi-channel-action';
import type { RbmMessageContentFile } from './rbm-message-content-file';

export interface RbmMessageMedia {
'media': RbmMessageContentFile;
'media': Array<RbmMessageContentFile>;
/**
* An array of suggested actions for the recipient.
*/
Expand Down