Page tree

Versions Compared

Key

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

Excerpt
This page describes the UnifiedAPI PhoneCallEvent Service.
Table of Contents
maxLevel2

Why use the service

The PhoneCallEvent Service is used to assign the following events to an Extension:

  • Dial-In occurs when a call is received by an extension.
  • Dial-Out occurs when a call is placed by an extension.
  • Hangup occurs when a call the extension is involved in is terminated.

More details about the events can be found in the Call Events section.

Who can use the service

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

  • Administrator
  • Organization
  • User

Requests

Name

REST URI

Description

Create

Status
colourYellow
titlepost

/extensions/userId/extensionNumber/phoneCallEvents/

This request allows an App to assign new call events on an Extension.
Update

Status
colourYellow
titleput

/extensions/userId/extensionNumber/phoneCallEvents/phoneCallEventId

This request allows an App to update the properties of events.

List

Status
colourGreen
titleget

/extensions/userId/extensionNumber/phoneCallEvents

This request allows an App to list existing phone call events that are assigned to an Extension.
Delete

Status
colourRed
titledelete

/extensions/userId/extensionNumber/phoneCallEvents/phoneCallEventId

This request allows an App to delete phone call events.

4psarelated
NameRelated Topics

Presence Service

QueueAgents Service

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