Skip to content
Phone Numbers

Check a phone number's spam reputation now

POST/phone-numbers/{id}/reputation-check

Runs a spam-reputation check of the number right away and returns the number with its new health_status, spam_score and health_checked_at. Numbers that place calls are already checked automatically; use this for a number never checked, or after a drop in answer rate. Once per number every 48 hours: before that, 429 with the number's next_manual_check_at.

Path parameters

  • idstringrequired

    ID of the phone number record, as returned by GET /phone-numbers (not the phone number itself).

Request body

An empty object: send {} or no body at all.

Response

200
  • phone_numberPhoneNumber
    • idstring

      Unique ID of the phone number record (UUID): the {id} of PATCH and DELETE /phone-numbers/{id}.

    • phone_numberstring

      The phone number, in E.164 format.

      Example "+33199001234"

    • labelstringnullable

      Free-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.

    • inbound_assistantAssistantnullable

      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_uristringnullable

      For a 'sip' number: the SIP URI to configure on your carrier or PBX so inbound calls reach Revox. Null for other providers.

    • created_byOrgMembernullable

      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_scorenumbernullable

      Spam 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)nullable

      When the reputation was last checked (ISO 8601). Null when never checked.

    • next_manual_check_atstring (date-time)nullable

      When POST /phone-numbers/{id}/reputation-check can next be called for this number (ISO 8601): one manual check per number every 48 hours. Null when it can be called now.

Errors

  • 404Not found in your organization{ "message"?: string, "error"?: string, "bodyErrors"?: {…} }
  • 429Too many requests{ "error": string, "next_manual_check_at": string }
  • 502An upstream provider failed{ "message"?: string, "error"?: string, "bodyErrors"?: {…} }
  • 503HTTP 503{ "message"?: string, "error"?: string, "bodyErrors"?: {…} }

Error bodies carry an error (or message) string; a 400 adds bodyErrors.issues. See Errors.