Upload file required for a messaging hosted number order

POST 
/messaging_hosted_number_orders/:id/actions/file_upload

Upload file required for a messaging hosted number order

Path Parameters

id stringrequired

Identifies the type of resource.

multipart/form-data

Body

Message payload

loa binary

Must be a signed LOA for the numbers in the order in PDF format.

bill binary

Must be the last month's bill with proof of ownership of all of the numbers in the order in PDF format.

200: Successful response with details about a messaging hosted number order.

application/json

• Schema
• Example (from schema)

Schema

data

object

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]

]

{
  "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"
      }
    ]
  }
}

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": {}
    }
  ]
}

Request samples

• cURL

---

curl -L -X POST 'https://api.telnyx.com/v2/messaging_hosted_number_orders/:id/actions/file_upload' \
-H 'Content-Type: multipart/form-data' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "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"
      }
    ]
  }
}

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