Create hosted number verification codes

Create verification codes to validate numbers of the hosted order. The verification codes will be sent to the numbers of the hosted order.

POST /messaging_hosted_number_orders/{id}/verification_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.createVerificationCodes('id', {
  phone_numbers: ['string'],
  verification_method: 'sms',
});

console.log(response.data);

200

{
  "data": [
    {
      "phone_number": "<string>",
      "verification_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "sms",
      "error": "<string>"
    }
  ]
}

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 to have a verification code created.

Body

application/json

Message payload

phone_numbers · string[] · required

verification_method · enum<string> · required

Available options: sms, call

Response

200

application/json

Verification codes created and sent to the phone numbers of the hosted order.

data · VerificationCodeResult · object[] · required

Show child attributes