Skip to main content

Create a number block order

POST 
/number_block_orders

Creates a phone number block order.

Request ​

Body

required

    starting_number e164_phone_numberrequired

    Starting phone number block

    range integerrequired

    The phone number range included in the block.

    connection_id string

    Identifies the connection associated with this phone number.

    messaging_profile_id string

    Identifies the messaging profile associated with the phone number.

    customer_reference string

    A customer reference string for customer look ups.

Responses ​

200: Successful response with details about a number block order.

Schema

    data

    NumberBlockOrder

    id uuid
    record_type string
    starting_number e164_phone_number

    Starting phone number block

    range integer

    The phone number range included in the block.

    phone_numbers_count integer

    The count of phone numbers in the number order.

    connection_id string

    Identifies the connection associated to all numbers in the phone number block.

    messaging_profile_id string

    Identifies the messaging profile associated to all numbers in the phone number block.

    status string

    Possible values: [pending, success, failure]

    The status of the order.

    customer_reference string

    A customer reference string for customer look ups.

    created_at datetime

    An ISO 8901 datetime string denoting when the number order was created.

    updated_at datetime

    An ISO 8901 datetime string for when the number order was updated.

    requirements_met boolean

    True if all requirements are met for every phone number, false otherwise.

default: Unexpected error

Schema

    errors

    Error[]

  • Array [

    • code integerrequired
    title stringrequired
    detail string

    source

    object

    pointer json-pointer

    JSON pointer (RFC6901) to the offending entity.

    parameter string

    Indicates which query parameter caused the error.

    meta

    object

    url string

    URL with additional information on the error.

  • ]

Callbacks ​

Request samples

curl -L 'https://api.telnyx.com/v2/number_block_orders' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "starting_number": "+19705555000",
  "range": 10
}'

Response samples

{
  "data": {
    "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    "starting_number": "+19705555000",
    "range": 10,
    "record_type": "number_block_order",
    "connection_id": "346789098765567",
    "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
    "phone_numbers_count": 10,
    "status": "pending",
    "customer_reference": "MY REF 001",
    "created_at": "2018-01-01T00:00:00.000000Z",
    "updated_at": "2018-01-01T00:00:00.000000Z",
    "requirements_met": true
  }
}