Package com.vonage.client.numbers

Class UpdateNumberRequest

java.lang.Object
com.vonage.client.numbers.UpdateNumberRequest
All Implemented Interfaces:
QueryParamsRequest
public class UpdateNumberRequest extends Object
Defines properties for updating an existing owned number.

  • Constructor Details

    • UpdateNumberRequest

      @Deprecated public UpdateNumberRequest(String msisdn, String country)
      Deprecated.
      Use builder(String, String). This will be removed in the next major release.
      Deprecated constructor.
      Parameters:
      msisdn - The inbound virtual number to update.
      country - The two character country code in ISO 3166-1 alpha-2 format.

  • Method Details

    • getApplicationId

      public UUID getApplicationId()
      ID of the application that will handle inbound traffic to this number.
      Returns:
      The application ID, or null if unspecified.

    • getMoHttpUrl

      public String getMoHttpUrl()
      A URL-encoded URI to the webhook endpoint that handles inbound messages. Your webhook endpoint must be active before you make this request. Vonage makes a GET request to the endpoint and checks that it returns a 200 OK response. Set this parameter's value to an empty string to remove the webhook.
      Returns:
      The inbound message webhook URL as a string, or null if unspecified.

    • getMoSmppSysType

      public String getMoSmppSysType()
      The associated system type for your SMPP client.
      Returns:
      The SMPP system type as a string, or null if unspecified.

    • getVoiceCallbackType

      public UpdateNumberRequest.CallbackType getVoiceCallbackType()
      Specifies whether inbound voice calls on your number are forwarded to a SIP or a telephone number. If set, sip or tel are prioritized over the Voice capability in your Application.
      Returns:
      The voice callback type as an enum, or null if unspecified.

    • getVoiceCallbackValue

      public String getVoiceCallbackValue()
      The SIP URI or telephone number.
      Returns:
      The voice callback value as a string, or null if unspecified.

    • getVoiceStatusCallback

      public String getVoiceStatusCallback()
      The webhook URI for Vonage to send a request to when a call ends.
      Returns:
      The voice status callback URL as a string, or null if unspecified.

    • setMoHttpUrl

      @Deprecated public void setMoHttpUrl(String moHttpUrl)
      Deprecated.

    • setMoSmppSysType

      @Deprecated public void setMoSmppSysType(String moSmppSysType)
      Deprecated.

    • setVoiceCallbackType

      @Deprecated public void setVoiceCallbackType(UpdateNumberRequest.CallbackType voiceCallbackType)
      Deprecated.

    • setVoiceCallbackValue

      @Deprecated public void setVoiceCallbackValue(String voiceCallbackValue)
      Deprecated.

    • setVoiceStatusCallback

      @Deprecated public void setVoiceStatusCallback(String voiceStatusCallback)
      Deprecated.

    • getMessagesCallbackValue

      @Deprecated public String getMessagesCallbackValue()
      Deprecated.

    • setMessagesCallbackValue

      @Deprecated public void setMessagesCallbackValue(String messagesCallbackValue)
      Deprecated.

    • makeParams

      public Map<String,String> makeParams()
      Description copied from interface: QueryParamsRequest
      Internal method for serializing the fields of this class into query parameters. The Map should be mutable so that subclasses can add fields, otherwise the method or implementing class should be marked as final. Duplicate entries can be handled by mapping the key to a list of the entries.
      Specified by:
      makeParams in interface QueryParamsRequest
      Returns:
      The query parameters as unique key-value pairs.

    • builder

      public static UpdateNumberRequest.Builder builder(String msisdn, String country)
      Entrypoint for constructing an instance of this class.
      Parameters:
      msisdn - The inbound virtual number to update.
      country - The two character country code in ISO 3166-1 alpha-2 format.
      Returns:
      A new Builder.
      Since:
      8.10.0

    • getCountry

      public String getCountry()
      Two character country code in ISO 3166-1 alpha-2 format.
      Returns:
      The number's country code.

    • getMsisdn

      public String getMsisdn()
      Phone number in E.164 format.
      Returns:
      The MSISDN as a string.