Voice

Retrieve a Voice Customer Rate

Work with Voice Customer Rates. Retrieves the Voice Customer Rate with the given ID.

get/admin/voice/customer-rates/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/voice/customer-rates/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The ID of the desired Voice Customer Rate.

Response

idnumber

Customer rate ID.

table_idnumber

Customer rate table the rate belongs to.

namestring

Rate name.

descriptionstring

Free-form description.

type'call' | 'message' | 'data'

Voice service type. One of call, message, data.

category_idnumber nullable

Voice category ID. Nullable.

prefixstring

Number prefix the rate matches.

pricenumber

Price per tariffication step.

first_stepnumber

Length of the first chargeable step (seconds for calls, units for other types).

tariffication_stepnumber

Length of each subsequent chargeable step.

connect_costnumber

One-off connect cost charged on top of the price.

Example response

{
  "id": 1,
  "table_id": 3,
  "name": "Local",
  "description": "Local destinations",
  "type": "call",
  "category_id": 1,
  "prefix": "380",
  "price": 0.05,
  "first_step": 60,
  "tariffication_step": 30,
  "connect_cost": 0
}

Changes

No recorded changes to this operation across all 1 revision of this API.