Check RCS reachability
Checks whether a phone number can receive RCS messages from your RCS sender, without sending anything. Call it before an RCS send to choose between RCS and SMS for that contact.
curl --request GET \
--url https://api.vobiz.ai/api/v1/sms/messages/rcs-reachability \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
client.sms.messages.check_rcs_reachability(
from_="YOUR_RCS_SENDER_NAME",
to="+14155550123",
)
const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/messages/rcs-reachability', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"to": "+14155550123",
"reachable": true,
"carrier": "Example Mobile",
"capability": "reachable"
}{
"error": "recipient has opted out: +14155550123"
}{
"error": "missing or invalid credentials"
}{
"error": "internal error"
}Authorizations
Your Vobiz account Auth ID (MA_XXXXXXXX).
Your Vobiz account Auth Token.
Query Parameters
Required. The senderName of your RCS sender, as returned by GET /senders.
Required. The recipient number to check, in E.164 format, for example +14155550123.
Response
Reachability result.
Whether a phone number can receive RCS messages from your RCS sender.
The phone number that was checked, in E.164 format.
"+14155550123"
true when the number can receive RCS from your sender. When false, send as SMS or set failoverToSms on an RCS send.
Name of the recipient's mobile carrier. Omitted when it is not known.
Capability label returned with the result, for example reachable. Base your decision on reachable.
Was this page helpful?
curl --request GET \
--url https://api.vobiz.ai/api/v1/sms/messages/rcs-reachability \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
client.sms.messages.check_rcs_reachability(
from_="YOUR_RCS_SENDER_NAME",
to="+14155550123",
)
const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/messages/rcs-reachability', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"to": "+14155550123",
"reachable": true,
"carrier": "Example Mobile",
"capability": "reachable"
}{
"error": "recipient has opted out: +14155550123"
}{
"error": "missing or invalid credentials"
}{
"error": "internal error"
}