Validate hosted number codes

Validate the verification codes sent to the numbers of the hosted order. The verification codes must be created in the verification codes endpoint.

POST /messaging_hosted_number_orders/{id}/validation_codes

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.validateCodes('id', {
  verification_codes: [{ code: 'code', phone_number: 'phone_number' }],
});

console.log(response.data);

200

{
  "data": {
    "phone_numbers": [
      {
        "phone_number": "<string>",
        "status": "verified"
      }
    ],
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Order ID related to the validation codes.

Body

application/json

Message payload

verification_codes · object[] · required

Show child attributes

Response

200

application/json

Successful response with the phone numbers and their respective status of the validation codes.

data · object

Show child attributes