Retrieve all Service Numbers
This function retrieves all service numbers from the client account.
URL
GET {baseURL}/serviceNumbers
Parameters
None
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the following fields:
| Field | Type | Data |
|---|---|---|
| filter | String | The applied filter. This is reserved for future use. |
| limitStart | Integer | The first record index. Currently 0, reserved for future use. |
| limitPageSize | Integer | The number of records. -1 indicates all records. Reserved for future use. |
| records | ServiceNumbers [] | An array of ServiceNumbers. |
| count | Integer | The number of records returned. |
| orderBy | String | The field used to sort the records. |
| ascending | Boolean | Whether the array of records is sorted ascending or descending. |
| status | Integer | The return code (also provided by the http status code). |
Example
Note, the records array has been shortened for readability.
{
"filter": "",
"limitStart": 0,
"limitPageSize": -1,
"records": [
{
"ContractNumber": null,
"dtTo": null,
"EndNumber": "",
"dtReset": "2022-06-17T15:19:12.484+02:00",
"ResellerTrafficManagementPoliciesID": null,
...
"ApplySeconds4": null,
"bCockpitConferenceFlag": false,
"ClientsID": 1,
"ApplySeconds3": null,
"ResellersID": 1
}
],
"count": 14,
"orderBy": "Name2",
"ascending": true,
"status": 200
}
Retrieve a specific Service Number by ID
This function retrieves a specific service number by ID.
URL
GET {baseURL}/serviceNumbers/serviceNumber/{serviceNumbersID}
Parameters
| Parameter | Where | Type | Data |
|---|---|---|---|
| serviceNumbersID | URL | Integer | The ID of the service number. |
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the returned data.
| Field | Type | Data |
|---|---|---|
| records | ServiceNumbers [] | An array of ServiceNumbers, containing ServiceNumber. |
| count | Integer | 1 |
| status | Integer | The return code (also provided by the http status code). |
Example
Note, the record array has been shortened for readability.
{
"records": [
{
"ContractNumber": null,
"dtTo": null,
"EndNumber": "",
"dtReset": "2021-05-07T13:04:46.839+02:00",
"ResellerTrafficManagementPoliciesID": null,
"RootNumber": "49199501",
"Name": "49199501",
...
"ClientsID": 1,
"ApplySeconds3": null,
"ResellersID": 1
}
],
"count": 1,
"status": 200
}
Retrieve ServiceNumber by Name
This function retrieves one or more ServiceNumbers, depending on the passed name. If more than one ServiceNumber is available which matches the name passed (partial match), then all corresponding service numbers will be returned.
URL
GET {baseURL}/serviceNumbers/serviceNumber?name={ServiceNumbersName}
Parameters
| Parameter | Where | Type | Data |
|---|---|---|---|
| ServiceNumbersName | Query | String | The name of the service number(s) to retrieve. |
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the returned acd groups.
| Field | Type | Data |
|---|---|---|
| records | ServiceNumbers [] | An array of ServiceNumbers. |
| count | Integer | The number of records returned. |
| status | Integer | The return code (also provided by the http status code). |
Example
Note, the records array has been shortened for readability.
{
"records": [
{
"ContractNumber": null,
"dtTo": null,
"EndNumber": "",
"dtReset": "2022-06-17T15:19:12.484+02:00",
"ResellerTrafficManagementPoliciesID": null,
"RootNumber": "49199500",
"Name": "49199500",
...
"RoutingPlansID": null,
"bPeakService": null,
"bCockpitOriginFlag": false,
"BillingPK": null,
"dtFrom": null,
"TrunkGroupsID": 22,
"nCallsReset": null,
"ApplySeconds2": null,
"ApplySeconds1": null,
"WhiteListsID": null,
"ApplySeconds4": null,
"bCockpitConferenceFlag": false,
"ClientsID": 1,
"ApplySeconds3": null,
"ResellersID": 1
}
],
"count": 14,
"status": 200
}