Create Agent Subscription

Create a subscription to receive events on any update to an Hunt Groups values

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

Post Overview

ParametersDescription
device_aorSIP URI of device in Hunt group
huntgroup_nameThe name of the hunt group. This will match the name of a queue as well.
huntgroup_domainDomain of the Hunt group
entry_optionBehavior of the agents availability. "manual" requires additional interaction to make an agent available when unavailable while "immediate" automatically makes the agent available after each call.
wrap_up_secTime after a call where agent will not receive another call.
auto_ansWill update SIP headers to tell SIP UA's to automatically answer if they support this feature
entry_orderOrder In which the hunt group will dispatch calls to it's agents
entry_priorityPriority of the agent in the queue. Mostly used for cascading ring groups
call_limitNumber of simultaneous calls an agent can take at once
confirm_requiredWhen an agent answers, they will be prompted to press 1 to take the call.
entry_deviceThe type of the device
entry_statusThe status of the agent, "available", "unavailable"
owner_userThe Subscriber that owns the device
owner_domainDomain of the agent
session_countNumber of current calls agent is handling
error_infoTells if there are any current errors with the agent.
last_updateLast time this hunt group was updated.
Form Data
string
required

Must be "agent". This will update when the status of a call center agent changes.

string
required

Specify which domain you would like to receive events for. Use * to receive events for all domains.

string
required

Specify which user to receive events for. Use * to receive for all users

string
required

HTTP or HTTPS endpoint. This is where Netsapiens will POST the events

date
required

Specifies when the subscription will expire. (Set date a couple days in the future as server time calculates the expiration incorrectly)

Responses

Language
Credentials
LoadingLoading…
Response
Choose an example:
application/json