{"info":{"_postman_id":"bc352a84-296e-42c8-8d95-e621de41904f","name":"Final Expense Agent Availability Ping","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"12208069","collectionId":"bc352a84-296e-42c8-8d95-e621de41904f","publishedId":"2sBXcKBdPT","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"293250"},"publishDate":"2026-03-03T18:53:04.000Z"},"item":[{"name":"Agent Availability","event":[{"id":"b226fcce-ccc7-4e8f-8267-0ee5229d6a31","listen":"test","script":{"type":"text/javascript","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Agents are available\", function () {"," const json = pm.response.json();"," pm.expect(json.availableAgents).to.be.above(0);","});"]}}],"id":"deeda69c-594a-4398-97d7-81b3deb906e7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.healthcaresolutions.net/api/AgentAvailabilityPing?code={Provided by Healthcare Solutions}&id=5905","description":"

Agent Availability Ping

\n

This endpoint pings the Agent Availability service to retrieve real-time agent availability status for a given agent/campaign. It is used to monitor agent availability and call activity for a given campaign.

\n

Base URL: https://api.healthcaresolutions.net/api/AgentAvailabilityPing

\n

Method: GET

\n
\n

Query Parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterValueDescription
code{Provided by Healthcare Solutions}The API authorization code provided by Healthcare Solutions. Required for authenticating the request.
id5905The Finale Expense Campaign ID used to identify agents for availability.
\n
\n

Authentication

\n

Authentication is handled via the code query parameter. This value is provided by Healthcare Solutions and must be included with every request.

\n
\n

Example Request

\n
GET https://api.healthcaresolutions.net/api/AgentAvailabilityPing?code={Provided by Healthcare Solutions}&id=5905\n\n
\n

Response

\n

A successful request returns a 200 OK response with the following JSON body:

\n
{\n    \"availableAgents\": 2\n}\n\n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeDescription
availableAgentsnumberThe number of agents currently available. A value greater than 0 indicates agents are available.
\n

Availability Logic

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
availableAgentsStatus
> 0✅ Agents available
0❌ No agents available
\n

An invalid or missing code parameter will result in a 401 Unauthorized response.

\n","urlObject":{"protocol":"https","path":["api","AgentAvailabilityPing"],"host":["api","healthcaresolutions","net"],"query":[{"key":"code","value":"{Provided by Healthcare Solutions}"},{"key":"id","value":"5905"}],"variable":[]}},"response":[],"_postman_id":"deeda69c-594a-4398-97d7-81b3deb906e7"}]}