io.alwaysonmobile.hullo.api.client

Class MessagesApi

java.lang.Object

io.alwaysonmobile.hullo.api.client.MessagesApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-05-07T11:42:47.246+01:00[Europe/London]")
public class MessagesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
MessagesApi()
MessagesApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Message	createMessage(Message message) Send a message Allows messages to be sent to members.
Message	createMessage(Message message, Map<String,String> additionalHeaders) Send a message Allows messages to be sent to members.
ApiClient	getApiClient()
List<Message>	getMessages(String phoneNumber, Integer limit) Gets the messages for a specific subscriber Retrieves any messages sent / received for a specific subscriber.
List<Message>	getMessages(String phoneNumber, Integer limit, Map<String,String> additionalHeaders) Gets the messages for a specific subscriber Retrieves any messages sent / received for a specific subscriber.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

MessagesApi

public MessagesApi()

MessagesApi

public MessagesApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createMessage

public Message createMessage(Message message)
                      throws ApiException

Send a message Allows messages to be sent to members. Members must be fully opted-in in order to be sent a message, otherwise this operation will reject the call. If a message is longer than 160 characters - using the GSM character set (https://en.wikipedia.org/wiki/GSM_03.38) - then the message will be split into multiple 140 character parts. If any characters fall outside of the supported GSM character set then the message will be converted to UTF-16 (https://en.wikipedia.org/wiki/UTF-16) and split into multiple 70 character parts. The parts will be reconstructed and displayed to the member as a single message on their handset.

Parameters:

message - A JSON object containing message information (required)

Returns:

Message

Throws:

ApiException - if fails to make API call

createMessage

public Message createMessage(Message message,
                             Map<String,String> additionalHeaders)
                      throws ApiException

Send a message Allows messages to be sent to members. Members must be fully opted-in in order to be sent a message, otherwise this operation will reject the call. If a message is longer than 160 characters - using the GSM character set (https://en.wikipedia.org/wiki/GSM_03.38) - then the message will be split into multiple 140 character parts. If any characters fall outside of the supported GSM character set then the message will be converted to UTF-16 (https://en.wikipedia.org/wiki/UTF-16) and split into multiple 70 character parts. The parts will be reconstructed and displayed to the member as a single message on their handset.

Parameters:

message - A JSON object containing message information (required)

additionalHeaders - additionalHeaders for this call

Returns:

Message

Throws:

ApiException - if fails to make API call

getMessages

public List<Message> getMessages(String phoneNumber,
                                 Integer limit)
                          throws ApiException

Gets the messages for a specific subscriber Retrieves any messages sent / received for a specific subscriber. The messages will be ordered by date descending, so the newest messages will appear at the top.

Parameters:

phoneNumber - The phone number of the member (required)

limit - (optional, default to 50)

Returns:

List<Message>

Throws:

ApiException - if fails to make API call

getMessages

public List<Message> getMessages(String phoneNumber,
                                 Integer limit,
                                 Map<String,String> additionalHeaders)
                          throws ApiException

Gets the messages for a specific subscriber Retrieves any messages sent / received for a specific subscriber. The messages will be ordered by date descending, so the newest messages will appear at the top.

Parameters:

phoneNumber - The phone number of the member (required)

limit - (optional, default to 50)

additionalHeaders - additionalHeaders for this call

Returns:

List<Message>

Throws:

ApiException - if fails to make API call