Package pl.gsmservice.gateway

Class Outgoing

  • public class Outgoing
extends java.lang.Object

    • Method Detail

      • mms

        public final Mms mms()

      • sms

        public final Sms sms()

      • async

        public AsyncOutgoing async()
        Switches to the async SDK.
        Returns:
        The async SDK

      • getByIds

        public GetMessagesRequestBuilder getByIds()
        Get the messages details and status by IDs



        Check the current status and details of one or more messages using their ids. You should pass the ListOf() containing unique message IDs (Long type) which details you want to fetch. Please use builder style: 

        
 GetMessagesResponse res = sdk.outgoing().getByIds()
    .ids(List.of(43456L))
    .call();

        This method will accept maximum 50 identifiers in one call.

        As a successful result a GetMessagesResponse object will be returned containing messages property of type List<Message> with Message objects, each object per single found message. GetMessagesResponse object will also contain headers property where you can find X-Success-Count (a count of messages which were found and returned correctly) and X-Error-Count (count of messages which were not found) elements.
        Returns:
        The call builder

      • getByIds

        public GetMessagesResponse getByIds​(java.util.List<java.lang.Long> ids)
                             throws java.lang.Exception
        Get the messages details and status by IDs



        Check the current status and details of one or more messages using their ids. You should pass the ListOf() containing unique message IDs (Long type) which details you want to fetch. Please use builder style: 

        
 GetMessagesResponse res = sdk.outgoing().getByIds()
    .ids(List.of(43456L))
    .call();

        This method will accept maximum 50 identifiers in one call.

        As a successful result a GetMessagesResponse object will be returned containing messages property of type List<Message> with Message objects, each object per single found message. GetMessagesResponse object will also contain headers property where you can find X-Success-Count (a count of messages which were found and returned correctly) and X-Error-Count (count of messages which were not found) elements.
        Parameters:
        ids - List of Message IDs assigned by the system. 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 GetMessagesResponse getByIds​(java.util.List<java.lang.Long> ids,
                                    java.util.Optional<Options> options)
                             throws java.lang.Exception
        Get the messages details and status by IDs



        Check the current status and details of one or more messages using their ids. You should pass the ListOf() containing unique message IDs (Long type) which details you want to fetch. Please use builder style: 

        
 GetMessagesResponse res = sdk.outgoing().getByIds()
    .ids(List.of(43456L))
    .call();

        This method will accept maximum 50 identifiers in one call.

        As a successful result a GetMessagesResponse object will be returned containing messages property of type List<Message> with Message objects, each object per single found message. GetMessagesResponse object will also contain headers property where you can find X-Success-Count (a count of messages which were found and returned correctly) and X-Error-Count (count of messages which were not found) elements.
        Parameters:
        ids - List of Message IDs assigned by the system. 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

      • cancelScheduled

        public CancelMessagesRequestBuilder cancelScheduled()
        Cancel a scheduled messages



        Cancel messages using their ids which were scheduled to be sent at a specific time. You have to pass a ListOf() containing the unique message IDs (Long type), which were returned after sending a message. Please use builder style: 

        
 CancelMessagesResponse res2 = sdk.outgoing().cancelScheduled()
    .ids(List.of(43456L))
    .call();

        This method will accept maximum 50 identifiers in one call. You can cancel only messages with SCHEDULED status.

        As a successful result a CancelMessagesResponse object will be returned, with cancelledMessages property of type List<CancelledMessage> containing CancelledMessage objects. The status property of each CancelledMessage object will contain a status code of operation - 204 if a particular message was cancelled successfully and other code if an error occured.

        CancelMessagesResponse object will also contain headers property where you can find X-Success-Count (a count of messages which were cancelled successfully), X-Error-Count (count of messages which were not cancelled) and X-Sandbox (if a request was made in Sandbox or Production system) elements.

        Returns:
        The call builder

      • cancelScheduled

        public CancelMessagesResponse cancelScheduled​(java.util.List<java.lang.Long> ids)
                                       throws java.lang.Exception
        Cancel a scheduled messages



        Cancel messages using their ids which were scheduled to be sent at a specific time. You have to pass a ListOf() containing the unique message IDs (Long type), which were returned after sending a message. Please use builder style: 

        
 CancelMessagesResponse res2 = sdk.outgoing().cancelScheduled()
    .ids(List.of(43456L))
    .call();

        This method will accept maximum 50 identifiers in one call. You can cancel only messages with SCHEDULED status.

        As a successful result a CancelMessagesResponse object will be returned, with cancelledMessages property of type List<CancelledMessage> containing CancelledMessage objects. The status property of each CancelledMessage object will contain a status code of operation - 204 if a particular message was cancelled successfully and other code if an error occured.

        CancelMessagesResponse object will also contain headers property where you can find X-Success-Count (a count of messages which were cancelled successfully), X-Error-Count (count of messages which were not cancelled) and X-Sandbox (if a request was made in Sandbox or Production system) elements.

        Parameters:
        ids - List of Message IDs assigned by the system. 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

      • cancelScheduled

        public CancelMessagesResponse cancelScheduled​(java.util.List<java.lang.Long> ids,
                                              java.util.Optional<Options> options)
                                       throws java.lang.Exception
        Cancel a scheduled messages



        Cancel messages using their ids which were scheduled to be sent at a specific time. You have to pass a ListOf() containing the unique message IDs (Long type), which were returned after sending a message. Please use builder style: 

        
 CancelMessagesResponse res2 = sdk.outgoing().cancelScheduled()
    .ids(List.of(43456L))
    .call();

        This method will accept maximum 50 identifiers in one call. You can cancel only messages with SCHEDULED status.

        As a successful result a CancelMessagesResponse object will be returned, with cancelledMessages property of type List<CancelledMessage> containing CancelledMessage objects. The status property of each CancelledMessage object will contain a status code of operation - 204 if a particular message was cancelled successfully and other code if an error occured.

        CancelMessagesResponse object will also contain headers property where you can find X-Success-Count (a count of messages which were cancelled successfully), X-Error-Count (count of messages which were not cancelled) and X-Sandbox (if a request was made in Sandbox or Production system) elements.

        Parameters:
        ids - List of Message IDs assigned by the system. 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

      • list

        public ListMessagesRequestBuilder list()
        Lists the history of sent messages



        Get the details and current status of all of sent messages from your account message history. This method supports pagination so you have to pass a page (number of page with messages which you want to access, Long type) and a limit (max of messages per page, Long type) parameters. Please use builder style: 

        
 ListMessagesResponse res = sdk.outgoing().list()
    .page(1L)
    .limit(10L)
    .call();

        Messages are fetched from the latest one. This method will accept maximum value of 50 as limit parameter value.

        As a successful result a ListMessagesResponse object will be returned containing messages property of type List<Message> with a Message objects, each object per single message. ListMessagesResponse will also contain headers property where you can find X-Total-Results (a total count of all messages which are available in history 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) elements.
        Returns:
        The call builder

      • listDirect

        public ListMessagesResponse listDirect()
                                throws java.lang.Exception
        Lists the history of sent messages



        Get the details and current status of all of sent messages from your account message history. This method supports pagination so you have to pass a page (number of page with messages which you want to access, Long type) and a limit (max of messages per page, Long type) parameters. Please use builder style: 

        
 ListMessagesResponse res = sdk.outgoing().list()
    .page(1L)
    .limit(10L)
    .call();

        Messages are fetched from the latest one. This method will accept maximum value of 50 as limit parameter value.

        As a successful result a ListMessagesResponse object will be returned containing messages property of type List<Message> with a Message objects, each object per single message. ListMessagesResponse will also contain headers property where you can find X-Total-Results (a total count of all messages which are available in history 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) elements.
        Returns:
        The response from the API call
        Throws:
        java.lang.Exception - if the API call fails

      • list

        public ListMessagesResponse list​(java.util.Optional<java.lang.Long> page,
                                 java.util.Optional<java.lang.Long> limit,
                                 java.util.Optional<Options> options)
                          throws java.lang.Exception
        Lists the history of sent messages



        Get the details and current status of all of sent messages from your account message history. This method supports pagination so you have to pass a page (number of page with messages which you want to access, Long type) and a limit (max of messages per page, Long type) parameters. Please use builder style: 

        
 ListMessagesResponse res = sdk.outgoing().list()
    .page(1L)
    .limit(10L)
    .call();

        Messages are fetched from the latest one. This method will accept maximum value of 50 as limit parameter value.

        As a successful result a ListMessagesResponse object will be returned containing messages property of type List<Message> with a Message objects, each object per single message. ListMessagesResponse will also contain headers property where you can find X-Total-Results (a total count of all messages which are available in history 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) elements.
        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