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.

application/json

• Schema
• Example (from schema)

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

{
  "data": [
    {
      "id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
      "record_type": "messaging_hosted_number_order",
      "messaging_profile_id": "dc8f39ac-953d-4520-b93b-786ae87db0da",
      "status": "pending",
      "phone_numbers": [
        {
          "record_type": "messaging_hosted_number",
          "id": "bf6307bd-884d-4c1f-b6ea-c62b8c495d3c",
          "phone_number": "+18665550001",
          "status": "pending"
        },
        {
          "record_type": "messaging_hosted_number",
          "id": "464bd54e-a328-4b11-a131-28e6793cb6f2",
          "phone_number": "+18665550002",
          "status": "pending"
        }
      ]
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

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

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Loading...