Voice Self-Service for your growing business needs
The sdr (Service Detail Record) API allows you to retrieve the service detail records associated with your account.
The API returns batches of SDRs, with next and previous links to retrieve additional records.
NOTE: The date range is limited to a span of 90 days.
Params
| apiKey | Required | The apiKey associates the API call with your account. |
| startDate | Required | The starting date/time for SDRs to be returned. Format yyyy-mm-ddThh:mi:ss. |
| endDate | Required | The ending date/time for SDRs to be returned. Format yyyy-mm-ddThh:mi:ss. |
| callingParty | Optional | The A-number of the SDR. |
| calledParty | Optional | The B-number of the SDR. |
| max | Optional, Default/Max 500 | Limits the number of SDRs that will be returned with a single query. |
Example CURL Command
Copy the command and replace with your {apiKey}, the required params and any optional params.
curl "https://api.nimblevox.com/sdr?startDate=2012-10-31T00:00:00&endDate=2012-10-31T23:59:59&callingParty=123456789&calledParty=987654321&apiKey={apiKey}&max=100"
Example XML Response
<result xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
<link rel='next' href='https://api.nimblevox.com/sdr?offset=100&max=100&startDate=2012-10-31T00:00:00&endDate=2012-10-31T23:59:59'/>
<count>100</count>
<total>1000</total>
<sdrs>
<sdr id='3' href='https://api.nimblevox.com/sdr/3'>
<seqnum>5858580000741902F1F3B844243079</seqnum>
<subscriber>99999002607</subscriber>
<billStart>2012-10-31T10:29:51</billStart>
<billEnd>2012-10-31T10:29:55</billEnd>
<callingParty>123456789</callingParty>
<calledParty>987654321</calledParty>
<callType>Application Outdial</callType>
<serviceType>Outbound Call</serviceType>
<billUnits>60</billUnits>
<moneyCharge>0.03</moneyCharge>
<bonusCharge>0.00</bonusCharge>
<endingBalance>-392.15</endingBalance>
<endingBonusBalance>0.00</endingBonusBalance>
<correlationId>67DFA378557286764314</correlationId>
<serviceTime>4</serviceTime>
<clientTime>14</clientTime>
<customCallDataList/>
</sdr>
</sdrs>
</result>
Example JSON Response
{"previous":null,"next":"https://api.nimblevox.com/sdr?offset=100&max=100&startDate=2012-10-31T00:00:00&endDate=2012-10-31T23:59:59","count":100,"total":1000,"sdrs":[{"id":3,"href":"https://api.nimblevox.com/sdr/3","seqnum":"5858580000741902F1F3B844243079","subscriber":"99999002607","billStart":"2012-10-31T10:29:51","billEnd":"2012-10-31T10:29:55","callingParty":"123456789","calledParty":"987654321","callType":"Application_Outdial","serviceType":"Outbound_Call","billUnits":60,"moneyCharge":0.03,"bonusCharge":0.00,"endingBalance":-392.15,"endingBonusBalance":0.00,"correlationId":"67DFA378557286764314","serviceTime":4,"clientTime":14,"customCallDataList":null}]}
Response Field Definitions
| Element Name | Description |
| count | The number of records returned. |
| total | The total number of records matching the search criteria. |
| id | Unique identification number of the session. |
| href | The location of the SDR Resource. |
| seqnum | Sequence number of the record. |
| subscriber | The Nimblevox Blast account number. |
| billStart | Date/Time the service was initiated. |
| billEnd | Date/Time the service was terminated. |
| callingParty | The A-number of the SDR. |
| calledParty | The B-number of the SDR. |
| callType | The type of call performed, e.g. Application Outdial, Incoming Call, etc. |
| serviceType | The type of service performed, e.g. Outbound Call, Inbound Call, etc. |
| billUnits | This is the number of units actually billed for this service instance. |
| moneyCharge | Money charged to the subscriber for the service. |
| bonusCharge | Bonus money charged to the subscriber for the service. |
| endingBalance | The subscriber ending balance after the service charges. |
| endingBonusBalance | The subscriber ending bonus balance after the bonus service charges. |
| correlationId | Correlates this service detail record to external activity. This is usually the SIP Call ID. |
| serviceTime | Total time or volume used. |
| clientTime | Time from service authorization to service tear down. |
| customCallDataList | Lists any custom call data that was provisioned by your spotbuild application. |
