Create Advanced Order

POST

advanced_orders

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const advancedOrder = await client.advancedOrders.create();

console.log(advancedOrder.id);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
advanced_order = client.advanced_orders.create()
print(advanced_order.id)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	advancedOrder, err := client.AdvancedOrders.New(context.TODO(), telnyx.AdvancedOrderNewParams{
		AdvancedOrder: telnyx.AdvancedOrderParam{},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", advancedOrder.ID)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.advancedorders.AdvancedOrder;
import com.telnyx.sdk.models.advancedorders.AdvancedOrderCreateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        AdvancedOrder params = AdvancedOrder.builder().build();
        AdvancedOrderCreateResponse advancedOrder = client.advancedOrders().create(params);
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $advancedOrder = $client->advancedOrders->create(
    areaCode: 'xxx',
    comments: 'comments',
    countryCode: 'xx',
    customerReference: 'customer_reference',
    features: ['sms'],
    phoneNumberType: 'local',
    quantity: 1,
    requirementGroupID: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
  );

  var_dump($advancedOrder);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request POST \
  --url https://api.telnyx.com/v2/advanced_orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "country_code": "US",
  "comments": "",
  "quantity": 1,
  "area_code": "",
  "phone_number_type": "local",
  "features": [],
  "customer_reference": "",
  "requirement_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
'

{
  "country_code": "US",
  "comments": "",
  "quantity": 1,
  "area_code": "",
  "phone_number_type": "",
  "features": [
    "sms"
  ],
  "customer_reference": "",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": [
    "pending"
  ],
  "orders": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "requirement_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "<string>"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10009",
      "title": "Authentication failed",
      "detail": "Could not understand the provided credentials.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10009"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "<string>"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "<string>"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "<string>"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

country_code

string

default:US

Required string length: 2

comments

string

default:""

Maximum string length: 255

quantity

integer

default:1

Required range: 1 <= x <= 10000

area_code

string

default:""

Maximum string length: 3

phone_number_type

enum<string>

default:local

Available options:

local,

mobile,

toll_free,

shared_cost,

national,

landline

features

enum<string>[]

Available options:

sms,

mms,

voice,

fax,

emergency

customer_reference

string

default:""

requirement_group_id

string<uuid>

The ID of the requirement group to associate with this advanced order

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Response

An Advanced Order Response

country_code

string

default:US

Required string length: 2

comments

string

default:""

Maximum string length: 255

quantity

integer

default:1

Required range: 1 <= x <= 10000

area_code

string

default:""

Maximum string length: 3

phone_number_type

enum<string>[]

Available options:

local,

mobile,

toll_free,

shared_cost,

national,

landline

features

enum<string>[]

Available options:

sms,

mms,

voice,

fax,

emergency

customer_reference

string

default:""

string<uuid>

status

enum<string>[]

Available options:

pending,

processing,

ordered

orders

string<uuid>[]

requirement_group_id

string<uuid>

The ID of the requirement group associated with this advanced order

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const advancedOrder = await client.advancedOrders.create();

console.log(advancedOrder.id);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
advanced_order = client.advanced_orders.create()
print(advanced_order.id)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	advancedOrder, err := client.AdvancedOrders.New(context.TODO(), telnyx.AdvancedOrderNewParams{
		AdvancedOrder: telnyx.AdvancedOrderParam{},
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", advancedOrder.ID)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.advancedorders.AdvancedOrder;
import com.telnyx.sdk.models.advancedorders.AdvancedOrderCreateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        AdvancedOrder params = AdvancedOrder.builder().build();
        AdvancedOrderCreateResponse advancedOrder = client.advancedOrders().create(params);
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $advancedOrder = $client->advancedOrders->create(
    areaCode: 'xxx',
    comments: 'comments',
    countryCode: 'xx',
    customerReference: 'customer_reference',
    features: ['sms'],
    phoneNumberType: 'local',
    quantity: 1,
    requirementGroupID: '3fa85f64-5717-4562-b3fc-2c963f66afa6',
  );

  var_dump($advancedOrder);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request POST \
  --url https://api.telnyx.com/v2/advanced_orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "country_code": "US",
  "comments": "",
  "quantity": 1,
  "area_code": "",
  "phone_number_type": "local",
  "features": [],
  "customer_reference": "",
  "requirement_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
'

{
  "country_code": "US",
  "comments": "",
  "quantity": 1,
  "area_code": "",
  "phone_number_type": "",
  "features": [
    "sms"
  ],
  "customer_reference": "",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": [
    "pending"
  ],
  "orders": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "requirement_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "<string>"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10009",
      "title": "Authentication failed",
      "detail": "Could not understand the provided credentials.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10009"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "<string>"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "<string>"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "<string>"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

Coverage

Searching

Ordering

Management & Configurations

For AI Agents

Create Advanced Order

Authorizations

Body

Response