Package com.mypurecloud.sdk.v2.model

Class SendAgentlessOutboundMessageRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.SendAgentlessOutboundMessageRequest

All Implemented Interfaces:

Serializable

public class SendAgentlessOutboundMessageRequest
extends Object
implements Serializable

SendAgentlessOutboundMessageRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SendAgentlessOutboundMessageRequest.ToAddressMessengerTypeEnum	The recipient messaging address messenger type.

Constructor Summary

Constructors

Constructor	Description
SendAgentlessOutboundMessageRequest()
SendAgentlessOutboundMessageRequest(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
SendAgentlessOutboundMessageRequest	fromAddress(String fromAddress)	The messaging address of the sender of the message.
String	getFromAddress()
SendMessagingTemplateRequest	getMessagingTemplate()
String	getTextBody()
String	getToAddress()
SendAgentlessOutboundMessageRequest.ToAddressMessengerTypeEnum	getToAddressMessengerType()
Boolean	getUseExistingActiveConversation()
int	hashCode()
SendAgentlessOutboundMessageRequest	messagingTemplate(SendMessagingTemplateRequest messagingTemplate)	The messaging template to use in the case of WhatsApp messenger type.
void	setFromAddress(String fromAddress)
void	setMessagingTemplate(SendMessagingTemplateRequest messagingTemplate)
void	setTextBody(String textBody)
void	setToAddress(String toAddress)
void	setToAddressMessengerType(SendAgentlessOutboundMessageRequest.ToAddressMessengerTypeEnum toAddressMessengerType)
void	setUseExistingActiveConversation(Boolean useExistingActiveConversation)
SendAgentlessOutboundMessageRequest	textBody(String textBody)	The text of the message to send.
SendAgentlessOutboundMessageRequest	toAddress(String toAddress)	The messaging address of the recipient of the message.
SendAgentlessOutboundMessageRequest	toAddressMessengerType(SendAgentlessOutboundMessageRequest.ToAddressMessengerTypeEnum toAddressMessengerType)	The recipient messaging address messenger type.
String	toString()
SendAgentlessOutboundMessageRequest	useExistingActiveConversation(Boolean useExistingActiveConversation)	Use an existing active conversation to send the agentless outbound message.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SendAgentlessOutboundMessageRequest

public SendAgentlessOutboundMessageRequest()

SendAgentlessOutboundMessageRequest

public SendAgentlessOutboundMessageRequest(Boolean initWithEmptyList)

Method Details

fromAddress

public SendAgentlessOutboundMessageRequest fromAddress(String fromAddress)

The messaging address of the sender of the message. For an SMS messenger type, this must be a currently provisioned SMS phone number. For a WhatsApp messenger type use the provisioned WhatsApp integration’s ID

getFromAddress

public String getFromAddress()

setFromAddress

public void setFromAddress(String fromAddress)

toAddress

public SendAgentlessOutboundMessageRequest toAddress(String toAddress)

The messaging address of the recipient of the message. For an SMS messenger type, the phone number address must be in E.164 format. E.g. +13175555555 or +34234234234. For WhatsApp messenger type, use a WhatsApp ID of a phone number. E.g for a E.164 formatted phone number `+13175555555`, a WhatsApp ID would be 13175555555.

getToAddress

public String getToAddress()

setToAddress

public void setToAddress(String toAddress)

toAddressMessengerType

public SendAgentlessOutboundMessageRequest toAddressMessengerType(SendAgentlessOutboundMessageRequest.ToAddressMessengerTypeEnum toAddressMessengerType)

The recipient messaging address messenger type.

getToAddressMessengerType

public SendAgentlessOutboundMessageRequest.ToAddressMessengerTypeEnum getToAddressMessengerType()

setToAddressMessengerType

public void setToAddressMessengerType(SendAgentlessOutboundMessageRequest.ToAddressMessengerTypeEnum toAddressMessengerType)

textBody

public SendAgentlessOutboundMessageRequest textBody(String textBody)

The text of the message to send. This field is required in the case of SMS messenger type. Maximum character counts are: SMS - 765 characters, other channels - 2000 characters.

getTextBody

public String getTextBody()

setTextBody

public void setTextBody(String textBody)

messagingTemplate

public SendAgentlessOutboundMessageRequest messagingTemplate(SendMessagingTemplateRequest messagingTemplate)

The messaging template to use in the case of WhatsApp messenger type. This field is required when using WhatsApp messenger type

getMessagingTemplate

public SendMessagingTemplateRequest getMessagingTemplate()

setMessagingTemplate

public void setMessagingTemplate(SendMessagingTemplateRequest messagingTemplate)

useExistingActiveConversation

public SendAgentlessOutboundMessageRequest useExistingActiveConversation(Boolean useExistingActiveConversation)

Use an existing active conversation to send the agentless outbound message. Set this parameter to 'true' to use active conversation. Default value: false

getUseExistingActiveConversation

public Boolean getUseExistingActiveConversation()

setUseExistingActiveConversation

public void setUseExistingActiveConversation(Boolean useExistingActiveConversation)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object