Skip to main content

List messaging hosted number orders

GET 

/messaging_hosted_number_orders

List messaging hosted number orders

Request

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 20

    The size of the page

Responses

200: Successful response with a list of messaging hosted number orders.

Schema

    data

    object[]

  • Array [

  • record_type string

    Identifies the type of the resource.

    id uuid

    Resource unique identifier.

    messaging_profile_id stringnullable

    Automatically associate the number with this messaging profile ID when the order is complete.

    status string

    Possible values: [failed, pending, successful]

    phone_numbers

    object[]

  • Array [

  • record_type string
    id uuid

    Identifies the type of resource.

    phone_number +E.164

    The messaging hosted phone number (+E.164 format)

    status string

    Possible values: [deleted, failed, pending, successful]

  • ]

  • ]

  • meta

    object

    total_pages integer
    total_results integer
    page_number integer
    page_size integer

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
  • ]

Loading...