Retrieve the messaging health of a 'TN'

GET 
/messaging/numbers/:tn/health

Retrieves health information about the requested phone number.

Request

Path Parameters

tn stringrequired

E.164 formatted phone number

Responses

200: Requested 'TN'

application/json

• Schema
• Example (from schema)

Schema

record_type string

Default value: number_health

Description of the record type

success boolean

If the request was successful

number string

+E.164 formatted phone number

number_type string

Number type

organization_id uuid

ID of organization that owns the phone number

message_count integer

Number of messages used to calculate the health ratios

inbound_outbound_ratio float

Ratio of inbound messages to outbound messages

success_ratio float

Ratio of outbound messages delivered to messages attempted

spam_ratio float

Ratio of outbound messages marked as Spam to messages attempted

available_products string[]

List of messaging products available for the number

{
  "record_type": "number_health",
  "success": true,
  "number": "+13129457420",
  "number_type": "long_code",
  "organization_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message_count": 39,
  "inbound_outbound_ratio": 0.8,
  "success_ratio": 0.95,
  "spam_ratio": 0.1,
  "available_products": [
    "A2P",
    "P2P"
  ]
}

Loading...