| POST | /api/call-allowance/balance |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StartDate | body | string | No | The start of the date range to list forms for |
| EndDate | body | string | No | The end of the date range to list forms for |
| ClientId | body | string | No | The ID of the client whose balance you want to get |
| BillHold | body | bool | No | Whether you want to bill for hold time or not |
| BillTalk | body | bool | No | Whether you want to bill for talk time or not |
| BillTransfer | body | bool | No | Whether you want to bill for transfer time or not |
| BillRing | body | bool | No | Whether you want to bill for ring time or not |
| CallRounding | body | CallRoundingType | No | Round call durations (Possible values: None, NextMinute, Next30Seconds) |
| MinCallDuration | body | double | No | The minimum duration of the call in seconds (talk time only) |
| MaxCallDuration | body | double | No | The maximum duration of the call in seconds (talk time only) |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerName | form | string | Yes | The HostedSuite Customer Name |
| UserName | form | string | Yes | The HostedSuite User Name. Data visibility and security is based on this user's permissions. |
| Password | form | string | Yes | The HostedSuite User's Password |
| None |
| NextMinute |
| Next30Seconds |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/call-allowance/balance HTTP/1.1
Host: cpo.hostedsuite.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"StartDate":"String","EndDate":"String","ClientId":"String","BillHold":false,"BillTalk":false,"BillTransfer":false,"BillRing":false,"CallRounding":"None","MinCallDuration":0,"MaxCallDuration":0,"CustomerName":"String","UserName":"String","Password":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
[{"ClientId":"String","ThirdPartyAccountId":"String","ClientName":"String","AllowanceDescription":"String","NumCalls":0,"NumMins":0,"Balance":0,"BalanceDescription":"String"}]