Check hosted messaging eligibility

Checks whether the supplied phone numbers are eligible for hosted messaging before an order is created.

POST /messaging_hosted_number_orders/eligibility_numbers_check

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.messagingHostedNumberOrders.checkEligibility({
  phone_numbers: ['string'],
});

console.log(response.phone_numbers);

200

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Phone numbers to check eligibility

phone_numbers · string[] · required

List of phone numbers to check eligibility

Phone number to check eligibility

Response

200

application/json

Successful response

phone_numbers · object[]

List of phone numbers with their eligibility status.

Show child attributes