logo

The API url to request AJAX compatible data is: http(s)://api.dxi.eu/ajax.php?token=... To access all DXI API interfaces, all requests need to have an access token which will authorize requests for a particular account for a fixed period of time. These requests are also restricted to the internet address that requested the token. The token API documentation can be read here. The AJAX API has a number of available functions. The request arguments can all be passed as HTTP POST or GET variables: RESULT The response from the API can be formatted in either JSON or XML format. The default is JSON but this can be modified by the format argument. The API will output a number of optional values depending on the request made. However every request will return a success value, essentially denoting if the request failed or not. success: Did the request succeed. value: true or false (JSON) | 1 or 0 (XML) error: If the request failed, this field will contain a description of the fault. total: The total number of possible values returned. This is irrespective of the limit or start arguments, see below, so the total can be different to the actual size of the returned list. Example JSON return: {"success":true} {"success":false,"error":"Bad argument: xyz"} Example XML return: <result><success>1</success></result> <result><success>1</success><error>Bad argument: xyz</error></result> OPTIONAL ARGUMENTS The following are arguments available on all applicable requests. format: xml or json - specify the output format. Defaults to json. limit: integer - limit the number of returned values. Defaults to all values. start: integer - output values after the start'th value. Defaults to 0. These two arguments can be used in combination to implement basic paging functionality.
API METHODS
Agents - method: agents
List all online agents and their current status. action: read ajax.php?method=agents&action=read Filters agent: return details for just the agent id specified mode: set to all to also return offline agents in the result Returns agents: A list containing the individual agent details. Agent Fields uid: The agents unique DXI system id. name: The agents name. customer: The DXI system callid of the current call the agent is handling. 0 denotes no call in progress or in-wrap. moh: The current agents music-on-hold / radio station setting. status: The agents current status. Possible values are: hold | wait | dial | tpt | call | wrap | offline time: The timestamp of when the agent switched to the current status. This is in Unix timestamp format.
Inbound Calls - method: incoming
List calls in the inbound queuing system. action: read ajax.php?method=incoming&action=read Filters qid: return details for just the queue id specified or comma seperated list of queue id's Returns incoming: A list containing the individual inbound calls. Call Fields callid: The DXI system callid. qid: The DXI queue id. queue: The name of the queue the call was received on. callerid: The customers presented CLI. agent: The name of the agent dealing with the call. unset if the call is not answered. qtype: The type of the queue the call was received on. connected: The timestamp of when the call was connected to the queue. This is in Unix timestamp format. answered: The timestamp of when the call was answered by an agent. 0 if still in the queue and not yet answered.
Outbound Calls - method: outgoing
List all outgoing calls. action: read ajax.php?method=outgoing&action=read Filters qid: return details for just the queue id specified or comma seperated list of queue id's Returns outgoing: A list containing the individual outbound calls. Call Fields callid: The DXI system callid. qid: The DXI queue id. queue: The name of the queue the call was placed on. ddi: The DDI of the number called. calltype: The type of outbound call. Possible values are: Dialer | Manual | Third Party agent: The name of the agent dealing with the call. unset if the call is not answered. qtype: The type of the queue the call was placed on. dialed: The timestamp of when the call was made. This is in Unix timestamp format. answered: The timestamp of when the call was answered. 0 if the call is still ringing and not yet answered.
Statistics for all active inbound queues. action: read ajax.php?method=inbound_activity&action=read&mode=group Filters qid: return details for just the queue id specified or comma seperated list of queue id's Returns list: A list containing the activity statistics. Fields qid: The DXI queue id. queue: The name of the queue the call was received on. queueing: The number of unanswered calls queueing. on_call: The number of answered calls still live. max_wait: The maximum wait time for the unanswered calls (seconds)
Statistics for all active outgoing queues. action: read ajax.php?method=outbound_activity&action=read&mode=group Filters qid: return details for just the queue id specified or comma seperated list of queue id's Returns list: A list containing the activity statistics. Fields qid: The DXI queue id. queue: The name of the queue the call was received on. predictive_dials: The number of in-progress dial attempts. predictive_calls: The number of answered calls still live. manual_calls: The number of manual calls still live. tpt_calls: The number of third-party calls still live. abandon: The current call abandon rate for the queue (%)
Overview - method: overview
List summary statistics of the call centre or campaign. action: read ajax.php?method=overview&action=read Returns list: A list containing the call centre or campaign statistics. Fields uid: The DXI campaign id. ccname: The campaign name. nagents: The total number of online agents. ncall: The total number of agents on a call. nwait: The total number of agents waiting for a call. nwrap: The total number of agents in wrap. ncalls_i: The total number of active inbound calls. ncalls_o: The total number of active outbound calls.