Skip to main content

Check eligibility of phone numbers for hosted messaging

POST 
/messaging_hosted_number_orders/eligibility_numbers_check

Check eligibility of phone numbers for hosted messaging

Request ​

Body

required

Phone numbers to check eligibility

    phone_numbers +E.164[]required

    List of phone numbers to check eligibility

Responses ​

200: Successful response

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.

400: Bad request

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

401: Unauthorized

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

Request samples

curl -L 'https://api.telnyx.com/v2/messaging_hosted_number_orders/eligibility_numbers_check' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "phone_numbers": [
    "string"
  ]
}'

Response samples

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