JSON API » peers » peers/costs/update

Updates an existing peer cost.

Input parameters

Requires authentication and the system owner role privilege.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
id	Integer	ID of peer cost.	Yes
called_max	Integer	Maximum length of called number to match.	No	Current value.
called_min	Integer	Minimum length of called number to match.	No	Current value.
called_prefix	String	Called prefix to match. Empty string for any.	No	Current value.
caller_type	String	Callerid type: prefix or group.	No	prefix
caller_prefix	String	Callerid prefix or group to match. Empty string for any.	No	Current value.
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.
days	String	Days time chunk is active. Monday = 1, Sunday = 7. For example, "12345" for Monday to Friday.	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.
endhour	Integer	End hour from 0 to 23.	No	Current value.
endminute	Integer	End minute from 0 to 59.	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.
media	String	Media type. "fax", "voice", or "voice_fax".	No	"voice_fax"
message	Decimal	The cost to send a message.	No	Current value.
minimum	Decimal	An overall minimum cost for the call if answered.	No	Current value.
peer	Integer	ID of peer.	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.
starthour	Integer	Start hour from 0 to 23.	No	Current value.
startminute	Integer	Start minute from 0 to 59.	No	Current value.
validation	Integer	1 to validate input then return, 0 for full action.	No	Current value.

Responses

Code	Description
204	Success.
201	Input passed validation. Only returned if validation=1.
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 peer cost does not exist.

Data returned

No data is returned.

Example: Changing the called number prefix

http://enswitch.example.com/api/json/peers/costs/update/?auth_username=user;auth_password=password;id=2;called_prefix=011

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

Change history

Version	Changes
4.2	caller_type parameter added.
4.1	least_cost parameter added.
3.15	Function added.