JSON API » cdrs » cdrs/update

Updates costs for an existing completed call.

Input parameters

Requires authentication and the commerce role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
uniqueidStringUniqueid.Yes
customerIntegerID of customer to update costs for.Yes
cardStringCalling card to update costs for.NoEmpty string.
costDecimalCost to customer making call.NoCurrent value.
currencyStringCurrency cost is in.NoCurrent value.
messagesIntegerNumber of included messages used.NoCurrent value.
taxesStringComma separated list of taxes to apply.NoCurrent value.
timeIntegerIncluded time used in seconds.NoCurrent value.
update_balanceInteger1 to update balance of customer making call, 0 not to.No1
update_invoicesInteger1 to update any affected invoices, 0 not to.No1
validationInteger1 to validate input then return, 0 for full action.No0

Responses

CodeDescription
201Input passed validation. Only returned if validation=1.
204Success.
400Invalid input parameters specified. Check the key and message fields for more details.
401The authentication details provided are invalid.
402Your role does not allow this.
404The 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

VersionChanges
3.13Function added.