API documentation

GET /api/v1/number_orders
List Number Orders.

Params

Param name	Description Validations
ids Optional	Return records matching these ids. Validations: Must be an array of decimal values. EG: `[0, 1, 2, 3]`
page Optional	Return the next page of results. Validations: Must be a number.
per_page Optional	How many results to return per page. The default is 25. Validations: Must be a number.
created_at_to Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
created_at_from Optional	Date formatted like 2016-01-01 12:25:15 -0500 Validations: Must be a String
fulltext Optional	Search for any record that matches this text Validations: Must be a String
time_zone Optional	Date ranges will be parsed using this time zone. Validations: Must be a valid time zone. See the list of valid time zones.
columns Optional	Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at Must be any combination of: id legacy_id type uuid created_at updated_at deleted_at user_updated_at routes_show_path routes_edit_path external_record_id paused offer_id ring_pool_id traffic_source_id schedule_id name description provider_configuration_id numbers_count fallback_to_any_number_in_state number_order_prefix_ids Validations: Must be a String
root Optional	Pass `root=false` to return results without a root node and metadata. For example: `GET /api/v1/calls?root=false` will return `[call1, call2, call3]` While: `GET /api/v1/calls` will return `{calls: [call1, call2, call3], metadata: {}}` Validations: Must be a boolean value: 1, true, yes, on, 0, false, no, off

GET /api/v1/number_orders/new
Build Number Order with defaults.

Params

Param name	Description Validations
offer_id Optional Blank Value Allowed	Translation missing: en.api.number_orders.offer_id Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
ring_pool_id Optional Blank Value Allowed	Translation missing: en.api.number_orders.ring_pool_id Validations: Must be a valid foreign key reference to an Number Pool. Refer to: /api/docs/1.0/ring_pools
traffic_source_id Optional Blank Value Allowed	Translation missing: en.api.number_orders.traffic_source_id Validations: Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources
schedule_id Optional Blank Value Allowed	Translation missing: en.api.number_orders.schedule_id Validations: Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
name Optional Blank Value Allowed	Translation missing: en.api.number_orders.name Validations: Must be a String
description Optional Blank Value Allowed	Translation missing: en.api.number_orders.description Validations: Must be a String
provider_configuration_id Optional Blank Value Allowed	Translation missing: en.api.number_orders.provider_configuration_id Validations: Must be a valid foreign key reference to an Provider. Refer to: /api/docs/1.0/provider_configurations

POST /api/v1/number_orders
Create Number Order.

Params

Param name	Description Validations
offer_id Optional Blank Value Allowed	Translation missing: en.api.number_orders.offer_id Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
ring_pool_id Optional Blank Value Allowed	Translation missing: en.api.number_orders.ring_pool_id Validations: Must be a valid foreign key reference to an Number Pool. Refer to: /api/docs/1.0/ring_pools
traffic_source_id Optional Blank Value Allowed	Translation missing: en.api.number_orders.traffic_source_id Validations: Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources
schedule_id Optional Blank Value Allowed	Translation missing: en.api.number_orders.schedule_id Validations: Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
name Optional Blank Value Allowed	Translation missing: en.api.number_orders.name Validations: Must be a String
description Optional Blank Value Allowed	Translation missing: en.api.number_orders.description Validations: Must be a String
provider_configuration_id Optional Blank Value Allowed	Translation missing: en.api.number_orders.provider_configuration_id Validations: Must be a valid foreign key reference to an Provider. Refer to: /api/docs/1.0/provider_configurations

GET /api/v1/number_orders/:id
Get Number Order by id.

PUT /api/v1/number_orders/:id
Update Number Order by id.

Params

Param name	Description Validations
offer_id Optional Blank Value Allowed	Translation missing: en.api.number_orders.offer_id Validations: Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
ring_pool_id Optional Blank Value Allowed	Translation missing: en.api.number_orders.ring_pool_id Validations: Must be a valid foreign key reference to an Number Pool. Refer to: /api/docs/1.0/ring_pools
traffic_source_id Optional Blank Value Allowed	Translation missing: en.api.number_orders.traffic_source_id Validations: Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources
schedule_id Optional Blank Value Allowed	Translation missing: en.api.number_orders.schedule_id Validations: Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
name Optional Blank Value Allowed	Translation missing: en.api.number_orders.name Validations: Must be a String
description Optional Blank Value Allowed	Translation missing: en.api.number_orders.description Validations: Must be a String
provider_configuration_id Optional Blank Value Allowed	Translation missing: en.api.number_orders.provider_configuration_id Validations: Must be a valid foreign key reference to an Provider. Refer to: /api/docs/1.0/provider_configurations

DELETE /api/v1/number_orders/:id
Destroy Number Order by id.