Revision as of 23:45, 27 August 2018

Get Available Agents

Gets "true" or "false" value for agents ready to handle a specific service.

GET

Note: No authentication or subscription is needed.

{
    “availability”: [ true | false ] 
}

True – "Number of ready agents" > 0 for the specific service (i.e., at least one agent is available)
False – "Number of ready agents" is 0 for the specific service (i.e., no agent is available)

</translate>

@@ Line 1: / Line 1: @@
 <translate>
-= Get File =
+= Get Available Agents =
-Gets the audio file of a recording.
+Gets "true" or "false" value for agents ready to handle a specific service.
-== URL ==
+== URI ==
- http[s]://<host>:<port>/admin/ws/t/<tenant_url>/recordings/audio?giid=<GIID>&stepid=<stepId>
+https://{tenant_url:port}/statsapi/info/check_available_agents?service={service-name}
 == HTTP Method ==
 GET
-== Body ==
+'''Note:''' No authentication or subscription is needed.
-Empty
-== Result ==
+== Response ==
-Audio file (WAV)
+*200 – OK
-== Response Codes ==
+ {
-* 200 – Success
+     “availability”: [ true | false ]
-* 401 – Authentication failed
+ }
-* 403 – User authenticated, but does not have sufficient privileges
-* 404 - File not found
+*True – "Number of ready agents" > 0 for the specific service (i.e., at least one agent is available)
+*False – "Number of ready agents" is 0 for the specific service (i.e., no agent is available)