Package com.sinch.sdk.domains.conversation.api.v1

Interface MessagesService

public interface MessagesService

Messages related service

To start sending messages you must have a Conversation API app. The app holds information about the channel credentials and registered webhooks to which the API delivers callbacks such as message delivery receipts and contact messages. If you don't already have an app please follow the instructions in the getting started guide available in the Sinch Dashboard to create one.

Since:

1.3

See Also:

• https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/Messages

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	MessagesService.MessageSource	Specifies the message source for which the request will be processed.

Method Summary

Modifier and Type	Method	Description
void	delete(String messageId)	Helper method for delete(String, MessageSource)
void	delete(String messageId, MessagesService.MessageSource messageSource)	Delete a specific message by its ID.
ConversationMessage	get(String messageId)	Helper method for get(String, MessageSource)
ConversationMessage	get(String messageId, MessagesService.MessageSource messageSource)	Retrieves a specific message by its ID.
MessagesListResponse	list(MessagesListRequest request)	This operation lists all messages sent or received via particular ProcessingMode.
SendMessageResponse	sendCardMessage(SendMessageRequest<CardMessage> request)	Send a card message
SendMessageResponse	sendCarouselMessage(SendMessageRequest<CarouselMessage> request)	Send a carousel message
SendMessageResponse	sendChoiceMessage(SendMessageRequest<ChoiceMessage> request)	Send a choice message
SendMessageResponse	sendContactInfoMessage(SendMessageRequest<ContactInfoMessage> request)	Send a contact info message
SendMessageResponse	sendListMessage(SendMessageRequest<ListMessage> request)	Send a list message
SendMessageResponse	sendLocationMessage(SendMessageRequest<LocationMessage> request)	Send a location message
SendMessageResponse	sendMediaMessage(SendMessageRequest<MediaMessage> request)	Send a media message
SendMessageResponse	sendMessage(SendMessageRequest<? extends AppMessageBody> request)	Send a message
SendMessageResponse	sendTemplateMessage(SendMessageRequest<TemplateMessage> request)	Send a template message
SendMessageResponse	sendTextMessage(SendMessageRequest<TextMessage> request)	Send a send message request message
ConversationMessage	update(String messageId, MessagesService.MessageSource messageSource, MessageUpdateRequest request)	Update a specific message by its ID.
ConversationMessage	update(String messageId, MessageUpdateRequest request)	Helper method for update(String, MessageSource, MessageUpdateRequest)

Method Details

sendMessage

SendMessageResponse sendMessage(SendMessageRequest<? extends AppMessageBody> request)

Send a message

You can send a message from a Conversation app to a contact associated with that app. If the recipient is not associated with an existing contact, a new contact will be created.

The message is added to the active conversation with the contact if a conversation already exists. If no active conversation exists a new one is started automatically.

You can find all of your IDs and authentication credentials on the Sinch Customer Dashboard.

Parameters:

request - Request parameters

Returns:

Response related to sent message

Since:

1.3

sendCardMessage

SendMessageResponse sendCardMessage(SendMessageRequest<CardMessage> request)

Send a card message

Parameters:

request - CardMessage request

Returns:

Response related to sent message

Since:

1.3

See Also:

• sendMessage(SendMessageRequest)

sendCarouselMessage

SendMessageResponse sendCarouselMessage(SendMessageRequest<CarouselMessage> request)

Send a carousel message

Parameters:

request - CarouselMessage request

Returns:

Response related to sent message

Since:

1.3

See Also:

• sendMessage(SendMessageRequest)

sendChoiceMessage

SendMessageResponse sendChoiceMessage(SendMessageRequest<ChoiceMessage> request)

Send a choice message

Parameters:

request - ChoiceMessage request

Returns:

Response related to sent message

Since:

1.3

See Also:

• sendMessage(SendMessageRequest)

sendContactInfoMessage

SendMessageResponse sendContactInfoMessage(SendMessageRequest<ContactInfoMessage> request)

Send a contact info message

Parameters:

request - ContactInfoMessage request

Returns:

Response related to sent message

Since:

1.3

See Also:

• sendMessage(SendMessageRequest)

sendListMessage

SendMessageResponse sendListMessage(SendMessageRequest<ListMessage> request)

Send a list message

Parameters:

request - ListMessage request

Returns:

Response related to sent message

Since:

1.3

See Also:

• sendMessage(SendMessageRequest)

sendLocationMessage

SendMessageResponse sendLocationMessage(SendMessageRequest<LocationMessage> request)

Send a location message

Parameters:

request - LocationMessage request

Returns:

Response related to sent message

Since:

1.3

See Also:

• sendMessage(SendMessageRequest)

sendMediaMessage

SendMessageResponse sendMediaMessage(SendMessageRequest<MediaMessage> request)

Send a media message

Parameters:

request - MediaMessage request

Returns:

Response related to sent message

Since:

1.3

See Also:

• sendMessage(SendMessageRequest)

sendTemplateMessage

SendMessageResponse sendTemplateMessage(SendMessageRequest<TemplateMessage> request)

Send a template message

Parameters:

request - TemplateMessage request

Returns:

Response related to sent message

Since:

1.3

See Also:

• sendMessage(SendMessageRequest)

sendTextMessage

SendMessageResponse sendTextMessage(SendMessageRequest<TextMessage> request)

Send a send message request message

Parameters:

request - request

Returns:

Response related to sent message

Since:

1.3

See Also:

• sendMessage(SendMessageRequest)

get

ConversationMessage get(String messageId)

Helper method for get(String, MessageSource)

Parameters:

messageId - The unique ID of the message.

Returns:

Conversation message

Since:

1.3

See Also:

• get(String, MessageSource)

get

ConversationMessage get(String messageId,
 MessagesService.MessageSource messageSource)

Retrieves a specific message by its ID.

Parameters:

messageId - The unique ID of the message.

messageSource - Specifies the message source for which the request will be processed. Used for operations on messages in Dispatch Mode. For more information, see Processing Modes

Returns:

Conversation message

Since:

1.3

Default value:

CONVERSATION_SOURCE

list

MessagesListResponse list(MessagesListRequest request)

This operation lists all messages sent or received via particular ProcessingMode.

Setting the messages_source parameter to CONVERSATION_SOURCE allows for querying messages in CONVERSATION mode, and setting it to DISPATCH_SOURCE will allow for queries of messages in DISPATCH mode.

Combining multiple parameters is supported for more detailed filtering of messages, but some of them are not supported depending on the value specified for messages_source. The description for each field will inform if that field may not be supported.

The messages are ordered by their accept_time property in descending order, where accept_time is a timestamp of when the message was enqueued by the Conversation API. This means messages received most recently will be listed first.

Parameters:

request - Request parameters

Returns:

List of messages

Since:

1.3

delete

void delete(String messageId)

Helper method for delete(String, MessageSource)

Parameters:

messageId - The unique ID of the message.

Since:

1.3

See Also:

• delete(String, MessageSource)

delete

void delete(String messageId,
 MessagesService.MessageSource messageSource)

Delete a specific message by its ID.

Parameters:

messageId - The unique ID of the message.

messageSource - Specifies the message source for which the request will be processed. Used for operations on messages in Dispatch Mode. For more information, see Processing Modes

Since:

1.3

API Note:

Removing all messages of a conversation will not automatically delete the conversation.

Default value:

CONVERSATION_SOURCE

update

ConversationMessage update(String messageId,
 MessageUpdateRequest request)

Helper method for update(String, MessageSource, MessageUpdateRequest)

Parameters:

messageId - The unique ID of the message.

request - Request parameters to be used for updating

Returns:

Updated message

Since:

1.3

See Also:

• update(String, MessageSource, MessageUpdateRequest)

update

ConversationMessage update(String messageId,
 MessagesService.MessageSource messageSource,
 MessageUpdateRequest request)

Update a specific message by its ID.

Parameters:

messageId - The unique ID of the message

messageSource - Specifies the message source for which the request will be processed. Used for operations on messages in Dispatch Mode. For more information, see Processing Modes

request - Request parameters to be used for updating

Returns:

Updated message

Since:

1.3

Default value:

CONVERSATION_SOURCE