Constructor Detail

• SmsControllerApi

  SmsControllerApi(String xApiKey, String basePath)

Method Detail

• getBaseUrl

   final String getBaseUrl()

• deleteSmsMessage

   final Unit deleteSmsMessage(UUID smsId)

  Delete SMS message. Delete an SMS message

• deleteSmsMessageRequestConfig

   final RequestConfig deleteSmsMessageRequestConfig(UUID smsId)

  To obtain the request config of the operation deleteSmsMessage

• deleteSmsMessages

   final Unit deleteSmsMessages(UUID phoneNumberId)

  Delete all SMS messages Delete all SMS messages or all messages for a given phone number

  Parameters:

  phoneNumberId - (optional)

• deleteSmsMessagesRequestConfig

   final RequestConfig deleteSmsMessagesRequestConfig(UUID phoneNumberId)

  To obtain the request config of the operation deleteSmsMessages

  Parameters:

  phoneNumberId - (optional)

• getSmsMessage

   final SmsDto getSmsMessage(UUID smsId)

  Get SMS content including body. Expects SMS to exist by ID. For SMS that may not have arrived yet use the WaitForController. Returns a SMS summary object with content.

• getSmsMessageRequestConfig

   final RequestConfig getSmsMessageRequestConfig(UUID smsId)

  To obtain the request config of the operation getSmsMessage

• getSmsMessagesPaginated

   final PageSmsProjection getSmsMessagesPaginated(UUID phoneNumber, Integer page, Integer size, String sort, Boolean unreadOnly, OffsetDateTime since, OffsetDateTime before)

  Get all SMS messages in all phone numbers in paginated form. . By default returns all SMS messages across all phone numbers sorted by ascending created at date. Responses are paginated. You can restrict results to a list of phone number IDs. You can also filter out read messages

  Parameters:

  phoneNumber - Optional receiving phone number to filter SMS messages for (optional)

  page - Optional page index in SMS list pagination (optional, default to 0)

  size - Optional page size in SMS list pagination.

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  unreadOnly - Optional filter for unread SMS only.

  since - Optional filter SMSs received after given date time (optional)

  before - Optional filter SMSs received before given date time (optional)

• getSmsMessagesPaginatedRequestConfig

   final RequestConfig getSmsMessagesPaginatedRequestConfig(UUID phoneNumber, Integer page, Integer size, String sort, Boolean unreadOnly, OffsetDateTime since, OffsetDateTime before)

  To obtain the request config of the operation getSmsMessagesPaginated

  Parameters:

  phoneNumber - Optional receiving phone number to filter SMS messages for (optional)

  page - Optional page index in SMS list pagination (optional, default to 0)

  size - Optional page size in SMS list pagination.

  sort - Optional createdAt sort direction ASC or DESC (optional, default to ASC)

  unreadOnly - Optional filter for unread SMS only.

  since - Optional filter SMSs received after given date time (optional)

  before - Optional filter SMSs received before given date time (optional)