Buy a number

POST

/api/v1/numbers/buy

curl --request POST \
  --url https://external-api.moja-ai.com/api/v1/numbers/buy \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "prefix": "919", "quantity": 1, "toll_free": false, "imported": false, "imported_replaced_number": "example" }'

Buy one or more numbers through the configured phone-number provider (max 10 per order). Provide prefix for a local area code or toll-free NPA; set toll_free=true for toll-free (defaults to 800 if prefix omitted). Use quantity for multiple numbers in one order. The response includes purchased numbers under numbers (and number when quantity is 1).

Authorizations

• MojaApiKeyHeader
• MojaApiBearer

Parameters

Header Parameters

X-API-Key

Any of:

string

string

null

null

Request Body^required

Media typeapplication/json

NumberBuyRequest

object

prefix

Any of:

string

string

<= 10 characters

null

null

quantity

Quantity

How many numbers to purchase in this order (1–10).

integer

default: 1 >= 1 <= 10

toll_free

Toll Free

When true, order toll-free numbers. If prefix is omitted, uses 800. If prefix is set, it must be a toll-free NPA (800, 888, 877, 866, 855, 844, 833).

boolean

imported

Imported

Internal migration flag indicating this purchased Moja number maps to a number imported from another platform.

boolean

imported_replaced_number

Any of:

string

string

<= 255 characters

null

null

Responses

200

Successful Response

Media typeapplication/json

Example^generated

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