Skip to main content
GET
/
enterprises
/
{enterprise_id}
/
reputation
/
numbers
/
{phone_number}
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const number = await client.enterprises.reputation.numbers.retrieve('+16035551234', {
  enterprise_id: '6a09cdc3-8948-47f0-aa62-74ac943d6c58',
});

console.log(number.data);
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "phone_number": "+16035551234",
    "enterprise_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "reputation_data": {
      "spam_risk": "low",
      "spam_category": "<string>",
      "maturity_score": 50,
      "connection_score": 50,
      "engagement_score": 50,
      "sentiment_score": 50,
      "last_refreshed_at": "2023-11-07T05:31:56Z"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
enterprise_id
string<uuid>
required

Unique identifier of the enterprise (UUID)

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

​
phone_number
string
required

Phone number in E.164 format

Example:

"+16035551234"

Query Parameters

​
fresh
boolean
default:false

When true, fetches fresh reputation data (incurs API cost). When false, returns cached data.

Response

Phone number reputation data

​
data
object