GET /api/v1/number_orders
List Number Orders.

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

ids
Optional

Return records matching these ids.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]

page
Optional

Return the next page of results.

  • Must be a number.

per_page
Optional

How many results to return per page. The default is 25.

  • Must be a number.

created_at_to
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be String

created_at_from
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be String

fulltext
Optional

Search for any record that matches this text

  • Must be String

time_zone
Optional

Date ranges will be parsed using this time zone.

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
  • 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
  • Must be 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: {}}

  • 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
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

offer_id
Optional Blank Value Allowed

translation missing: en.api.number_orders.offer_id

ring_pool_id
Optional Blank Value Allowed

translation missing: en.api.number_orders.ring_pool_id

traffic_source_id
Optional Blank Value Allowed

translation missing: en.api.number_orders.traffic_source_id

schedule_id
Optional Blank Value Allowed

translation missing: en.api.number_orders.schedule_id

name
Optional Blank Value Allowed

translation missing: en.api.number_orders.name

  • Must be String

description
Optional Blank Value Allowed

translation missing: en.api.number_orders.description

  • Must be String

provider_configuration_id
Optional Blank Value Allowed

translation missing: en.api.number_orders.provider_configuration_id


POST /api/v1/number_orders
Create Number Order.

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

offer_id
Optional Blank Value Allowed

translation missing: en.api.number_orders.offer_id

ring_pool_id
Optional Blank Value Allowed

translation missing: en.api.number_orders.ring_pool_id

traffic_source_id
Optional Blank Value Allowed

translation missing: en.api.number_orders.traffic_source_id

schedule_id
Optional Blank Value Allowed

translation missing: en.api.number_orders.schedule_id

name
Optional Blank Value Allowed

translation missing: en.api.number_orders.name

  • Must be String

description
Optional Blank Value Allowed

translation missing: en.api.number_orders.description

  • Must be String

provider_configuration_id
Optional Blank Value Allowed

translation missing: en.api.number_orders.provider_configuration_id


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

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String


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

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String

offer_id
Optional Blank Value Allowed

translation missing: en.api.number_orders.offer_id

ring_pool_id
Optional Blank Value Allowed

translation missing: en.api.number_orders.ring_pool_id

traffic_source_id
Optional Blank Value Allowed

translation missing: en.api.number_orders.traffic_source_id

schedule_id
Optional Blank Value Allowed

translation missing: en.api.number_orders.schedule_id

name
Optional Blank Value Allowed

translation missing: en.api.number_orders.name

  • Must be String

description
Optional Blank Value Allowed

translation missing: en.api.number_orders.description

  • Must be String

provider_configuration_id
Optional Blank Value Allowed

translation missing: en.api.number_orders.provider_configuration_id


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

Params

Param name
Description
auth_token
Optional

Authorize requests using your token. Get it from your profile: trackdrive.net/profile/edit

  • Must be String