Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated using 4PSA automated script
Excerpt

This section describes the UnifiedAPI requests used to manipulate Extensions.

Overview

The Extension Services are used to manage and list phone call events, fetch the registration status of an extension, and manipulate the status of queue agents.

The Service is available to Apps registered to the following account types:

  • Administrator
  • Organization
  • User

Requests

Phone Call Events

This service allows you to add call events for an Extension. These events are executed every time an Extension receives, closes, or sends a call.

NameREST URIDescription
Create

Status
colourYellow
titlepost

/extensions/userId/extensionNumber/phoneCallEvents/

Creates a new phone call event.
Update

Status
colourYellow
titleput

/extensions/userId/extensionNumber/phoneCallEvents/phoneCallEventId

Updates a phone call event.
List

Status
colourGreen
titleget

/extensions/userId/extensionNumber/phoneCallEvents

Lists all the phone call events.
Delete

Status
colourRed
titledelete

/extensions/userId/extensionNumber/phoneCallEvents/phoneCallEventId

Deletes an phone call event.

Presence

This service allows you to check the registration status of an Extension.

NameREST URIDescription
List

Status
colourGreen
titleget

/extensions/userId/extensionNumber/presence

List the status and the type of phone where the extension is registered.

Queue Agent

This service allows you to log in, log out, and pause queue agents.

NameREST URIDescription
Update

Status
colourYellow
titleput

/extensions/userId/extensionNumber/queueAgent/agentId

Logs in or logs out a queue agent.
List

Status
colourGreen
titleget

/extensions/userId/extensionNumber/queueAgent

List the all the statues of a queue agent.

4psarelated
NameRelated Topics

Service Discovery

PhoneCalls Service

CDR Service

Faxes Service

Demo Apps

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.