Get number pool order status

GET

/api/v1/number-pools/{number_pool_id}/order-status

curl --request GET \
  --url https://external-api.moja-ai.com/api/v1/number-pools/example/order-status \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

• MojaApiKeyHeader
• MojaApiBearer

Parameters

Path Parameters

number_pool_id

required

Number Pool Id

string

Responses

200

Successful Response

Media typeapplication/json

NumberPoolOrderStatusResponse

object

number_pool_id

required

Number Pool Id

Unique identifier for the number pool

string

bandwidth_order_id

Any of:

string

string

null

null

provisioning_status

required

Provisioning Status

Overall pool provisioning status

string

provisioning_error

Any of:

string

string

null

null

summary

required

Summary

Summary counts

object

key

additional properties

integer

numbers

required

Numbers

Individual number statuses

Array<object>

NumberOrderStatusDetail

object

number_id

required

Number Id

Unique identifier for the number

string

phone_number

required

Phone Number

Phone number

string

order_status

required

Order Status

Order status (COMPLETE, FAILED, RECEIVED, PENDING)

string

error_description

Any of:

string

string

null

null

Example^generated

{
  "number_pool_id": "example",
  "bandwidth_order_id": "example",
  "provisioning_status": "example",
  "provisioning_error": "example",
  "summary": {
    "additionalProperty": 1
  },
  "numbers": [
    {
      "number_id": "example",
      "phone_number": "example",
      "order_status": "example",
      "error_description": "example"
    }
  ]
}

400

Bad Request

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

401

Unauthorized

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

404

Not Found

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

409

Conflict

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

429

Too Many Requests

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

500

Internal server error