Package com.intercom.api.resources.unstable.messages

Class MessagesClient

java.lang.Object

com.intercom.api.resources.unstable.messages.MessagesClient

public class MessagesClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
MessagesClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
Message	createMessage()	You can create a message that has been initiated by an admin.
Message	createMessage(java.util.Optional<java.lang.Object> request)	You can create a message that has been initiated by an admin.
Message	createMessage(java.util.Optional<java.lang.Object> request, RequestOptions requestOptions)	You can create a message that has been initiated by an admin.
WhatsappMessageStatusList	getWhatsAppMessageStatus(GetWhatsAppMessageStatusRequest request)	Retrieves statuses of messages sent from the Outbound module.
WhatsappMessageStatusList	getWhatsAppMessageStatus(GetWhatsAppMessageStatusRequest request, RequestOptions requestOptions)	Retrieves statuses of messages sent from the Outbound module.
RawMessagesClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

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

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

MessagesClient

public MessagesClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawMessagesClient withRawResponse()

Get responses with HTTP metadata like headers

createMessage

public Message createMessage()

You can create a message that has been initiated by an admin. The conversation can be either an in-app message, an email, sms or whatsapp.

🚧 Sending for visitors

There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

This will return the Message model that has been created.

🚧 Retrieving Associated Conversations

As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.

createMessage

public Message createMessage(java.util.Optional<java.lang.Object> request)

You can create a message that has been initiated by an admin. The conversation can be either an in-app message, an email, sms or whatsapp.

🚧 Sending for visitors

There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

This will return the Message model that has been created.

🚧 Retrieving Associated Conversations

As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.

createMessage

public Message createMessage(java.util.Optional<java.lang.Object> request,
                             RequestOptions requestOptions)

You can create a message that has been initiated by an admin. The conversation can be either an in-app message, an email, sms or whatsapp.

🚧 Sending for visitors

There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

This will return the Message model that has been created.

🚧 Retrieving Associated Conversations

As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.

getWhatsAppMessageStatus

public WhatsappMessageStatusList getWhatsAppMessageStatus(GetWhatsAppMessageStatusRequest request)

Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages.

This endpoint returns paginated status events for WhatsApp messages sent via the Outbound module, providing information about delivery state and related message details.

getWhatsAppMessageStatus

public WhatsappMessageStatusList getWhatsAppMessageStatus(GetWhatsAppMessageStatusRequest request,
                                                          RequestOptions requestOptions)

Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages.

This endpoint returns paginated status events for WhatsApp messages sent via the Outbound module, providing information about delivery state and related message details.