Interface ActiveNumber
public interface ActiveNumber
The phone number that has been rented by a customer and assigned to a project.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ActiveNumber.Builder
builder()
Getting builderThe active number's callback URL to be called for provisioning / deprovisioning updatesThe capability of the number.User supplied name for the phone number.The timestamp when the subscription will expire if an expiration date has been set.getMoney()
Get moneyThe date of the next charge.How often the recurring price is charged in months.The phone number in The phone number in E.164 format with leading+
.Project ID.ISO 3166-1 alpha-2 country code of the phone number.Get smsConfigurationgetType()
Get typeGet voiceConfiguration
-
Method Details
-
getPhoneNumber
String getPhoneNumber()The phone number in The phone number in E.164 format with leading+
.- Returns:
- phoneNumber
-
getProjectId
String getProjectId()Project ID. Your project ID can be Found on your Sinch Customer Dashboard.- Returns:
- projectId
-
getDisplayName
String getDisplayName()User supplied name for the phone number.- Returns:
- displayName
-
getRegionCode
String getRegionCode()ISO 3166-1 alpha-2 country code of the phone number. ExampleUS
,GB
orSE
.- Returns:
- regionCode
- Read Only
- This field is returned by the server and cannot be modified
-
getType
NumberType getType()Get type- Returns:
- type
-
getCapability
List<Capability> getCapability()The capability of the number.- Returns:
- capability
-
getMoney
Money getMoney()Get money- Returns:
- money
-
getPaymentIntervalMonths
Integer getPaymentIntervalMonths()How often the recurring price is charged in months.- Returns:
- paymentIntervalMonths
- Read Only
- This field is returned by the server and cannot be modified
-
getNextChargeDate
Instant getNextChargeDate()The date of the next charge.- Returns:
- nextChargeDate
- Read Only
- This field is returned by the server and cannot be modified
-
getExpireAt
Instant getExpireAt()The timestamp when the subscription will expire if an expiration date has been set.- Returns:
- expireAt
- Read Only
- This field is returned by the server and cannot be modified
-
getSmsConfiguration
SmsConfiguration getSmsConfiguration()Get smsConfiguration- Returns:
- smsConfiguration
-
getVoiceConfiguration
VoiceConfiguration getVoiceConfiguration()Get voiceConfiguration- Returns:
- voiceConfiguration
-
getCallbackUrl
String getCallbackUrl()The active number's callback URL to be called for provisioning / deprovisioning updates- Returns:
- callbackUrl
-
builder
Getting builder- Returns:
- New Builder instance
-