SMA coverage check
POST https://verify.8x8.com/api/v2/subaccounts/:subAccountId/sma/coverage
This method allows you to check if user's device is supported by Silent Mobile Authentication (SMA). Could be used to perform pre-check before initiating SMA verification as SMA only support devices using a mobile data connection and does not support all phone numbers.
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 signed up with a new account at https://connect.8x8.com.
Body
- This value designates the originated IP address of the active data session on client's device.
- This value is the destination phone number to check.
- The destination can be submitted in two different formats:
- Local: a phone number without the international dialing prefix for the country. NB: when submitting a request with a destination in local format, the country parameter should not be empty.
- International: when using a destination in international format, the destination should be submitted as follow: it should include the international dialing prefix for the country (ex:65 for Singapore). 8x8 API accepts destination phone number with a leading + sign or without. The leading 0 of the local phone number, coming after the international dialing prefix has to be removed.
- When using a local phone number (see above), the country parameter should not be left empty, it should contain the ISO Alpha-2 designating the country of origin of the destination phone number. 8x8 will then automatically adapt the destination for international routing by prepending the local phone number by with the international dialing prefix and removing any potential leading 0 from the local phone number.
- Without submitting this parameter for a local phone number, the 8x8 platform will not be able correctly process the phone number.
This value is mandatory.
123.123.123.123
This parameter is not mandatory.
+19876543210
This parameter is not mandatory.
Possible values: <= 2 characters
US
The response returned is the following:
Schema
The value indicates whether request could be supported by SMA.
{
"isAvailable":true
}
{
"isAvailable":true
}
Bad request error response
Schema
Error code
Error description
Unique id of error. You can use it as reference when sending enquiries to 8x8 support
Date and time of the error occurrence
{
"code":1001,
"message":"Provided subAccountId doesn't belong to your account",
"errorId":"91b106f0-c0da-4aba-a43a-7af9c5893a80",
"timestamp":"2025-12-18T10:31:19.4297387+00:00"
}
Request was not authenticated response
Schema
Error code
Error description
Unique id of error. You can use it as reference when sending enquiries to 8x8 support
Date and time of the error occurrence
{
"code":1001,
"message":"Provided subAccountId doesn't belong to your account",
"errorId":"91b106f0-c0da-4aba-a43a-7af9c5893a80",
"timestamp":"2025-12-18T10:31:19.4297387+00:00"
}
Internal server error
Schema
Error code
Error description
Unique id of error. You can use it as reference when sending enquiries to 8x8 support
Date and time of the error occurrence
{
"code":1001,
"message":"Provided subAccountId doesn't belong to your account",
"errorId":"91b106f0-c0da-4aba-a43a-7af9c5893a80",
"timestamp":"2025-12-18T10:31:19.4297387+00:00"
}
Source: https://developer.8x8.com/connect/reference/sma-coverage-check · 8x8 CPaaS Developer Docs. Synced for support deflection.
0 Comments