/agent-status/

Get the current agent status

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Fetch the current status of the agent here.
Get Agent Token from Token Page

This API returns 5 properties. Each property signifies a different stage in the lifecycle of an agent connecting to a campaign and making calls.

If all of the properties are null, then the agent has not joined any campaign and is not on call.

Once the /conference api is used successfully to connect to a campaign, the connected_campaign field returns the ID of the connected campaign.

When the /conference/:id/agent api is used successfully to call the agent and the agent picks the call, the call_uuid returns the ID of the call.

After using /conference/:id/subscriber successfully to initiate a call with the subscriber, the current_subscriber field returns the ID of the subscriber being called.

After the subscriber picks up the call, subscriber_uuid returns the UUID of the call.

After using /conference/:id/supervisor to call the supervisor and the supervisor picks up the call, the supervisor_uuid returns the UUID of the supervisor's call.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json