JSON API » cdrs » cdrs/update
Updates costs for an existing completed call.
Input parameters
Requires authentication and the commerce role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
uniqueid | String | Uniqueid. | Yes | |
customer | Integer | ID of customer to update costs for. | Yes | |
card | String | Calling card to update costs for. | No | Empty string. |
cost | Decimal | Cost to customer making call. | No | Current value. |
currency | String | Currency cost is in. | No | Current value. |
messages | Integer | Number of included messages used. | No | Current value. |
taxes | String | Comma separated list of taxes to apply. | No | Current value. |
time | Integer | Included time used in seconds. | No | Current value. |
update_balance | Integer | 1 to update balance of customer making call, 0 not to. | No | 1 |
update_invoices | Integer | 1 to update any affected invoices, 0 not to. | No | 1 |
validation | Integer | 1 to validate input then return, 0 for full action. | No | 0 |
Responses
Code | Description |
---|---|
201 | Input passed validation. Only returned if validation=1. |
204 | Success. |
400 | Invalid input parameters specified. Check the key and message fields for more details. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
404 | The call does not exist, or you do not have permission to update it. |
Data returned
No data is returned.
Example: Updating cost
http://enswitch.example.com/api/json/cdrs/update/?auth_username=user;auth_password=password;uniqueid=1234567890.123456;customer=123;cost=0.12{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }
Change history
Version | Changes |
---|---|
3.13 | Function added. |