JSON API » outcosts » outcosts/import

Imports outbound call costs from a CSV file.

Input parameters

Requires authentication and the system role privilege if specifying a peer or the commerce role privilege if specifying a rate plan.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
csv	String	The contents of the CSV file.	Yes
peer	Integer	ID of peer.	Yes, unless plan is specified.	None.
plan	Integer	ID of rate plan.	Yes, unless peer is specified.	None.
delete	Integer	1 to delete all costs first, 0 not to.	No	0
overwrite	Integer	1 to allow overwriting of existing costs, 0 not to.	No	0
recalculate	Integer	1 to recalculate outbound routes, 0 not to.	No	1

Specify peer or plan, but not both.

Responses

Code	Description
200	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.
500	An internal error occurred. Check the key and message fields for more details.

Data returned

The number of costs created.

Example: With peer (csv field omitted for brevity)

http://enswitch.example.com/api/json/outcosts/import/?auth_username=user;auth_password=password;peer=1;csv=...

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "count":123 } }

Change history

Version	Changes
3.13	Default for recalculate changed to 1.
3.13	Function added.