Host multiple phone numbers on Twilio's platform.

POST /v2/HostedNumber/Orders/Bulk

Host multiple phone numbers on Twilio's platform.

application/json

Body

object object

Responses

  • 202 application/json

    Accepted

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • bulk_hosting_sid string | null

      A 34 character string that uniquely identifies this BulkHostedNumberOrder.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BH[0-9a-fA-F]{32}$.

    • request_status string

      A string that shows the status of the current Bulk Hosting request, it can vary between these values: 'QUEUED','IN_PROGRESS','PROCESSED'

      Values are QUEUED, IN_PROGRESS, or PROCESSED.

    • friendly_name string | null

      A 128 character string that is a human-readable text that describes this resource.

    • notification_email string | null

      Email address used for send notifications about this Bulk hosted number request.

    • date_created string(date-time) | null

      The date this resource was created, given as GMT RFC 2822 format.

    • date_completed string(date-time) | null

      The date that this resource was completed, given as GMT RFC 2822 format.

    • url string(uri) | null

      The URL of this BulkHostedNumberOrder resource.

    • total_count integer

      The total count of phone numbers in this Bulk hosting request.

      Default value is 0.

    • results array | null

      Contains a list of all the individual hosting orders and their information, for this Bulk request. Each result object is grouped by its order status. To see a complete list of order status, please check 'https://www.twilio.com/docs/phone-numbers/hosted-numbers/hosted-numbers-api/hosted-number-order-resource#status-values'.

POST /v2/HostedNumber/Orders/Bulk
curl \
 --request POST 'https://numbers.twilio.com/v2/HostedNumber/Orders/Bulk' \
 --user "username:password" \
 --header "Content-Type: application/json"
Request examples
{}
Response examples (202)
{
  "url": "https://numbers.twilio.com/v2/HostedNumber/Orders/Bulk/BHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "results": [],
  "total_count": 4,
  "date_created": "2023-06-29T15:19:37Z",
  "friendly_name": "test",
  "date_completed": null,
  "request_status": "QUEUED",
  "bulk_hosting_sid": "BHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "notification_email": "test@twilio.com"
}