Package pl.gsmservice.gateway

Class Incoming

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      GetIncomingMessagesRequestBuilder getByIds()
      Get the incoming messages by IDs Get the details of one or more received messages using their `ids`.
      GetIncomingMessagesResponse getByIds​(java.util.List<java.lang.Long> ids)
      Get the incoming messages by IDs Get the details of one or more received messages using their `ids`.
      GetIncomingMessagesResponse getByIds​(java.util.List<java.lang.Long> ids, java.util.Optional<Options> options)
      Get the incoming messages by IDs Get the details of one or more received messages using their `ids`.
      ListIncomingMessagesRequestBuilder list()
      List the received SMS messages Get the details of all of received messages from your account incoming messages box.
      ListIncomingMessagesResponse list​(java.util.Optional<java.lang.Long> page, java.util.Optional<java.lang.Long> limit, java.util.Optional<Options> options)
      List the received SMS messages Get the details of all of received messages from your account incoming messages box.
      ListIncomingMessagesResponse listDirect()
      List the received SMS messages Get the details of all of received messages from your account incoming messages box.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • list

        public ListIncomingMessagesRequestBuilder list()
        List the received SMS messages Get the details of all of received messages from your account incoming messages box. This endpoint supports pagination so you have to pass as query parameters a `page` value (number of page with received messages which you want to access) and a `limit` value (max of received messages per page). Messages are fetched from the latest one. The system will accept maximum **50** as `limit` parameter value. If you need to get details of larger volume of messages, please access them with next pages. As a successful result an array with `IncomingMessage` objects will be returned, each object per single received message. Response will also include meta-data headers: `X-Total-Results` (a total count of all received messages which are available in incoming box on your account), `X-Total-Pages` (a total number of all pages with results), `X-Current-Page` (A current page number) and `X-Limit` (messages count per single page). This request have to be authenticated using **API Access Token**. A response contains also a special `Link` header which includes *URIs* to access next, previous, first and last page with received messages (which complies with [RFC 5988](https://www.rfc-editor.org/rfc/rfc5988)). In case of an error, the `ErrorResponse` object will be returned with proper HTTP header status code (our error response complies with [RFC 9457](https://www.rfc-editor.org/rfc/rfc7807)).
        Returns:
        The call builder

      • listDirect

        public ListIncomingMessagesResponse listDirect()
                                        throws java.lang.Exception
        List the received SMS messages Get the details of all of received messages from your account incoming messages box. This endpoint supports pagination so you have to pass as query parameters a `page` value (number of page with received messages which you want to access) and a `limit` value (max of received messages per page). Messages are fetched from the latest one. The system will accept maximum **50** as `limit` parameter value. If you need to get details of larger volume of messages, please access them with next pages. As a successful result an array with `IncomingMessage` objects will be returned, each object per single received message. Response will also include meta-data headers: `X-Total-Results` (a total count of all received messages which are available in incoming box on your account), `X-Total-Pages` (a total number of all pages with results), `X-Current-Page` (A current page number) and `X-Limit` (messages count per single page). This request have to be authenticated using **API Access Token**. A response contains also a special `Link` header which includes *URIs* to access next, previous, first and last page with received messages (which complies with [RFC 5988](https://www.rfc-editor.org/rfc/rfc5988)). In case of an error, the `ErrorResponse` object will be returned with proper HTTP header status code (our error response complies with [RFC 9457](https://www.rfc-editor.org/rfc/rfc7807)).
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • list

        public ListIncomingMessagesResponse list​(java.util.Optional<java.lang.Long> page,
                                         java.util.Optional<java.lang.Long> limit,
                                         java.util.Optional<Options> options)
                                  throws java.lang.Exception
        List the received SMS messages Get the details of all of received messages from your account incoming messages box. This endpoint supports pagination so you have to pass as query parameters a `page` value (number of page with received messages which you want to access) and a `limit` value (max of received messages per page). Messages are fetched from the latest one. The system will accept maximum **50** as `limit` parameter value. If you need to get details of larger volume of messages, please access them with next pages. As a successful result an array with `IncomingMessage` objects will be returned, each object per single received message. Response will also include meta-data headers: `X-Total-Results` (a total count of all received messages which are available in incoming box on your account), `X-Total-Pages` (a total number of all pages with results), `X-Current-Page` (A current page number) and `X-Limit` (messages count per single page). This request have to be authenticated using **API Access Token**. A response contains also a special `Link` header which includes *URIs* to access next, previous, first and last page with received messages (which complies with [RFC 5988](https://www.rfc-editor.org/rfc/rfc5988)). In case of an error, the `ErrorResponse` object will be returned with proper HTTP header status code (our error response complies with [RFC 9457](https://www.rfc-editor.org/rfc/rfc7807)).
        Specified by:
        list in interface SDKMethodInterfaces.MethodCallListIncomingMessages
        Parameters:
        page - Page number of results
        limit - Number of results on one page
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • getByIds

        public GetIncomingMessagesRequestBuilder getByIds()
        Get the incoming messages by IDs Get the details of one or more received messages using their `ids`. You have to pass the unique incoming message *IDs* as path parameter, which were given while receiving a messages. If you want to get the details of multiple messages at once, please separate their IDs with a comma. The system will accept maximum 50 identifiers in one call. If you need to get details of larger volume of incoming messages, please split it to several separate requests. As a successful result an array with `IncomingMessage` objects will be returned, each object per single found message. Response will also include meta-data headers: `X-Success-Count` (a count of incoming messages which were found and returned correctly) and `X-Error-Count` (count of incoming messages which were not found). If you pass duplicated IDs, API will return data of this message only once. This request have to be authenticated using **API Access Token**. In case of an error, the `ErrorResponse` object will be returned with proper HTTP header status code (our error response complies with [RFC 9457](https://www.rfc-editor.org/rfc/rfc7807)).
        Returns:
        The call builder

      • getByIds

        public GetIncomingMessagesResponse getByIds​(java.util.List<java.lang.Long> ids)
                                     throws java.lang.Exception
        Get the incoming messages by IDs Get the details of one or more received messages using their `ids`. You have to pass the unique incoming message *IDs* as path parameter, which were given while receiving a messages. If you want to get the details of multiple messages at once, please separate their IDs with a comma. The system will accept maximum 50 identifiers in one call. If you need to get details of larger volume of incoming messages, please split it to several separate requests. As a successful result an array with `IncomingMessage` objects will be returned, each object per single found message. Response will also include meta-data headers: `X-Success-Count` (a count of incoming messages which were found and returned correctly) and `X-Error-Count` (count of incoming messages which were not found). If you pass duplicated IDs, API will return data of this message only once. This request have to be authenticated using **API Access Token**. In case of an error, the `ErrorResponse` object will be returned with proper HTTP header status code (our error response complies with [RFC 9457](https://www.rfc-editor.org/rfc/rfc7807)).
        Parameters:
        ids - Message IDs assigned by the system (separated by comma). The system will accept a maximum of 50 identifiers in one call.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • getByIds

        public GetIncomingMessagesResponse getByIds​(java.util.List<java.lang.Long> ids,
                                            java.util.Optional<Options> options)
                                     throws java.lang.Exception
        Get the incoming messages by IDs Get the details of one or more received messages using their `ids`. You have to pass the unique incoming message *IDs* as path parameter, which were given while receiving a messages. If you want to get the details of multiple messages at once, please separate their IDs with a comma. The system will accept maximum 50 identifiers in one call. If you need to get details of larger volume of incoming messages, please split it to several separate requests. As a successful result an array with `IncomingMessage` objects will be returned, each object per single found message. Response will also include meta-data headers: `X-Success-Count` (a count of incoming messages which were found and returned correctly) and `X-Error-Count` (count of incoming messages which were not found). If you pass duplicated IDs, API will return data of this message only once. This request have to be authenticated using **API Access Token**. In case of an error, the `ErrorResponse` object will be returned with proper HTTP header status code (our error response complies with [RFC 9457](https://www.rfc-editor.org/rfc/rfc7807)).
        Specified by:
        getByIds in interface SDKMethodInterfaces.MethodCallGetIncomingMessages
        Parameters:
        ids - Message IDs assigned by the system (separated by comma). The system will accept a maximum of 50 identifiers in one call.
        options - additional options
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails