CreateHostedNumberOrderRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/twilio/main/json-schema/twilio-create-hosted-number-order-request-schema.json",
  "title": "CreateHostedNumberOrderRequest",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/twilio-hostednumber-api-openapi.yml#/components/schemas/CreateHostedNumberOrderRequest",
  "type": "object",
  "required": [
    "PhoneNumber",
    "ContactPhoneNumber",
    "AddressSid",
    "Email"
  ],
  "properties": {
    "PhoneNumber": {
      "type": "string",
      "format": "phone-number",
      "description": "The number to host in [+E.164](https://en.wikipedia.org/wiki/E.164) format"
    },
    "ContactPhoneNumber": {
      "type": "string",
      "format": "phone-number",
      "description": "The contact phone number of the person authorized to sign the Authorization Document."
    },
    "AddressSid": {
      "type": "string",
      "minLength": 34,
      "maxLength": 34,
      "pattern": "^AD[0-9a-fA-F]{32}$",
      "description": "Optional. A 34 character string that uniquely identifies the Address resource that represents the address of the owner of this phone number."
    },
    "Email": {
      "type": "string",
      "description": "Optional. Email of the owner of this phone number that is being hosted."
    },
    "AccountSid": {
      "type": "string",
      "minLength": 34,
      "maxLength": 34,
      "pattern": "^AC[0-9a-fA-F]{32}$",
      "description": "This defaults to the AccountSid of the authorization the user is using. This can be provided to specify a subaccount to add the HostedNumberOrder to."
    },
    "FriendlyName": {
      "type": "string",
      "description": "A 128 character string that is a human readable text that describes this resource."
    },
    "CcEmails": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Optional. A list of emails that the LOA document for this HostedNumberOrder will be carbon copied to."
    },
    "SmsUrl": {
      "type": "string",
      "format": "uri",
      "description": "The URL that Twilio should request when somebody sends an SMS to the phone number. This will be copied onto the IncomingPhoneNumber resource."
    },
    "SmsMethod": {
      "type": "string",
      "format": "http-method",
      "enum": [
        "HEAD",
        "GET",
        "POST",
        "PATCH",
        "PUT",
        "DELETE"
      ],
      "description": "The HTTP method that should be used to request the SmsUrl. Must be either `GET` or `POST`.  This will be copied onto the IncomingPhoneNumber resource."
    },
    "SmsFallbackUrl": {
      "type": "string",
      "format": "uri",
      "description": "A URL that Twilio will request if an error occurs requesting or executing the TwiML defined by SmsUrl. This will be copied onto the IncomingPhoneNumber resource."
    },
    "SmsCapability": {
      "type": "boolean",
      "description": "Used to specify that the SMS capability will be hosted on Twilio's platform."
    },
    "SmsFallbackMethod": {
      "type": "string",
      "format": "http-method",
      "enum": [
        "HEAD",
        "GET",
        "POST",
        "PATCH",
        "PUT",
        "DELETE"
      ],
      "description": "The HTTP method that should be used to request the SmsFallbackUrl. Must be either `GET` or `POST`. This will be copied onto the IncomingPhoneNumber resource."
    },
    "StatusCallbackUrl": {
      "type": "string",
      "format": "uri",
      "description": "Optional. The Status Callback URL attached to the IncomingPhoneNumber resource."
    },
    "StatusCallbackMethod": {
      "type": "string",
      "format": "http-method",
      "enum": [
        "HEAD",
        "GET",
        "POST",
        "PATCH",
        "PUT",
        "DELETE"
      ],
      "description": "Optional. The Status Callback Method attached to the IncomingPhoneNumber resource."
    },
    "SmsApplicationSid": {
      "type": "string",
      "minLength": 34,
      "maxLength": 34,
      "pattern": "^AP[0-9a-fA-F]{32}$",
      "description": "Optional. The 34 character sid of the application Twilio should use to handle SMS messages sent to this number. If a `SmsApplicationSid` is present, Twilio will ignore all of the SMS urls above and use those set on the application."
    },
    "ContactTitle": {
      "type": "string",
      "description": "The title of the person authorized to sign the Authorization Document for this phone number."
    }
  }
}