Retrieve the messaging health of a 'TN'

Retrieves health information about the requested phone number.

Request
path Parameters
tn
required
string

E.164 formatted phone number

Responses
200

Requested 'TN'

get/messaging/numbers/{tn}/health
Request samples 
Response samples 
application/json
{
  • "record_type": "number_health",
  • "success": true,
  • "number": "+13129457420",
  • "number_type": "long_code",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "message_count": 39,
  • "inbound_outbound_ratio": 0.8,
  • "success_ratio": 0.95,
  • "spam_ratio": 0.1,
  • "available_products": [
    ]
}