Check eligibility of phone numbers for hosted messaging

GET 
/messaging_hosted_number_orders/eligibility_numbers_check

Check eligibility of phone numbers for hosted messaging

Query Parameters

phone_numbers stringrequired

Comma-separated list of phone numbers to check eligibility

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

phone_numbers

object[]

List of phone numbers with their eligibility status.

Array [

detail string

Detailed information about the eligibility status.

phone_number string

The phone number in e164 format.

eligible boolean

Whether the phone number is eligible for hosted messaging.

eligible_status string

Possible values: [NUMBER_CAN_NOT_BE_REPEATED, NUMBER_CAN_NOT_BE_VALIDATED, NUMBER_CAN_NOT_BE_WIRELESS, NUMBER_CAN_NOT_BE_ACTIVE_IN_YOUR_ACCOUNT, NUMBER_CAN_NOT_HOSTED_WITH_A_TELNYX_SUBSCRIBER, NUMBER_CAN_NOT_BE_IN_TELNYX, NUMBER_IS_NOT_A_US_NUMBER, NUMBER_IS_NOT_A_VALID_ROUTING_NUMBER, NUMBER_IS_NOT_IN_E164_FORMAT, BILLING_ACCOUNT_CHECK_FAILED, BILLING_ACCOUNT_IS_ABOLISHED, ELIGIBLE]

The eligibility status of the phone number.

]

List of phone numbers with their eligibility status.

{
  "phone_numbers": [
    {
      "detail": "string",
      "phone_number": "string",
      "eligible": true,
      "eligible_status": "NUMBER_CAN_NOT_BE_REPEATED"
    }
  ]
}

400: Bad request

application/json

• Schema
• Example (from schema)

Schema

code integerrequired
title stringrequired
detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

{
  "code": "string",
  "title": "string",
  "detail": "string",
  "source": {
    "pointer": "string",
    "parameter": "string"
  },
  "meta": {}
}

401: Unauthorized

application/json

• Schema
• Example (from schema)

Schema

code integerrequired
title stringrequired
detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

{
  "code": "string",
  "title": "string",
  "detail": "string",
  "source": {
    "pointer": "string",
    "parameter": "string"
  },
  "meta": {}
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/messaging_hosted_number_orders/eligibility_numbers_check' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• 400
• 401

---

{
  "phone_numbers": [
    {
      "detail": "string",
      "phone_number": "string",
      "eligible": true,
      "eligible_status": "NUMBER_CAN_NOT_BE_REPEATED"
    }
  ]
}

{
  "code": "string",
  "title": "string",
  "detail": "string",
  "source": {
    "pointer": "string",
    "parameter": "string"
  },
  "meta": {}
}

{
  "code": "string",
  "title": "string",
  "detail": "string",
  "source": {
    "pointer": "string",
    "parameter": "string"
  },
  "meta": {}
}