 | Cloud Fax and Notifications Account API 2.6 Documentation FaxNumberAdd | Cloud Fax and Notifications API Forums Home |
10.2 FaxNumberAddRequest | FaxNumberAdd Overview FaxNumberAddResult |
If neither FaxDNIS or FaxPrefix is included in the request, then an arbitrary number will be selected from the available pool.
| Tag Name & type | # | Description | ||||
|---|---|---|---|---|---|---|
| FaxNumberAddRequest | Namespace of this element is http://ws.easylink.com/FaxNumberAdd/2013/06 | |||||
| SubmitId xs:string | 0-1 | Optional string id which is used to identify the request | ||||
| F2MUser UserAliasType | 1 | The user for which we want to add a FAX number. See UserAliasType. | ||||
| FaxDNIS xs:string | 1 | A complete fax number (10 to 18 digits.) If this DNIS is available, it will be assigned, otherwise the request will fail. | ||||
| FaxPrefix FaxPrefixType | 1 | If this is included, the set of available numbers will be searched for a match, and if one is found, then it will be assigned. | ||||
| CountryCode xs:string | 1 | Specifies the country code to match when selecting a fax number. | ||||
| RegionCode xs:string | 1 | Specifies the region (geographical location within the country, for example, an area code) to which the Fax Number should belong to. | ||||
| TollFree xs:boolean | 1 | Specifies whether the number must be toll free or not. | ||||
| DNISGroup xs:long | 0-1 | The entity number associated with a pool of available numbers. If specified, it must be a group entity above the target user in the account hierarchy. If this is specified, then only this group and those above it will be checked for an available number and if a number is obtained from the general pool, it will be added to this group. If DNISGroup is not specified, then all groups above the target user are checked for a match, and if a new number is obtained, it will be added to the immediate parent group. | ||||
| AllowDNISAddition xs:boolean | 0-1 | If present and "true", and if no matching number is found in the pre-assigned groups, then the general pool of numbers not yet assigned to customers is looked at for a match. If a match is found, then it will be assigned to the new user's parent group (or DNISGroup if specified). Note that obtaining a new number incurs a charge. | ||||
| FaxNumberAddExtensions ExtensionType | 0-1 | |||||
| Segment SegmentType | 1- | |||||
| @name xs:string | 0-1 | |||||
| Property | 1- | |||||
| @name xs:string | 1 | |||||
| @b64charset xs:string | 0-1 | |||||
| © Copyright 2020 OpenText Corp. All Rights Reserved. Privacy Policy | Cookie Policy |
This information is subject to change. Please check frequently for updates. Modified October 06, 2020 |