Page tree
Skip to end of metadata
Go to start of metadata
This page describes the representation of the resource used by the Fax Service.

Definition

A fax is represented by UnifiedAPI as a Fax resource with the following components.

JSON representation

The example below contains the Fax in JSON representation. All fields are fictitious.

{
   "id":"x",
   "uid":"xxx",
   "recipients":["0003*001"]
}

Fax fields

NameTypeDescription
idNumberId of the fax.
uidStringThe unique Id of the Fax, used in the public fax page.
recipientsArray<UAPI-Extension-Number, UAPI-Phone-Number>The recipients of the Fax.
The numbers may be extended or short (in case of Phone Terminal extensions).

When returning the resource, the Service does not return the fields that have a value equal to NULL.

#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))
  • No labels

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