Create a number pool

POST

/api/v1/number-pools

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://external-api.moja-ai.com/api/v1/number-pools"),
    Headers =
    {
        { "X-API-Key", "<X-API-Key>" },
    },
    Content = new StringContent("{ \"name\": \"example\", \"country\": \"US\", \"closed_browser_delay\": 1, \"browser_idle_limit\": 5, \"size\": 1, \"number_type\": \"local\", \"prefix\": \"example\", \"city\": \"example\", \"state\": \"example\", \"zip\": \"example\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://external-api.moja-ai.com/api/v1/number-pools"

  payload := strings.NewReader("{ \"name\": \"example\", \"country\": \"US\", \"closed_browser_delay\": 1, \"browser_idle_limit\": 5, \"size\": 1, \"number_type\": \"local\", \"prefix\": \"example\", \"city\": \"example\", \"state\": \"example\", \"zip\": \"example\" }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("X-API-Key", "<X-API-Key>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://external-api.moja-ai.com/api/v1/number-pools';
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'},
  body: '{"name":"example","country":"US","closed_browser_delay":1,"browser_idle_limit":5,"size":1,"number_type":"local","prefix":"example","city":"example","state":"example","zip":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://external-api.moja-ai.com/api/v1/number-pools \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "name": "example", "country": "US", "closed_browser_delay": 1, "browser_idle_limit": 5, "size": 1, "number_type": "local", "prefix": "example", "city": "example", "state": "example", "zip": "example" }'

Authorizations

MojaApiKeyHeader
MojaApiBearer

Request Body^required

application/json

NumberPoolCreateRequest

object

name

required

Name

Name of the number pool

string

>= 3 characters <= 255 characters

country

required

Country

Country for the number pool

string

Allowed values: US

closed_browser_delay

Any of:

number
null

number

>= 0.5 <= 1440

browser_idle_limit

Any of:

number
null

number

>= 1 <= 2880

size

required

Size

Number of phone numbers to allocate to this number pool

integer

>= 1 <= 10000

number_type

required

NumberType

Type of numbers (toll_free or local)

string

Allowed values: local toll_free

prefix

Any of:

string
null

string

>= 3 characters <= 10 characters

city

Any of:

string
null

string

>= 1 characters <= 100 characters

state

Any of:

string
null

string

>= 2 characters <= 2 characters

zip

Any of:

string
null

string

/^\d{5}$/

Responses

200

Successful Response

application/json

NumberPoolResponse

object

number_pool_id

required

Number Pool Id

Unique identifier for the number pool

string

org_id

required

Org Id

Unique identifier for the organization

string

name

required

Name

Name of the number pool

string

country

required

Country

Country for the number pool

string

Allowed values: US

closed_browser_delay

required

Closed Browser Delay

Delay in minutes before releasing number after browser close

number

browser_idle_limit

required

Browser Idle Limit

Delay in minutes before releasing number after browser idle

number

size

required

Size

Number of phone numbers to allocate to this number pool

integer

number_type

required

NumberType

Type of numbers (toll_free or local)

string

Allowed values: local toll_free

prefix

Any of:

string
null

string

city

Any of:

string
null

string

state

Any of:

string
null

string

zip

Any of:

string
null

string

is_active

required

Is Active

Whether the number pool is active

boolean

provisioning_status

Provisioning Status

Overall pool provisioning status

string

default: complete

has_pending_orders

Has Pending Orders

Whether pool has pending expansion orders

boolean

provisioning_error

Any of:

string
null

string

created_at

required

Created At

Time when the number pool was created

string format: date-time

updated_at

required

Updated At

Time when the number pool was last updated

string format: date-time

deleted_at

Any of:

string
null

string format: date-time

statistics

Any of:

NumberPoolStatisticsResponse
null

NumberPoolStatisticsResponse

object

total_numbers

required

Total Numbers

Total number of numbers in the number pool

integer

allocated_numbers

required

Allocated Numbers

Number of allocated numbers in the number pool

integer

available_numbers

required

Available Numbers

Number of available numbers in the number pool

integer

impressions_per_day

required

Impressions Per Day

Number of impressions per day

integer

misses_per_day

required

Misses Per Day

Number of misses per day

integer

impressions_per_month

required

Impressions Per Month

Number of impressions per month

integer

misses_per_month

required

Misses Per Month

Number of misses per month

integer

utilization_rate

required

Utilization Rate

Utilization rate of the number pool

number

numbers

Any of:

Array<object>
null

Array<object>

NumberPoolNumberResponse

object

required

Unique identifier for the entry in the number pool numbers table

integer

number_pool_id

required

Number Pool Id

Unique identifier for the number pool this number belongs to

string

number_id

required

Number Id

Unique identifier for the number

string

phone_number

required

Phone Number

Phone number

string

is_allocated

required

Is Allocated

Whether the number is allocated

boolean

allocated_to_snippet_id

Any of:

string
null

string

allocated_to_visitor_id

Any of:

string
null

string

allocated_at

Any of:

string
null

string format: date-time

expires_at

Any of:

string
null

string format: date-time

created_at

required

Created At

Time when the number was created

string format: date-time

Example

{
  "country": "US",
  "number_type": "local",
  "provisioning_status": "complete",
  "has_pending_orders": false
}

400

Bad Request

application/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

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

401

Unauthorized

application/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

application/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

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

409

Conflict

application/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

application/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

application/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

Create a number pool

Authorizations

Request Bodyrequired

Responses

200

Example

400

Examplegenerated

401

Examplegenerated

404

Examplegenerated

409

Examplegenerated

422

Examplegenerated

429

Examplegenerated

500

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated