JSON API » outcosts » outcosts/customer/list

Gets outbound call costs to a customer.

Input parameters

Requires authentication and the administrator or reports role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
customer	Integer	ID of customer to get costs for.	No	Customer of authentication user.
destination	String	Get costs for this called number. Empty string for none.	No	Empty string.
plan	Integer	ID of rate plan.	No	Plan customer is on.
search	String	Only return results for outbound groups containing this string. Empty string for any.	No	Empty string.
count	Integer	1 to return a count, 0 to return full data.	No	0
limit	Integer	The maximum results to return. 0 for all.	No	0
offset	Integer	The result to start at. 0 for the first.	No	0
pages	Integer	1 to return a reduced set of data for generating the pages select box, 0 to return full data.	No	0

destination cannot be used with search.

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.
404	There is no route to this destination.

Data returned

An array of fields, one row for each cost. Costs are returned in the currency of the authentication user.

Example: With required parameters

http://enswitch.example.com/api/json/outcosts/customer/list/?auth_username=user;auth_password=password

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":[ { "id":123, "outgroup_time":1, ... }, { "id":124, "outgroup_time":2, ... } ] }

Change history

Version	Changes
3.13	Function added.