Check Virtual Number
GET https://voice.8x8.com/api/v1/subaccounts/:subAccountId/numbers/:number
Should the request be authenticated successfully and the specific number is assigned to your subaccount, the response will contain a Number object with health details for the given number.
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.
Possible values: >= 7 and <= 10, Value must match regular expression ^[0-9]{7,10}$
Should the request authenticated successfully and the Virtual Number is assigned to your subaccount, the response will contain a Number object with health information for that given number. The following is an example of successful response:
Schema
payload object
Reference Id associated with a Virtual Number. This reference will appear in the call handle and status
Virtual Number in E.164 format
Two-letter country code of the Virtual Number
{
"statusCode":0,
"statusMessage":"string",
"timestamp":"string",
"payload":{
"referenceId":"string",
"msisdn":"string",
"countryCode":"string"
}
}
In case that Virtual Number does not exist or can’t be found, the JSON response will contain a code and message value to explain what is wrong. The following is an example of bad response:
Schema
Time stamp of the call event
{
"statusCode":0,
"statusMessage":"string",
"timestamp":"string"
}
Source: https://developer.8x8.com/connect/reference/check-virtual-number · 8x8 CPaaS Developer Docs. Synced for support deflection.
0 Comments