Vodia PBX API (version 58.0 and above)

This page includes all the API parameters of the ACD wallboard Setting(s).

ACD Wallboard details

GET

1) Get the list of all the existing ACDs. One can access that from User Portal > ACDs

/rest/user/extension@domain_name/wallboard

Parameters

Field Type Description
extension Integer Existing extension number
domain_name String Name of the existing domain.

Success (200 OK)

Example Request:

curl -u username:password GET -D - https://192.168.0.189/rest/user/440@vodia/wallboard
[ { display: "Agent Group", name: "1000" }, { display: "Agent_2", name: "5555" } ]

2) Detailed Explanation information of ACD wallboard details page. Can be accessed from User Portal > ACDs > Agent Group Selection

P.S. Note: To get new information available every second one has to use websockets.

/rest/user/extension@domain_name/wallboard/ACD

Parameters

Field Type Description
extension Integer Existing extension number
domain_name String Name of the existing domain.
acd Int Unique ACD Number

Success (200 OK)

Example Request:

curl -u username:password GET -D - https://192.168.0.189/rest/user/440@vodia/wallboard/1000
{ # BRIEF EXPLANATION OF THE API VARIABLES: acds: { 1000: { # Category - ACD 1000 which received the call redirect: { # If the calls were redirected from this ACD waiting: 0, # No calls were redirected, hence the value "0" ringing: 0, anonymous: 0 }, hangup: { # Category - If the "caller" hangs-up waiting: 0, # If caller hangs-up while they are on a hold / wait ringing: 1 # If the caller hangs-up while ACD agents are ringing }, exit: { # Not used anymore user: 0, admin: 0, application: 0, other: 0 }, duration: { # Category - Sum and Average duration of the call (in secs) sum: { # Sum of all the calls per day on the ACD 1000 ivr: 9, # Sum of Duration for which the IVR was played to caller ring: 8, # Sum of Duration for which calls rang before being picked talk: 12, # Sum of Duration for which the calls ran hold: 0, # Sum of Duration for which calls were on a hold idle: 17 # Sum of Duration of time between two consecutive calls, }, # for period lesser than 12 hours (agent sleep time @night) average: { # Average Duration of all the calls "per day" on ACD 1000 ivr: 3, # Average Duration of the IVR played to caller ring: 2, # Average Duration for which calls rang before being picked talk: 4, # Average Duration for which the calls ran hold: 0, # Average Duration for which calls were on a hold idle: 5 # Average Duration of time between two consecutive calls, } # for period lesser than 12 hours (agent sleep time @night) }, calls: { # Total number of calls (rang) per day count: 4, # Total number of calls received completed: 3 # Total number of calls completed } } }, logged_agents: [ # Extension number of the agents logged in currently 440, 446, 444 ], agents: [ # Details of all the extensions (only single { # extension is explained here as an example) account: "440", # Agent account / extension number name: "James Brolin", # Agent's Full Name dnd: false, # If this agent has DND set 'currently' jumpin: true, # If this agent can jump in and out of the agent group work: { # Agent work time details (in secs) counted from 1970. begin: 1510722000, # Agent first call picked up (work start) time end: 1510808400, # Agent last call end (shift end) time now: 1510765209.752, # Current time in 'ms' segments: [ # Duration of single break taken. Every break taken, adds [ # a new 'Segment' header here. 1510757878.356, 1510758136.989 ] ] }, calls: 0, # Same values mentioned above for the call duration duration: { # sum and call duration average talk: 0, hold: 0, idle: 0 }, average: { talk: 0, hold: 0, idle: 0 } }, ], current:[ # Current details of the call, agent is on {start: "1510765183.781", from: ""Mailbox M" <sip:446@vodia>", acd: "1000", agent: "444"}] # Current call start time, caller-ID, ACD being called, # picked by which agent. 0:{start: "1510765183.781", from: ""Mailbox M" <sip:446@vodia>", acd: "1000", agent: "444"} acd:"1000" # First call of the day, hence the list begins with '0'. agent:"444" # Rest of the details as mentioned above. from:""Mailbox M" <sip:446@vodia>" start:"1510765183.781" history: [ { # First call with tag '0' and it's details start time, start: "1510761936.564", # caller-ID, ACD being called, picked by which agent. from: ""James Brolin" <sip:440@vodia>", duration: 3, agent: "444" }, { # Second call with tag '1' and it's details start time, start: "1510761983.532", # caller-ID, ACD being called, picked by which agent from: ""James Brolin" <sip:440@vodia>", duration: 0, agent: "" # So on and so forth... }, { start: "1510762720.264", from: ""James Brolin" <sip:440@vodia>", duration: 1, agent: "444" }, { start: "1510765195.260", from: ""Mailbox M" <sip:446@vodia>", duration: 8, agent: "444" } ] }
Response Code Description
Success 200 OK
Invalid ID supplied 400 Only authenticated a Admins can access the data
Permission Denied 403 Forbidden
Not Found 404 The id of the User was not found or there are errors in the URL.