Skip to main content

Create a number order

POST 
/number_orders

Creates a phone number order.

Request​

Body

required

    phone_numbers

    PhoneNumber[]

  • Array [

    • phone_number e164_phone_number

    regulatory_requirements

    SubNumberOrderRegulatoryRequirementWithValue[]

  • Array [

    • requirement_id uuid

    Unique id for a requirement.

    field_value string

    The value of the requirement, this could be an id to a resource or a string value.

  • ]

  • ]

    • sub_number_order_ids string[]
    connection_id string

    Identifies the connection associated with this phone number.

    messaging_profile_id string

    Identifies the messaging profile associated with the phone number.

    billing_group_id string

    Identifies the billing group 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 order.

Schema

    data

    object

    id uuid
    record_type string
    phone_numbers_count integer

    The count of phone numbers in the number order.

    connection_id string

    Identifies the connection associated with this phone number.

    messaging_profile_id string

    Identifies the messaging profile associated with the phone number.

    billing_group_id string

    Identifies the messaging profile associated with the phone number.

    phone_numbers

    PhoneNumber[]

  • Array [

    • id uuid
    record_type string
    phone_number e164_phone_number

    regulatory_requirements

    SubNumberOrderRegulatoryRequirementWithValue[]

  • Array [

    • record_type string
    requirement_id uuid

    Unique id for a requirement.

    field_type string

    Possible values: [textual, datetime, address, document]

    field_value string

    The value of the requirement, this could be an id to a resource or a string value.

  • ]

    • requirements_met boolean

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

    requirements_status string

    Possible values: [pending, approved, cancelled, deleted, requirement-info-exception, requirement-info-pending, requirement-info-under-review]

    Status of document requirements (if applicable)

    status string

    Possible values: [pending, success, failure]

    The status of the phone number in the order.

    bundle_id uuid
    phone_number_type string

    Possible values: [local, mobile, national, shared_cost, toll_free]

    Phone number type

    country_code string

    Country code of the phone number

  • ]

    • sub_number_orders_ids string[]
    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​

Loading...