Request
Endpoint:
|
/api/sipt/services/{service_id}
|
Example:
|
/api/sipt/services/5
|
Method:
|
GET
|
Headers:
|
Accept: application/vnd.cloudlx.v1+json
|
Authorization: Bearer <access_token>
|
Response
Example:
{
"id": 5,
"customer_id": 165,
"customer_name": "My SIPT Customer",
"site_id": "85",
"site_name": "HQ",
"supplier": "Epsilon",
"ip_address": "20.6.85.123",
"sip_port": "8888",
"delivery_date": "2018-11-01",
"currency": "GBP - British Pound",
"number_quantity": 5,
"number_nrc": 1.85,
"number_mrc": 1.25,
"channel_quantity": 5,
"channel_nrc": 4.5,
"channel_mrc": 2.5,
"set_up_cost": 150,
"max_time": 60,
"max_spend": 100,
"porting_supplier": "BT",
"porting_numbers": "07915648912,07913684521",
"status": "active",
"end_date": "2019-08-10",
"renewal": "2019-08-10"
}
id
|
Description
|
The id for the service, used to perform actions on the site
|
Type
|
Number
|
Example
|
5
|
customer_id
|
Description
|
The id of the customer this service belongs to
|
Type
|
Number
|
Example
|
165
|
customer_name
|
Description
|
The name of the customer this service belongs to
|
Type
|
String
|
Example
|
My SIPT Customer
|
site_id
|
Description
|
The id of the site this service belongs to
|
Type
|
Number
|
Example
|
85
|
site_name
|
Description
|
The name of the site this service belongs to
|
Type
|
String
|
Example
|
HQ
|
supplier
|
Description
|
The supplier of this service
|
Type
|
String
|
Example
|
Epsilon
|
ip_address
|
Description
|
The IP address set when the service was created
|
Type
|
String
|
Example
|
20.6.85.123
|
sip_port
|
Description
|
The SIP port set when the service was created
|
Type
|
String
|
Example
|
8888
|
delivery_date
|
Description
|
The delivery date requested when the service was created, in the format 'YYYY-MM-DD'
|
Type
|
String
|
Example
|
2018-11-01
|
currency
|
Description
|
The currency that the service will be billed in
|
Type
|
String
|
Example
|
GBP - British Pound
|
number_quantity
|
Description
|
The quantity of numbers requested on this service
|
Type
|
Number
|
Example
|
5
|
number_nrc
|
Description
|
The NRC cost for numbers at this site in the customers currency
|
Type
|
Number
|
Example
|
1.85
|
number_mrc
|
Description
|
The MRC cost for numbers at this site in the customers currency
|
Type
|
Number
|
Example
|
1.25
|
channel_quantity
|
Description
|
The quantity of channels requested on this service
|
Type
|
Number
|
Example
|
5
|
channel_nrc
|
Description
|
The NRC cost for channels at this site in the customers currency
|
Type
|
Number
|
Example
|
4.5
|
channel_mrc
|
Description
|
The MRC cost for channels at this site in the customers currency
|
Type
|
Number
|
Example
|
2.5
|
set_up_cost
|
Description
|
The setup cost at this site in the customers currency
|
Type
|
Number
|
Example
|
150
|
max_time
|
Description
|
The maximum time a call can last in hours, as set on service creation
|
Type
|
Number
|
Example
|
60
|
max_spend
|
Description
|
The maximum single call spend in the customers currency, as set on service creation
|
Type
|
Number
|
Example
|
100
|
porting_supplier
|
Description
|
The name of the company that the requested numbers are being ported from
|
Type
|
String
|
Example
|
BT
|
porting_numbers
|
Description
|
The numbers that have been requested to be ported over
|
Type
|
String
|
Example
|
07915648912,07913684521
|
status
|
Description
|
The current staus of this service
|
Type
|
String
|
Example
|
active
|
end_date
|
Description
|
The date that this service ends in the format 'YYYY-MM-DD'
|
Type
|
String
|
Example
|
2019-08-10
|
renewal
|
Description
|
The date that this service is renewed in the format 'YYYY-MM-DD'
|
Type
|
String
|
Example
|
2019-08-10
|