Sign in
Hosted Numbers

Create a messaging hosted number order

Creates an order to enable Telnyx messaging on phone numbers whose voice service remains with another carrier.

post/messaging_hosted_number_orders

Request body

messaging_profile_idstring

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

phone_numbersstring[]

Phone numbers to be used for hosted messaging.

Example request

{
  "messaging_profile_id": "dc8f39ac-953d-4520-b93b-786ae87db0da",
  "phone_numbers": [
    "+18665550001",
    "+18665550002"
  ]
}

Response

Successful response with details about a messaging hosted number order.

Example response

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

Changes

Changed in 2 of the 61 revisions of this API.7

  • 1571b0380bd73See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 4XX

      response-body-type-changed

    • ▲

      the errors/items/ response's property type/format changed from object/ to / for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 4XX

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379944See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 4XX

      response-body-type-changed

    • ▲

      the errors/items/ response's property type/format changed from / to object/ for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 4XX

      response-property-type-changed

    • ▲

      the errors/items/source/pointer response's property type/format changed from string/json-pointer to string/ for status 4XX

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog