Get My Virtual Numbers
GET https://voice.8x8.com/api/v1/subaccounts/:subAccountId/numbers
The Number Health Service provides insights about the reachability/availability for the numbers assigned to your subaccount.
Request
Path Parameters
Possible values: >= 3 characters and <= 50 characters, Value must match regular expression ^[A-Za-z0-9\-._&]{3,50}$
You must replace {subAccountId} with the subaccountid that you want to use. By default this is generated once you have completed the voice onboarding.
Should the request be authenticated successfully and Virtual Numbers are assigned to your subaccount, the response will contain a list of Number objects with health details for the numbers.
The following is an example of successful response:
Schema
- Array [
- Active
- Expiring
- Inactive
- ]
The total number of assigned Virtual Numbers to your subaccount.
Date and Time of the last time a status update was made to any of the assigned Virtual Numbers
numbers object[]
Virtual Number in E.164 format
Date and Time the Virtual number has been assigned to the subaccount
Date and Time when any information for the Virtual Number has been changed
Two-letter country code of the Virtual Number
Number status:
Unique identifier for the number range the Virtual number belongs to
Reccuring monthly fee for the Virtual Number
Minute based inbound fee for calls made to the Virtual Number
Billing increment for inbound call duration . Applied to all inbound calls to the Virtual Number
Individual Virtual Number URI, to get the Number Health information for a single Virtual Number
Boolean check if Number Health services are enabled for this Virtual Number
numberHealth object
Last Virtual Number Health status
Date and Time of the last time a status update was made to this Virtual Number
{
"totalNumbers":0,
"lastUpdatedAt":"string",
"numbers":[
{
"msisdn":"string",
"dateCreated":"string",
"dateUpdated":"string",
"countryCode":"string",
"operationalStatus":"string",
"referenceId":"string",
"rentalPrice":0,
"incomingRate":0,
"billingUnit":0,
"uri":"string",
"numberHealthCheckEnabled":true,
"billingCurrency":"string",
"numberType":"string",
"numberHealth":{
"isHealthy":true,
"status":"string",
"lastCheckedTime":"string"
}
}
],
"statusCode":0,
"statusMessage":"string"
}
Source: https://developer.8x8.com/connect/reference/get-virtual-numbers · 8x8 CPaaS Developer Docs. Synced for support deflection.
0 Comments