import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const numberOrder = await client.numberOrders.update('number_order_id');
console.log(numberOrder.data);{
"data": {
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"record_type": "number_order",
"phone_numbers_count": 1,
"connection_id": "346789098765567",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
"billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",
"phone_numbers": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"record_type": "number_order_phone_number",
"phone_number": "+19705555098",
"bundle_id": "bc8e4d67-33a0-4cbb-af74-7b58f05bd474",
"regulatory_requirements": [
{
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"field_type": "address"
}
],
"requirements_met": true,
"status": "success"
}
],
"sub_number_orders_ids": [
"<string>"
],
"status": "pending",
"customer_reference": "MY REF 001",
"created_at": "2018-01-01T00:00:00.000000Z",
"updated_at": "2018-01-01T00:00:00.000000Z",
"requirements_met": true
}
}Updates a phone number order.
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: 'My API Key',
});
const numberOrder = await client.numberOrders.update('number_order_id');
console.log(numberOrder.data);{
"data": {
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"record_type": "number_order",
"phone_numbers_count": 1,
"connection_id": "346789098765567",
"messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
"billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",
"phone_numbers": [
{
"id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
"record_type": "number_order_phone_number",
"phone_number": "+19705555098",
"bundle_id": "bc8e4d67-33a0-4cbb-af74-7b58f05bd474",
"regulatory_requirements": [
{
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
"field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21",
"field_type": "address"
}
],
"requirements_met": true,
"status": "success"
}
],
"sub_number_orders_ids": [
"<string>"
],
"status": "pending",
"customer_reference": "MY REF 001",
"created_at": "2018-01-01T00:00:00.000000Z",
"updated_at": "2018-01-01T00:00:00.000000Z",
"requirements_met": true
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The number order ID.
Show child attributes
Unique id for a requirement.
"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
The value of the requirement. For address and document requirements, this should be the ID of the resource. For textual, this should be the value of the requirement.
"45f45a04-b4be-4592-95b1-9306b9db2b21"
A customer reference string for customer look ups.
"MY REF 001"
Successful response with details about a number order.
Show child attributes
"12ade33a-21c0-473b-b055-b3c836e1c292"
"number_order"
The count of phone numbers in the number order.
1
Identifies the connection associated with this phone number.
"346789098765567"
Identifies the messaging profile associated with the phone number.
"abc85f64-5717-4562-b3fc-2c9600"
Identifies the messaging profile associated with the phone number.
"abc85f64-5717-4562-b3fc-2c9600"
Show child attributes
"dc8e4d67-33a0-4cbb-af74-7b58f05bd494"
"number_order_phone_number"
"+19705555098"
The ISO 3166-1 alpha-2 country code of the phone number.
"US"
Show child attributes
"phone_number_regulatory_requirement"
Unique id for a requirement.
"8ffb3622-7c6b-4ccc-b65f-7a3dc0099576"
textual, datetime, address, document "address"
The value of the requirement, this could be an id to a resource or a string value.
"45f45a04-b4be-4592-95b1-9306b9db2b21"
True if all requirements are met for a phone number, false otherwise.
true
Status of document requirements (if applicable)
pending, approved, cancelled, deleted, requirement-info-exception, requirement-info-pending, requirement-info-under-review The status of the phone number in the order.
pending, success, failure "bc8e4d67-33a0-4cbb-af74-7b58f05bd494"
Phone number type
local, mobile, national, shared_cost, toll_free Country code of the phone number
"US"
The status of the order.
pending, success, failure A customer reference string for customer look ups.
"MY REF 001"
An ISO 8901 datetime string denoting when the number order was created.
"2018-01-01T00:00:00.000000Z"
An ISO 8901 datetime string for when the number order was updated.
"2018-01-01T00:00:00.000000Z"
True if all requirements are met for every phone number, false otherwise.
true
Was this page helpful?