Twilio - Numbers — HostedNumber

naftiko: 1.0.0-alpha2
info:
  label: Twilio - Numbers — HostedNumber
  description: 'Twilio - Numbers — HostedNumber. 10 operations. Lead operation: HostedNumber. Self-contained Naftiko capability
    covering one Twilio business surface.'
  tags:
  - Twilio
  - HostedNumber
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TWILIO_API_KEY: TWILIO_API_KEY
capability:
  consumes:
  - type: http
    namespace: numbers-hostednumber
    baseUri: https://numbers.twilio.com
    description: Twilio - Numbers — HostedNumber business capability. Self-contained, no shared references.
    resources:
    - name: v2-HostedNumber-AuthorizationDocuments
      path: /v2/HostedNumber/AuthorizationDocuments
      operations:
      - name: listauthorizationdocument
        method: GET
        description: Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Email
          in: query
          type: string
          description: Email that this AuthorizationDocument will be sent to for signing.
        - name: Status
          in: query
          type: string
          description: 'Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA,
            4. canceled, 5. failed. See the section entitled [Status Val'
        - name: PageSize
          in: query
          type: integer
          description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        - name: Page
          in: query
          type: integer
          description: The page index. This value is simply for client state.
        - name: PageToken
          in: query
          type: string
          description: The page token. This is provided by the API.
      - name: createauthorizationdocument
        method: POST
        description: Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's
          platform.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v2-HostedNumber-AuthorizationDocuments-Sid
      path: /v2/HostedNumber/AuthorizationDocuments/{Sid}
      operations:
      - name: fetchauthorizationdocument
        method: GET
        description: Fetch a specific AuthorizationDocument.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this AuthorizationDocument.
          required: true
      - name: deleteauthorizationdocument
        method: DELETE
        description: Cancel the AuthorizationDocument request.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this AuthorizationDocument.
          required: true
    - name: v2-HostedNumber-AuthorizationDocuments-SigningDocumentSid-DependentHostedNumberO
      path: /v2/HostedNumber/AuthorizationDocuments/{SigningDocumentSid}/DependentHostedNumberOrders
      operations:
      - name: listdependenthostednumberorder
        method: GET
        description: Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: SigningDocumentSid
          in: path
          type: string
          description: A 34 character string that uniquely identifies the LOA document associated with this HostedNumberOrder.
          required: true
        - name: Status
          in: query
          type: string
          description: 'Status of an instance resource. It can hold one of the values: 1. opened 2. signing, 3. signed LOA,
            4. canceled, 5. failed. See the section entitled [Status Val'
        - name: PhoneNumber
          in: query
          type: string
          description: An E164 formatted phone number hosted by this HostedNumberOrder.
        - name: IncomingPhoneNumberSid
          in: query
          type: string
          description: A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.
        - name: FriendlyName
          in: query
          type: string
          description: A human readable description of this resource, up to 128 characters.
        - name: PageSize
          in: query
          type: integer
          description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        - name: Page
          in: query
          type: integer
          description: The page index. This value is simply for client state.
        - name: PageToken
          in: query
          type: string
          description: The page token. This is provided by the API.
    - name: v2-HostedNumber-Orders
      path: /v2/HostedNumber/Orders
      operations:
      - name: listhostednumberorder
        method: GET
        description: Retrieve a list of HostedNumberOrders belonging to the account initiating the request.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Status
          in: query
          type: string
          description: The Status of this HostedNumberOrder. One of `received`, `pending-verification`, `verified`, `pending-loa`,
            `carrier-processing`, `testing`, `completed`, `faile
        - name: SmsCapability
          in: query
          type: boolean
          description: Whether the SMS capability will be hosted on our platform. Can be `true` of `false`.
        - name: PhoneNumber
          in: query
          type: string
          description: An E164 formatted phone number hosted by this HostedNumberOrder.
        - name: IncomingPhoneNumberSid
          in: query
          type: string
          description: A 34 character string that uniquely identifies the IncomingPhoneNumber resource created by this HostedNumberOrder.
        - name: FriendlyName
          in: query
          type: string
          description: A human readable description of this resource, up to 128 characters.
        - name: PageSize
          in: query
          type: integer
          description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        - name: Page
          in: query
          type: integer
          description: The page index. This value is simply for client state.
        - name: PageToken
          in: query
          type: string
          description: The page token. This is provided by the API.
      - name: createhostednumberorder
        method: POST
        description: Host a phone number's capability on Twilio's platform.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: v2-HostedNumber-Orders-Bulk-BulkHostingSid
      path: /v2/HostedNumber/Orders/Bulk/{BulkHostingSid}
      operations:
      - name: fetchbulkhostednumberorder
        method: GET
        description: Fetch a specific BulkHostedNumberOrder.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: BulkHostingSid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this BulkHostedNumberOrder.
          required: true
        - name: OrderStatus
          in: query
          type: string
          description: Order status can be used for filtering on Hosted Number Order status values. To see a complete list
            of order statuses, please check 'https://www.twilio.com/docs
    - name: v2-HostedNumber-Orders-Sid
      path: /v2/HostedNumber/Orders/{Sid}
      operations:
      - name: fetchhostednumberorder
        method: GET
        description: Fetch a specific HostedNumberOrder.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this HostedNumberOrder.
          required: true
      - name: deletehostednumberorder
        method: DELETE
        description: Cancel the HostedNumberOrder (only available when the status is in `received`).
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Sid
          in: path
          type: string
          description: A 34 character string that uniquely identifies this HostedNumberOrder.
          required: true
    authentication:
      type: basic
      username: '{{env.TWILIO_USER}}'
      password: '{{env.TWILIO_PASS}}'
  exposes:
  - type: rest
    namespace: numbers-hostednumber-rest
    port: 8080
    description: REST adapter for Twilio - Numbers — HostedNumber. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v2/hostednumber/authorizationdocuments
      name: v2-hostednumber-authorizationdocuments
      description: REST surface for v2-HostedNumber-AuthorizationDocuments.
      operations:
      - method: GET
        name: listauthorizationdocument
        description: Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.
        call: numbers-hostednumber.listauthorizationdocument
        with:
          Email: rest.Email
          Status: rest.Status
          PageSize: rest.PageSize
          Page: rest.Page
          PageToken: rest.PageToken
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createauthorizationdocument
        description: Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's
          platform.
        call: numbers-hostednumber.createauthorizationdocument
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/hostednumber/authorizationdocuments/{sid}
      name: v2-hostednumber-authorizationdocuments-sid
      description: REST surface for v2-HostedNumber-AuthorizationDocuments-Sid.
      operations:
      - method: GET
        name: fetchauthorizationdocument
        description: Fetch a specific AuthorizationDocument.
        call: numbers-hostednumber.fetchauthorizationdocument
        with:
          Sid: rest.Sid
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteauthorizationdocument
        description: Cancel the AuthorizationDocument request.
        call: numbers-hostednumber.deleteauthorizationdocument
        with:
          Sid: rest.Sid
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/hostednumber/authorizationdocuments/{signingdocumentsid}/dependenthostednumberorders
      name: v2-hostednumber-authorizationdocuments-signingdocumentsid-dependenthostednumbero
      description: REST surface for v2-HostedNumber-AuthorizationDocuments-SigningDocumentSid-DependentHostedNumberO.
      operations:
      - method: GET
        name: listdependenthostednumberorder
        description: Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.
        call: numbers-hostednumber.listdependenthostednumberorder
        with:
          SigningDocumentSid: rest.SigningDocumentSid
          Status: rest.Status
          PhoneNumber: rest.PhoneNumber
          IncomingPhoneNumberSid: rest.IncomingPhoneNumberSid
          FriendlyName: rest.FriendlyName
          PageSize: rest.PageSize
          Page: rest.Page
          PageToken: rest.PageToken
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/hostednumber/orders
      name: v2-hostednumber-orders
      description: REST surface for v2-HostedNumber-Orders.
      operations:
      - method: GET
        name: listhostednumberorder
        description: Retrieve a list of HostedNumberOrders belonging to the account initiating the request.
        call: numbers-hostednumber.listhostednumberorder
        with:
          Status: rest.Status
          SmsCapability: rest.SmsCapability
          PhoneNumber: rest.PhoneNumber
          IncomingPhoneNumberSid: rest.IncomingPhoneNumberSid
          FriendlyName: rest.FriendlyName
          PageSize: rest.PageSize
          Page: rest.Page
          PageToken: rest.PageToken
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createhostednumberorder
        description: Host a phone number's capability on Twilio's platform.
        call: numbers-hostednumber.createhostednumberorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/hostednumber/orders/bulk/{bulkhostingsid}
      name: v2-hostednumber-orders-bulk-bulkhostingsid
      description: REST surface for v2-HostedNumber-Orders-Bulk-BulkHostingSid.
      operations:
      - method: GET
        name: fetchbulkhostednumberorder
        description: Fetch a specific BulkHostedNumberOrder.
        call: numbers-hostednumber.fetchbulkhostednumberorder
        with:
          BulkHostingSid: rest.BulkHostingSid
          OrderStatus: rest.OrderStatus
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/hostednumber/orders/{sid}
      name: v2-hostednumber-orders-sid
      description: REST surface for v2-HostedNumber-Orders-Sid.
      operations:
      - method: GET
        name: fetchhostednumberorder
        description: Fetch a specific HostedNumberOrder.
        call: numbers-hostednumber.fetchhostednumberorder
        with:
          Sid: rest.Sid
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletehostednumberorder
        description: Cancel the HostedNumberOrder (only available when the status is in `received`).
        call: numbers-hostednumber.deletehostednumberorder
        with:
          Sid: rest.Sid
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: numbers-hostednumber-mcp
    port: 9090
    transport: http
    description: MCP adapter for Twilio - Numbers — HostedNumber. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: retrieve-list-authorizationdocuments-belonging-account
      description: Retrieve a list of AuthorizationDocuments belonging to the account initiating the request.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: numbers-hostednumber.listauthorizationdocument
      with:
        Email: tools.Email
        Status: tools.Status
        PageSize: tools.PageSize
        Page: tools.Page
        PageToken: tools.PageToken
      outputParameters:
      - type: object
        mapping: $.
    - name: create-authorizationdocument-authorizing-hosting-phone
      description: Create an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: numbers-hostednumber.createauthorizationdocument
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fetch-specific-authorizationdocument
      description: Fetch a specific AuthorizationDocument.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: numbers-hostednumber.fetchauthorizationdocument
      with:
        Sid: tools.Sid
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-authorizationdocument-request
      description: Cancel the AuthorizationDocument request.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: numbers-hostednumber.deleteauthorizationdocument
      with:
        Sid: tools.Sid
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-list-dependent-hostednumberorders-belonging
      description: Retrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: numbers-hostednumber.listdependenthostednumberorder
      with:
        SigningDocumentSid: tools.SigningDocumentSid
        Status: tools.Status
        PhoneNumber: tools.PhoneNumber
        IncomingPhoneNumberSid: tools.IncomingPhoneNumberSid
        FriendlyName: tools.FriendlyName
        PageSize: tools.PageSize
        Page: tools.Page
        PageToken: tools.PageToken
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-list-hostednumberorders-belonging-account
      description: Retrieve a list of HostedNumberOrders belonging to the account initiating the request.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: numbers-hostednumber.listhostednumberorder
      with:
        Status: tools.Status
        SmsCapability: tools.SmsCapability
        PhoneNumber: tools.PhoneNumber
        IncomingPhoneNumberSid: tools.IncomingPhoneNumberSid
        FriendlyName: tools.FriendlyName
        PageSize: tools.PageSize
        Page: tools.Page
        PageToken: tools.PageToken
      outputParameters:
      - type: object
        mapping: $.
    - name: host-phone-number-s-capability-twilio-s
      description: Host a phone number's capability on Twilio's platform.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: numbers-hostednumber.createhostednumberorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: fetch-specific-bulkhostednumberorder
      description: Fetch a specific BulkHostedNumberOrder.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: numbers-hostednumber.fetchbulkhostednumberorder
      with:
        BulkHostingSid: tools.BulkHostingSid
        OrderStatus: tools.OrderStatus
      outputParameters:
      - type: object
        mapping: $.
    - name: fetch-specific-hostednumberorder
      description: Fetch a specific HostedNumberOrder.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: numbers-hostednumber.fetchhostednumberorder
      with:
        Sid: tools.Sid
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-hostednumberorder-only-available-when
      description: Cancel the HostedNumberOrder (only available when the status is in `received`).
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: numbers-hostednumber.deletehostednumberorder
      with:
        Sid: tools.Sid
      outputParameters:
      - type: object
        mapping: $.