Cloud Fax and Notifications API 2.4 Documentation
JobDetail
Cloud Fax and Notifications API Forums Home  
    prev  next        Table of Contents  JobDetail  
These pages describe an earlier version of the Cloud Fax and Notifications API.
While that version continues to function, new development should use the current version.
 

25.3 Common Delivery Item-Level Keywords

JobDetailRequest   JobDetailResult

There are many data fields associated with each delivery item. This table shows the ones commonly of interest to users that can be used in the RequestedDeliveryDetails element of a JobDetailRequest. The equivalent element in a JobDeliveryStatusResult is also shown, where applicable.

Field Keyword Description JDS Element
addr_type
destination_type
Indicates the type of destinaton. See DestinationType. Destination@type
alt_xfer_addr Specifies the hot key transfer number used by this recipient. AlternateTransferNumber
att The attention string used for this destination. Att
attempt The delivery attempt number - only useful when attempt logging is active.  
baud_rate The delivery baud rate, if applicable. BaudRate
cover_page_count Number of pages in coverpage. CoverPageCount
cum_time
raw_cumulative_units
The number of applicable delivery units from all delivery attempts. This will be the un-rounded value. RawCumulativeUnits
cumulative_units Indicates the number of applicable delivery units from all delivery attempts. Note that this value include the rounding adjustment, if any, that can be expected to apply for billing purposes. CumulativeUnits
delivery_status
gamma_code
Numeric code that may provide more detailed status information, mainly applicable to the Error state. DeliveryDetail@gammacode
delivery_time
last_attempt
Time of last delivery attempt. LastAttemptTime
delivery_units Indicates the number of applicable delivery units from the last delivery. Note that this value will include the rounding adjustment, if any, that can be expected to apply for billing purposes. DeliveryUnits
direction Direction of delivery attempt - 'O' (outbound) or 'I' (inbound).  
doc_page_count Pages in document. DocumentPageCount
fast_forward_count Number of times a voice delivery recipient pressed the "fastforward" key. FastForwardCount
faxto The recipient name or subject used for this destination. FaxTo
first_attempt Time of first delivery attempt. FirstAttemptTime
list List name. ListId
localized_to The delivery address in the EasyLink domain local format. LocalizedDestination
localized_type Indicates the type of destinaton. See DestinationType. LocalizedDestination@type
match_statusN Indicates the status of Exact Match Validation in Voice Scripts. N  may be 0 to 7. MatchStatus
message_replay_count Number of times a voice delivery recipient pressed the "message replay" key. MessageReplayCount
opt_out Number of times a voice delivery recipient pressed the "opt-out" key. VoiceOptOut
pause_count Number of times a voice delivery recipient pressed the "pause" key. VoicePauseCount
primary_alt If delivery was made to an alternate destination, this will indicate which level of alternate address this delivery information applies to. PrimeAlt
ref The Ref value for the destination, sometimes used as an identifier for the destination. Ref
retries Number of delivery attempts made. Attempts
rewind_count Number of times a voice delivery recipient pressed the "rewind" key. RewindCount
state Indicates the current state of this destination. The value will be one of
  • Pending
  • Submitted
  • InProcess
  • Error
  • Cancelled
  • Held
  • Sent
  • Expired
State
state_code A number corresponding to the state.
1Pending
2Submitted
3InProcess
4Error
5Cancelled
6Held
7Sent
8Expired
State@code
to
destination
The delivery address in normalized form. Destination
units
raw_delivery_units
Indicates the type of unit. May be:
  • seconds
  • pages
  • bytes
RawDeliveryUnits
xfer_number_used Specifies the first hot key transfer number associated with this job. TransferNumber
xqn An identifying number within a delivery group. DeliveryDetail@xqn

Other fields ("UDDRS" values) may be available for specialized applications.

 
    prev  next        Table of Contents  JobDetail  
© 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