Package com.mypurecloud.sdk.v2.model

Class CreateOutboundMessagingConversationRequest

java.lang.Object
com.mypurecloud.sdk.v2.model.CreateOutboundMessagingConversationRequest
All Implemented Interfaces:
Serializable
public class CreateOutboundMessagingConversationRequest extends Object implements Serializable
CreateOutboundMessagingConversationRequest
See Also:

  • Constructor Details

    • CreateOutboundMessagingConversationRequest

      public CreateOutboundMessagingConversationRequest()

    • CreateOutboundMessagingConversationRequest

      public CreateOutboundMessagingConversationRequest(Boolean initWithEmptyList)

  • Method Details

    • queueId

      public CreateOutboundMessagingConversationRequest queueId(String queueId)
      The ID of the queue to be associated with the message. This will determine the fromAddress of the message, unless useUserFromAddress is true and the queue is configured to use the agent's Direct Routing address as the fromAddress.

    • getQueueId

      public String getQueueId()

    • setQueueId

      public void setQueueId(String queueId)

    • toAddress

      public CreateOutboundMessagingConversationRequest 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 open messenger type, any string within the outbound.open.messaging.to.address.characters.max limit can be used. 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 CreateOutboundMessagingConversationRequest toAddressMessengerType(CreateOutboundMessagingConversationRequest.ToAddressMessengerTypeEnum toAddressMessengerType)
      The messaging address messenger type.

    • getToAddressMessengerType

      public CreateOutboundMessagingConversationRequest.ToAddressMessengerTypeEnum getToAddressMessengerType()

    • setToAddressMessengerType

      public void setToAddressMessengerType(CreateOutboundMessagingConversationRequest.ToAddressMessengerTypeEnum toAddressMessengerType)

    • useExistingConversation

      public CreateOutboundMessagingConversationRequest useExistingConversation(Boolean useExistingConversation)
      An override to use an existing conversation. If set to true, an existing conversation will be used if there is one within the conversation window. If set to false, create request fails if there is a conversation within the conversation window.

    • getUseExistingConversation

      public Boolean getUseExistingConversation()

    • setUseExistingConversation

      public void setUseExistingConversation(Boolean useExistingConversation)

    • externalContactId

      public CreateOutboundMessagingConversationRequest externalContactId(String externalContactId)
      The external contact with which the message will be associated.

    • getExternalContactId

      public String getExternalContactId()

    • setExternalContactId

      public void setExternalContactId(String externalContactId)

    • useUserFromAddress

      public CreateOutboundMessagingConversationRequest useUserFromAddress(Boolean useUserFromAddress)
      An override to attempt to use the user's configured direct routing address as the fromAddress. If set to true, users configured address with 'directrouting' integration will be used as fromAddress. If set to false or not set, the queueId will be used for determining fromAddress.

    • getUseUserFromAddress

      public Boolean getUseUserFromAddress()

    • setUseUserFromAddress

      public void setUseUserFromAddress(Boolean useUserFromAddress)

    • 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