Skip to main content

Create a number reservation

POST 
/number_reservations

Creates a Phone Number Reservation for multiple numbers.

Request​

Body

required

    phone_numbers

    ReservedPhoneNumber[]

  • Array [

    • phone_number e164_phone_number

  • ]

    • customer_reference string

    A customer reference string for customer look ups.

Responses​

200: Successful response with details about a number reservation.

Schema

    data

    NumberReservation

    id uuid
    record_type string

    phone_numbers

    ReservedPhoneNumber[]

  • Array [

    • id uuid
    record_type string
    phone_number e164_phone_number
    status string

    Possible values: [pending, success, failure]

    The status of the phone number's reservation.

    created_at datetime

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

    updated_at datetime

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

    expired_at datetime

    An ISO 8901 datetime string for when the individual number reservation is going to expire

  • ]

    • status string

    Possible values: [pending, success, failure]

    The status of the entire reservation.

    customer_reference string

    A customer reference string for customer look ups.

    created_at datetime

    An ISO 8901 datetime string denoting when the numbers reservation was created.

    updated_at datetime

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

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.

  • ]

Loading...