Package com.mypurecloud.sdk.v2.model

Class SmsPhoneNumber

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

  • Constructor Details

    • SmsPhoneNumber

      public SmsPhoneNumber()

    • SmsPhoneNumber

      public SmsPhoneNumber(Boolean initWithEmptyList)

  • Method Details

    • getId

      public String getId()

    • name

      public SmsPhoneNumber name(String name)

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • phoneNumber

      public SmsPhoneNumber phoneNumber(String phoneNumber)
      A phone number provisioned for SMS communications.

    • getPhoneNumber

      public String getPhoneNumber()

    • setPhoneNumber

      public void setPhoneNumber(String phoneNumber)

    • getPhoneNumberType

      public SmsPhoneNumber.PhoneNumberTypeEnum getPhoneNumberType()

    • provisionedThroughPureCloud

      public SmsPhoneNumber provisionedThroughPureCloud(Boolean provisionedThroughPureCloud)
      Is set to false, if the phone number is provisioned through a SMS provider, outside of PureCloud

    • getProvisionedThroughPureCloud

      public Boolean getProvisionedThroughPureCloud()

    • setProvisionedThroughPureCloud

      public void setProvisionedThroughPureCloud(Boolean provisionedThroughPureCloud)

    • phoneNumberStatus

      public SmsPhoneNumber phoneNumberStatus(SmsPhoneNumber.PhoneNumberStatusEnum phoneNumberStatus)
      Status of the provisioned phone number.

    • getPhoneNumberStatus

      public SmsPhoneNumber.PhoneNumberStatusEnum getPhoneNumberStatus()

    • setPhoneNumberStatus

      public void setPhoneNumberStatus(SmsPhoneNumber.PhoneNumberStatusEnum phoneNumberStatus)

    • getCapabilities

      public List<SmsPhoneNumber.CapabilitiesEnum> getCapabilities()

    • countryCode

      public SmsPhoneNumber countryCode(String countryCode)
      The ISO 3166-1 alpha-2 country code of the country this phone number is associated with.

    • getCountryCode

      public String getCountryCode()

    • setCountryCode

      public void setCountryCode(String countryCode)

    • dateCreated

      public SmsPhoneNumber dateCreated(Date dateCreated)
      Date this phone number was provisioned. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateCreated

      public Date getDateCreated()

    • setDateCreated

      public void setDateCreated(Date dateCreated)

    • dateModified

      public SmsPhoneNumber dateModified(Date dateModified)
      Date this phone number was modified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getDateModified

      public Date getDateModified()

    • setDateModified

      public void setDateModified(Date dateModified)

    • createdBy

      public SmsPhoneNumber createdBy(User createdBy)
      User that provisioned this phone number

    • getCreatedBy

      public User getCreatedBy()

    • setCreatedBy

      public void setCreatedBy(User createdBy)

    • modifiedBy

      public SmsPhoneNumber modifiedBy(User modifiedBy)
      User that last modified this phone number

    • getModifiedBy

      public User getModifiedBy()

    • setModifiedBy

      public void setModifiedBy(User modifiedBy)

    • version

      public SmsPhoneNumber version(Integer version)
      Version number required for updates.

    • getVersion

      public Integer getVersion()

    • setVersion

      public void setVersion(Integer version)

    • purchaseDate

      public SmsPhoneNumber purchaseDate(Date purchaseDate)
      Date this phone number was purchased, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getPurchaseDate

      public Date getPurchaseDate()

    • setPurchaseDate

      public void setPurchaseDate(Date purchaseDate)

    • cancellationDate

      public SmsPhoneNumber cancellationDate(Date cancellationDate)
      Contract end date of this phone number, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getCancellationDate

      public Date getCancellationDate()

    • setCancellationDate

      public void setCancellationDate(Date cancellationDate)

    • renewalDate

      public SmsPhoneNumber renewalDate(Date renewalDate)
      Contract renewal date of this phone number, if the phoneNumberType is shortcode. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

    • getRenewalDate

      public Date getRenewalDate()

    • setRenewalDate

      public void setRenewalDate(Date renewalDate)

    • autoRenewable

      public SmsPhoneNumber autoRenewable(SmsPhoneNumber.AutoRenewableEnum autoRenewable)
      Renewal time period of this phone number, if the phoneNumberType is shortcode.

    • getAutoRenewable

      public SmsPhoneNumber.AutoRenewableEnum getAutoRenewable()

    • setAutoRenewable

      public void setAutoRenewable(SmsPhoneNumber.AutoRenewableEnum autoRenewable)

    • addressId

      public SmsPhoneNumber addressId(SmsAddress addressId)
      The id of an address attached to this phone number.

    • getAddressId

      public SmsAddress getAddressId()

    • setAddressId

      public void setAddressId(SmsAddress addressId)

    • shortCodeBillingType

      public SmsPhoneNumber shortCodeBillingType(SmsPhoneNumber.ShortCodeBillingTypeEnum shortCodeBillingType)
      BillingType of this phone number, if the phoneNumberType is shortcode.

    • getShortCodeBillingType

      public SmsPhoneNumber.ShortCodeBillingTypeEnum getShortCodeBillingType()

    • setShortCodeBillingType

      public void setShortCodeBillingType(SmsPhoneNumber.ShortCodeBillingTypeEnum shortCodeBillingType)

    • provisioningStatus

      public SmsPhoneNumber provisioningStatus(SmsProvisioningStatus provisioningStatus)
      Status of latest asynchronous provisioning action

    • getProvisioningStatus

      public SmsProvisioningStatus getProvisioningStatus()

    • setProvisioningStatus

      public void setProvisioningStatus(SmsProvisioningStatus provisioningStatus)

    • country

      public SmsPhoneNumber country(String country)
      Localized country name for the country code this phone number belongs too

    • getCountry

      public String getCountry()

    • setCountry

      public void setCountry(String country)

    • supportsSms

      public SmsPhoneNumber supportsSms(Boolean supportsSms)
      Set to true if this phone number has the capability to support SMS

    • getSupportsSms

      public Boolean getSupportsSms()

    • setSupportsSms

      public void setSupportsSms(Boolean supportsSms)

    • supportsMms

      public SmsPhoneNumber supportsMms(Boolean supportsMms)
      Set to true if this phone number has the capability to support MMS

    • getSupportsMms

      public Boolean getSupportsMms()

    • setSupportsMms

      public void setSupportsMms(Boolean supportsMms)

    • supportsVoice

      public SmsPhoneNumber supportsVoice(Boolean supportsVoice)
      Set to true if this phone number has the capability to support voice

    • getSupportsVoice

      public Boolean getSupportsVoice()

    • setSupportsVoice

      public void setSupportsVoice(Boolean supportsVoice)

    • integration

      public SmsPhoneNumber integration(DomainEntityRef integration)
      The Genesys Cloud integration this phone number belongs to.

    • getIntegration

      public DomainEntityRef getIntegration()

    • setIntegration

      public void setIntegration(DomainEntityRef integration)

    • compliance

      public SmsPhoneNumber compliance(Compliance compliance)
      Compliance configuration for short codes, including help, stop and opt in.

    • getCompliance

      public Compliance getCompliance()

    • setCompliance

      public void setCompliance(Compliance compliance)

    • supportedContent

      public SmsPhoneNumber supportedContent(SupportedContentReference supportedContent)
      Defines the media SupportedContent profile configured for an MMS capable phone number. If no custom profile is assigned, the phone number uses the system's \"SMS Default\" profile. The \"SMS Default\" profile allows all media types (*\\/\\*) for inbound messages and specific image types (image/gif, image/jpeg, image/png) for outbound messages. When the \"SMS Default\" profile is in use, this field will contain the profile name and media types, but will not have an 'id' or 'selfUri' field. To customize media filtering, assign a custom supported content profile using the PATCH endpoint.

    • getSupportedContent

      public SupportedContentReference getSupportedContent()

    • setSupportedContent

      public void setSupportedContent(SupportedContentReference supportedContent)

    • getSelfUri

      public String getSelfUri()

    • 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