JSON API » outcosts » outcosts/update

Updates an existing outbound call cost.

Input parameters

Requires authentication and the system role privilege if updating a cost for a peer or the commerce role privilege if updating a cost for a rate plan.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of the cost.	Yes
callergroup	Integer	ID of caller group this outbound call cost will be restricted to, 0 for any caller.	No	0
connectfee	Decimal	A connect fee charged on answer.	No	Current value.
cost	Decimal	The cost per minute after the included seconds are used.	No	Current value.
description	String	Description.	No	Current value.
end	Integer	The Unix timestamp after which this cost no longer applies. -1 for never.	No	Current value.
included	Integer	The number of seconds included free with the connectfee.	No	Current value.
increment	Integer	Billing increment in seconds.	No	Current value.
least_cost	Integer	1 to use this cost for least cost routing, 0 not to.	No	Current value.
message	Decimal	The cost to send a message.	No	Current value.
message_media	Decimal	The cost to send a media message.	No	Current value.
minimum	Decimal	An overall minimum cost for the call if answered.	No	Current value.
priority	Integer	The priority from 1 to 10.	No	Current value.
start	Integer	The Unix timestamp from which this cost applies.	No	Current value.
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.
403	Your rate plan does not allow this.
404	The cost does not exist, or you do not have permission to update it.

Data returned

No data is returned.

Example: Updating the per-minute cost

http://enswitch.example.com/api/json/outcosts/update/?auth_username=user;auth_password=password;id=123;cost=0.12

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
4.2	message_media and callergroup parameters added.
4.1	least_cost parameter added.
3.13	Function added.