com.sinch.sdk.domains.sms.InboundsService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sinch-sdk-java Show documentation

SDK providing a Java API for the Sinch REST APIs.

There is a newer version: 1.4.0

package com.sinch.sdk.domains.sms;

import com.sinch.sdk.core.exceptions.ApiException;
import com.sinch.sdk.domains.sms.models.Inbound;
import com.sinch.sdk.domains.sms.models.requests.InboundsListRequestParameters;
import com.sinch.sdk.domains.sms.models.responses.InboundsListResponse;

/**
 * Inbounds Service
 *
 * Inbounds, or Mobile Originated (MO) messages, are incoming messages. Inbound messages can be
 * listed and retrieved like batch messages and they can also be delivered by callback requests like
 * delivery reports.
 *
 * @see https://developers.sinch.com/docs/sms/api-reference/sms/tag/Inbounds/
 * @since 1.0
 */
public interface InboundsService {

  /**
   * 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.
   *
   * @param parameters Filtering parameters
   * @return Incoming messages
   * @see https://developers.sinch.com/docs/sms/api-reference/sms/tag/Delivery-reports/#tag/Delivery-reports/operation/getDeliveryReports
   * @since 1.0
   */
  InboundsListResponse list(InboundsListRequestParameters parameters) throws ApiException;

  /**
   * Retrieve inbound message
   *
   * This operation retrieves a specific inbound message with the provided inbound ID
   *
   * @param inboundId The inbound ID found when listing inbound messages
   * @return Inbound messages-
   * @see https://developers.sinch.com/docs/sms/api-reference/sms/tag/Inbounds/#tag/Inbounds/operation/RetrieveInboundMessage
   * @since 1.0
   */
  Inbound get(String inboundId) throws ApiException;
}