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 PhoneCall Service.


Children Display

Overview

The PhoneCall Service is used for real-time phone calls management. It allows making new phone calls, hanging up ongoing phone calls, transferring, recording, putting phone calls on hold, etc.

This service is available to Apps registered to the following account types:

  • Administrator
  • Organization
  • User

Requests

Requests are sent to the Service by an App that is registered to an account. If successful, these requests return the required resources.

TypeREST URIDescription
Create

Status
colourYellow
titlePOST

/phoneCalls/userId/

This request allows an App to create new simple phone calls, conference and callback phone calls.
Update

Status
colourYellow
titlePUT

/phoneCalls/userId/extensionNumber/phoneCallId

This request allows an App to transfer calls to another party or to voicemail, record them, park or put on hold ongoing phone calls.
List

Status
colourGreen
titleGET

/phoneCalls/userId/extensionNumber/phoneCallId

This request allows an App to fetch the list of calls that are in the system.
Delete

Status
colourRed
titleDELETE

/phoneCalls/userId/extensionNumber/phoneCallId

This request allows an App to hang up an ongoing call.

4psarelated
NameRelated Topics

CDR Service

Extensions Services

Faxes Service

Demo Apps

Service Discovery

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