/api/agent-status Endpoint

Endpoint:

URL:https://agentpings.com/api/agent-status

Methods: GET, POST

Description:

This endpoint checks if an agent is available for a given phone number's area code and vertical.

Parameters:

• phone: (Optional) Phone number. Cannot be provided if state or zip is already provided.
• zip: (Optional) ZIP code. Cannot be provided if phone or state is already provided.
• state: (Optional) State code (2 characters) or full state name. Cannot be provided if phone or zip is already provided.
• vertical: (Required) Vertical. Valid values: auto_insurance, final_expense, u65_health, aca, medicare.
• affiliate_id: (Required) Identifier for the affiliate.
• api_key: (Required) API key associated with the affiliate.

Note: One of phone, zip, or state is required for the request.

Response:

200 OK

{
    "online": true
}
            

online: true if the agent is available, false otherwise.

Examples:

GET https://agentpings.com/api/agent-status?phone=1234567890&vertical=auto_insurance&affiliate_id=YOUR_AFFILIATE_ID&api_key=YOUR_API_KEY

{
    "online": true
}