Class InboundsApi

Hierarchy

SmsDomainApi
- InboundsApi

Index

Methods

get list setBasePath

Methods

get

get(data: GetInboundMessageRequestData): Promise<InboundMessageResponse>
Retrieve inbound message This operation retrieves a specific inbound message with the provided inbound ID.
Parameters
- data: GetInboundMessageRequestData
  The data to provide to the API call.
Returns Promise<InboundMessageResponse>

list

list(
data: ListInboundMessagesRequestData,
): ApiListPromise<InboundMessageResponse>
List incoming messages With the list operation, you can list all inbound messages that you have received. This operation supports pagination. Inbounds are returned in reverse chronological order.
Parameters
- data: ListInboundMessagesRequestData
  The data to provide to the API call.
Returns ApiListPromise<InboundMessageResponse>

setBasePath

setBasePath(basePath: string): void
Update the default basePath for the API
Parameters
- basePath: string
  The new base path to use for the APIs.
Returns void
Inherited from SmsDomainApi.setBasePath