Services

Retrieve Voice service

Work with customer Voice services.Retrieves Voice service with the given ID.

get/admin/customers/customer/{customer_id}/voice-services--{service_id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/customers/customer/{customer_id}/voice-services--{service_id}
  • Auth: HTTP basic

Path parameters

customer_idnumber double required
Example:1

The ID of the desired Customer.

service_idnumber double required
Example:1

The ID of the desired Voice service.

Response

customer_idnumber required

Customer ID

tariff_idnumber required

Tariff ID

statusstring required

Status. Values: 'active', 'stopped', 'disabled', 'hidden', 'pending'

descriptionstring required

Description

quantitynumber required

Quantity

unitnumber

Unit

unit_pricenumber

Unit price

start_datestring required

Start date. Format: YYYY-MM-DD

end_datestring required

End date. Format: YYYY-MM-DD. Set to '0000-00-00' for endless

discountstring

Discount

discount_typestring

Type of discount: 'percent' or 'fixed'. Default value: 'percent'

discount_valuenumber

Discount value

discount_start_datestring

Discount start date

discount_end_datestring

Discount end date

discount_textstring

Discount message

voice_device_idnumber

Voice device ID

phonestring required

Phone number

phonesArraystring[]

Phone numbers

bundle_service_idnumber

ID of bundle service. 0 for none

directionstring

Call direction. Values: 'incoming', 'outgoing'. Default: 'outgoing'

status_newstring

Indicates the status of the parent service. Default: ''

parent_idnumber

ID of Parent service. 0 for none

on_approvestring

Indicates whether the service needs to be approved. Values: '0', '1'. Default: 0

periodstring

Period of which to charge for this service: 0 for postpaid and number of period (from 1 to 99). Default: -1

idnumber required

Voice service Id

typestring

Service type

Example response

{
  "customer_id": 1,
  "tariff_id": 1,
  "status": "active",
  "description": "Some Description",
  "quantity": 1,
  "unit": 0,
  "unit_price": 0,
  "start_date": "2016-01-01",
  "end_date": "0000-00-00",
  "discount": "",
  "discount_type": "percent",
  "discount_value": 0,
  "discount_start_date": "",
  "discount_end_date": "",
  "discount_text": "",
  "voice_device_id": 0,
  "phone": "",
  "phonesArray": [],
  "bundle_service_id": 0,
  "direction": "outgoing",
  "status_new": "stopped",
  "parent_id": 1,
  "on_approve": "0",
  "period": "-1",
  "id": 1,
  "geo": {
    "address": "",
    "marker": "",
    "src": "customer"
  },
  "type": "voice",
  "replaced_by": {
    "service_name": "Voice Unlimited",
    "date": "2026-08-01"
  }
}

Changes

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