Create an eligibility check for a number that you want to host in Twilio.

POST /v1/HostedNumber/Eligibility
Account sid auth token

Create an eligibility check for a number that you want to host in Twilio.

application/json

Body

object object

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attribute Show response attribute object
    • results array | null

      The result set that contains the eligibility check response for the requested number, each result has at least the following attributes: phone_number: The requested phone number ,hosting_account_sid: The account sid where the phone number will be hosted, date_last_checked: Datetime (ISO 8601) when the PN was last checked for eligibility, country: Phone number’s country, eligibility_status: Indicates the eligibility status of the PN (Eligible/Ineligible), eligibility_sub_status: Indicates the sub status of the eligibility , ineligibility_reason: Reason for number's ineligibility (if applicable), next_step: Suggested next step in the hosting process based on the eligibility status.
POST /v1/HostedNumber/Eligibility 
curl \
 --request POST 'https://numbers.twilio.com/v1/HostedNumber/Eligibility' \
 --user "username:password" \
 --header "Content-Type: application/json"
Request examples 
{}
Response examples (200) 
{
  "results": [
    {
      "next_step": "CONTACT_SUPPORT_INELIGIBLE_INVENTORY_STATUS",
      "account_sid": "AC93b447ff5bd2abac37f1cbab2a871430",
      "phone_number": "+18778894546",
      "voice_provider": null,
      "inventory_status": "in-testing",
      "iso_country_code": "US",
      "hosting_order_sid": null,
      "phone_number_type": "TOLL_FREE",
      "eligibility_status": "INELIGIBLE",
      "messaging_provider": null,
      "hosting_order_status": null,
      "ineligibility_reason": "ALREADY_IN_TWILIO_BUT_NOT_IN_USE",
      "inventory_account_sid": "AC93b447ff5aa2abac37e3cbab2a871430",
      "eligibility_sub_status": "ALREADY_IN_TWILIO"
    },
    {
      "next_step": "EDIT_INELIGIBLE_NUMBER",
      "account_sid": null,
      "phone_number": "4565433456",
      "voice_provider": null,
      "inventory_status": null,
      "iso_country_code": null,
      "hosting_order_sid": null,
      "phone_number_type": null,
      "eligibility_status": "INELIGIBLE",
      "messaging_provider": null,
      "hosting_order_status": null,
      "ineligibility_reason": "NUMBER_FORMAT_INELIGIBLE",
      "inventory_account_sid": null,
      "eligibility_sub_status": "NUMBER_FORMAT_INELIGIBLE"
    }
  ]
}