Path parameters

• RequestId string Required

  The SID of the bulk eligibility check that you want to know about.

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^EC[0-9a-fA-F]{32}$.

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 attributes Show response attributes object

  • request_id string | null

    The SID of the bulk eligibility check that you want to know about.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^EC[0-9a-fA-F]{32}$.

  • url string(uri) | null

    This is the url of the request that you're trying to reach out to locate the resource.

  • results array | null

    The result set that contains the eligibility check response for each 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, 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.

  • friendly_name string | null

    This is the string that you assigned as a friendly name for describing the eligibility check request.

  • status string | null

    This is the status of the bulk eligibility check request. (Example: COMPLETE, IN_PROGRESS)

  • date_created string(date-time) | null
  • date_completed string(date-time) | null