The PhoneNumber object
A phone number of your organization: a caller ID for outbound calls and, for an owned number, a line whose inbound calls an assistant can answer.
Fields
idstringUnique ID of the phone number record (UUID): the {id} of PATCH and
DELETE /.phone-numbers/ {id} phone_numberstringThe phone number, in E.164 format.
Example
"+33199001234"labelstringnullableFree-text name you gave the number (e.g. 'Paris office'). Null when unset.
provider"twilio" | "telnyx" | "sip"Carrier the number is connected through.
"twilio"Connected through Twilio.
"telnyx"Connected through Telnyx.
"sip"Brought over your own SIP trunk.
The assistant that answers inbound calls to this number. Null when inbound calls are not routed to an assistant.
sourceenum (3 values)How the number came in.
"user_imported"You connected a number you own.
"revox_provisioned"Bought automatically by Revox with your subscription or a top-up. Deleting it also releases it.
"revox_purchased"Bought from the dashboard. Deleting it also releases it.
type"owned_number" | "verified_caller_id"What the number can be used for.
"owned_number"A number Revox can place and receive calls on.
"verified_caller_id"An outside number verified with Twilio, only shown as the caller ID of outbound calls. It cannot receive calls.
created_atstring (date-time)When the number was added (ISO 8601).
inbound_sip_uristringnullableFor a 'sip' number: the SIP URI to configure on your carrier or PBX so inbound calls reach Revox. Null for other providers.
The user who added the number. Null for numbers provisioned by Revox and for numbers added before this was tracked.
health_status"unknown" | "healthy" | "warning" | "burned"Spam reputation from the last check. A number is never taken out of service for its reputation.
"unknown"Never checked, or the check gave no usable signal. Not a sign the number is clean.
"healthy"Spam score under 60, and not flagged by Orange Téléphone.
"warning"Spam score from 60 to 70: worth watching, still used like any other number.
"burned"Spam score above 70, or flagged as spam by Orange Téléphone: used last in the outbound rotation.
spam_scorenumbernullableSpam score from 0 to 100 at the last check (HUHU's combined Hiya and Truecaller score), higher meaning more likely flagged as spam. A new number usually starts around 30; above 70 it is considered burned. Null when no check reported one.
health_checked_atstring (date-time)nullableWhen the reputation was last checked (ISO 8601). Null when never checked.
next_manual_check_atstring (date-time)nullableWhen
POST /can next be called for this number (ISO 8601): one manual check per number every 48 hours. Null when it can be called now.phone-numbers/ {id}/ reputation-check