| Excerpt |
|---|
| 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.
| Code Block |
|---|
{
"id":"x",
"uid":"xxx",
"recipients":["0003*001"]
} |
Fax fields
| Name | Type | Description |
|---|
| id | Number | Id of the fax. |
| uid | String | The unique Id of the Fax, used in the public fax page. |
| recipients | Array<UAPI-Extension-Number, UAPI-Phone-Number> | The recipients of the Fax.
The numbers may be extended or short (in case of Phone Terminal extensions). |
| Note |
|---|
When returning the resource, the Service does not return the fields that have a value equal to NULL. |
Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 4.0 International.