 | Cloud Fax and Notifications API 2.5 Documentation JobDeliveryStatus | Cloud Fax and Notifications API Forums Home |
24.3 JobDeliveryStatusResult | JobDeliveryStatus Overview JobDeliveryStatusRequest |
| Tag Name & type | # | Description | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| JobDeliveryStatusResult | Namespace of this element is http://ws.easylink.com/JobDeliveryStatus/2011/01 | ||||||||||||||||||||
| Status StatusType | 1 | Status of processing. See StatusType. | |||||||||||||||||||
| SubmitId xs:string | 0-1 | Echoes the SubmitId in the request, if one was provided, and if possible. | |||||||||||||||||||
| JobDeliveryStatus JobDeliveryStatusType | 0- | Providing that the request could be processed, there will be one JobDeliveryStatus element for each job specified in the request. | |||||||||||||||||||
| JobId JobIdType | 1 | The job id in the original request whose data is contained in this JobDeliveryStatus. See JobIdType. | |||||||||||||||||||
| RecStatus RecStatusType | 1 | Status of the attempt to retrieve data for this particular job. Note that retrieval of delivery status for any particular job may succeed or fail independently of others. RecStatus will have special text values to indicate whether all of the available records were returned ("LAST_IN_XDN_NO_MORE"), or if the number of records returned was limited due to a NumToRetrieve limit ("LAST_IN_XDN_MORE"). See RecStatusType. | |||||||||||||||||||
| JobData JobDataType | 0- | Contains the delivery status result for a job associated with the requested JobId. For normal jobs, this will be the job itself. For group jobs, there may be multiple JobData elements for each job in the group. | |||||||||||||||||||
| JobId JobIdType | 1 | Identifies the job whose data is contained in this JobData element. This will only differ from the JobId child of JobDeliveryStatus if it is a member of a job group. | |||||||||||||||||||
| BillingCode EncodableStringType | 0-1 | Job's billing code. See EncodableStringType. | |||||||||||||||||||
| CustomerReference EncodableStringType | 0-1 | Job's customer reference. See EncodableStringType. | |||||||||||||||||||
| DeliveryPriority xs:string | 0-1 | Indicates the scheduling used for the job. Valid values include:
| |||||||||||||||||||
| StartTime xs:dateTime | 0-1 | Time the job was scheduled to start. | |||||||||||||||||||
| EntryTime xs:dateTime | 1 | Time the job entered the system. | |||||||||||||||||||
| ExpirationTime xs:dateTime | 0-1 | Time at which messageREACH® jobs actually complete. Post-delivery activity, e.g. pull events, are possible may occur until this time. | |||||||||||||||||||
| Subject EncodableStringType | 0-1 | Job-level subject string. See EncodableStringType. | |||||||||||||||||||
| TransferNum TransferNumType | 0- | Phone number and extension (if present) for a hot-key transfer. | |||||||||||||||||||
| @transferKey xs:string | 0-1 | Telephone key number associated with the transfer number. | |||||||||||||||||||
| ListsUsed | 0-1 | Identifies the stored lists (if any) used with the job. | |||||||||||||||||||
| ListId ListIdType | 1- | List identifier. See ListIdType. | |||||||||||||||||||
| UserId xs:string | 0-1 | The user ID associated with this job. | |||||||||||||||||||
| PostedTime xs:dateTime | 0-1 | The time the job completed posting, i.e. all primary deliveries completed. | |||||||||||||||||||
| CompletionTime xs:dateTime | 0-1 | Job's completion time. | |||||||||||||||||||
| JobState xs:string | 0- | Indicates the job's current state. Valid values for the JobState element are:
| |||||||||||||||||||
| DestinationCount xs:integer | 0-1 | The number of primary destinations for this job. | |||||||||||||||||||
| ServiceType xs:string | 0-1 | The EasyLink system will attempt to associate jobs with various service types, reflecting the general nature of the job (fax, email, voice, etc.). Possible values include but are not limited to:
| |||||||||||||||||||
| Fax2MailService xs:string | 0-1 | Indicates the type of fax2mail service: F2M or M2F (case insensitive) | |||||||||||||||||||
| JobGroupStatus JobGroupStatusTypeType | 0-1 | If the job is associated with a job group, this will indicate whether it is the job group head ("parent") or a member of the group ("child") | |||||||||||||||||||
| Preview xs:boolean | 0-1 | true if fax preview was requested for this job | |||||||||||||||||||
| PreviewResult xs:string | 0-1 | Indicates the result of a fax preview. Possible values include:
| |||||||||||||||||||
| ComplianceResult xs:string | 0-1 | Indicates the result of a compliance review. Possible values include:
| |||||||||||||||||||
| JobFlags xs:integer | 0-1 | integer representation of a 32-bit mask of job flags | |||||||||||||||||||
| JobFlags2 xs:integer | 0-1 | integer representation of extended bit mask of job flags | |||||||||||||||||||
| JobWasPaused xs:boolean | 0-1 | boolean indicating whether job was paused at some point in processing | |||||||||||||||||||
| FaxCoverSheet xs:boolean | 0-1 | boolean indicating whether a coversheet was requested for this job | |||||||||||||||||||
| Att EncodableStringType | 0-1 | Job-level Att value (destination-level value may also exist). See EncodableStringType. | |||||||||||||||||||
| FaxTo EncodableStringType | 0-1 | Job-level FaxTo value (destination-level value may also exist). See EncodableStringType. | |||||||||||||||||||
| EmailFrom EncodableStringType | 0-1 | The "from" display name used in an enhanced email job. See EncodableStringType. | |||||||||||||||||||
| Filename EncodableStringType | 0-1 | Filename associated with this job. See EncodableStringType. This value will be base64-encoded (with "binary" b64charset) if the UseBinary option was specified, or if conversion to UTF-8 was unsuccessful. | |||||||||||||||||||
| FaxMode FaxModeType | 0-1 | If applicable, the fax mode ("standard" or "fine") used for delivery | |||||||||||||||||||
| Class xs:string | 0-1 | The EasyLink delivery class: bcast or p2p (case insensitive) | |||||||||||||||||||
| GroupName xs:string | 0-1 | Specifies the user's primary Fax2Mail "group name" | |||||||||||||||||||
| CharacterSet xs:string | 0-1 | Specifies the default job-level character set | |||||||||||||||||||
| Paced xs:boolean | 0-1 | Boolean indicating whether a voice job was paced | |||||||||||||||||||
| DeliveryPaces xs:string | 0-1 | Names of the delivery paces associated with this job. | |||||||||||||||||||
| FaxInFaxID xs:string | 0-1 | The TSID from the fax machine submitting an "instruction sheet" job | |||||||||||||||||||
| FaxInDNIS xs:string | 0-1 | The fax number used for submission of an "instruction sheet" job. | |||||||||||||||||||
| FaxInConnectTime xs:int | 0-1 | The duration of an "instruction sheet" job submission in seconds. | |||||||||||||||||||
| FaxInPageCount xs:int | 0-1 | The number of fax pages received by EasyLink from an "instruction sheet" job submission | |||||||||||||||||||
| AreaCodeRecipOmitted xs:string | 0-1 | The number of addresses from the original recipient list(s) that were not delivered due to area code filtering | |||||||||||||||||||
| RetryAlgorithm xs:string | 0-1 | Name (usually numeric) of the retry pattern used for this job | |||||||||||||||||||
| DropCopyFrom EncodableStringType | 0-1 | The "from" field that will appear on a "drop copy" message. | |||||||||||||||||||
| DropCopyTo EncodableStringType | 0-1 | Destination to which a "drop copy" message was sent. | |||||||||||||||||||
| RecipientLocaleStartTime xs:dateTime | 0-1 | If the RecipientLocaleStartTime option was used for the job, this value represents the local clock time used as the start time for delivery. Note that this value will not have a "timezone" portion. | |||||||||||||||||||
| ExtendedJobData ExtDataType | 0-1 | If extended data is available and requested, it will be returned in this element. | |||||||||||||||||||
| ExtSegment | 1- | Contains extended data fields from a particular segment. | |||||||||||||||||||
| @name xs:string | 0-1 | Name of the segment or data group of the data field being returned. (Optional - some data fields may not belong to a segment.) | |||||||||||||||||||
| ExtProp ExtPropType | 1- | Container for one data field value | |||||||||||||||||||
| @name xs:string | 0-1 | Name of the extended data field. | |||||||||||||||||||
| @idnum xs:string | 0-1 | Identifying number (if any) of the extended data field. | |||||||||||||||||||
| ExtString EncodableStringType | 1 | Used if extended data is represented as a character string. See EncodableStringType. | |||||||||||||||||||
| ExtNumber xs:decimal | 1 | Used if extended data is known to be a number | |||||||||||||||||||
| ExtDateTime xs:dateTime | 1 | Used if extended data is known to be a date/time. | |||||||||||||||||||
| DeliveryGroup DeliveryGroupType | 0- | Deliveries associated with the job are assigned to different types of delivery groups depending on whether they are primary destinations specified for the job, or job reports, or friend reports. Unless the request contains an allDeliveryGroups setting of "true", there will only be one DeliveryGroup elements for normal deliveries. Otherwise, there may be DeliveryGroup elements containing the other types of deliveries. | |||||||||||||||||||
| @type DGroupType | 1 | Indicates the type of the delivery group. Leval values are:
| |||||||||||||||||||
| DeliveryGroupId xs:int | 1 | Numeric identifier for distinct delivery groups. | |||||||||||||||||||
| Att EncodableStringType | 0-1 | Attention string. See EncodableStringType. | |||||||||||||||||||
| AttachmentInfo AttachmentInfoType | 0- | Contains information about attached documents. | |||||||||||||||||||
| @attachmentNum xs:int | 1 | Numeric identifier of attachment. | |||||||||||||||||||
| FileName xs:string | 1 | Filename of attachment. Conversion to UTF-8 is necessary to return this value, and the substitution character (xFFFD) may be substituted for portions of the filename where conversion is unsuccessful. | |||||||||||||||||||
| Size xs:integer | 1 | Size of file in bytes. | |||||||||||||||||||
| AttachmentFlags AttachmentFlagsType | 0- | Strings that may indicate the nature and use of the attachment. May have values:
| |||||||||||||||||||
| Security SecurityType | 0-1 | Indicates degree of encryption. May have values:
| |||||||||||||||||||
| ContentType xs:string | 0-1 | Indicates type of attachment document (a MIME type) | |||||||||||||||||||
| TotalPulls xs:integer | 0-1 | Total number of times this attachment has been "pulled" | |||||||||||||||||||
| DistinctPulls xs:integer | 0-1 | Number of distinct destinations for which the attachment has been "pulled" | |||||||||||||||||||
| DeliveryDetail DeliveryDetailType | 0- | This element contains the actual detailed delivery information for a single destination, and one will be present for each destination. | |||||||||||||||||||
| @xqn xs:int | 1 | A numeric identifier for each destination in the DeliveryGroup. | |||||||||||||||||||
| Ref EncodableStringType | 0-1 | The Ref value for the destination, sometimes used as an identifier for the destination. See EncodableStringType. | |||||||||||||||||||
| InputDestination DestinationType | 0-1 | Since addresses are sometimes normalized during processing of the job, this element will contain the originally supplied value of the address. See DestinationType. | |||||||||||||||||||
| Destination DestinationType | 1 | The delivery address in normalized form. See DestinationType. | |||||||||||||||||||
| State StateType | 1 | Indicates the current state of this destination. The value will be one of
| |||||||||||||||||||
| @code StateCodeType | 1 | A number corresponding to the state.
| |||||||||||||||||||
| @gammacode xs:int | 0-1 | Optional code that may provide more detailed status information, mainly applicable to the Error state. EasyLink can provide a table of these error codes and their meaning. Only non-zero values are returned. | |||||||||||||||||||
| PrimeAlt xs:int | 0-1 | If delivery was made to an alternate destination, this will indicate which level of alternate address this delivery information applies to. | |||||||||||||||||||
| ListId ListIdType | 0-1 | Indicates the list from which this destination was taken for this job. See ListIdType. For destinations not taken from a list, a value of "adhoc" may appear here. | |||||||||||||||||||
| CoverPageCount xs:int | 0-1 | Pages in coverpage | |||||||||||||||||||
| DocumentPageCount xs:int | 0-1 | Pages in document. | |||||||||||||||||||
| FirstAttemptTime xs:dateTime | 0-1 | Time of first delivery attempt. | |||||||||||||||||||
| LastAttemptTime xs:dateTime | 0-1 | Time of last delivery attempt. | |||||||||||||||||||
| Attempts xs:int | 0-1 | Number of delivery attempts made. | |||||||||||||||||||
| DeliveryUnits | 0-1 | 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. | |||||||||||||||||||
| @unit DeliveryUnitType | 1 | Indicates the type of unit. May be:
| |||||||||||||||||||
| RawDeliveryUnits | 0-1 | Indicates the number of applicable delivery units from the last delivery. This will be the un-rounded value. | |||||||||||||||||||
| @unit DeliveryUnitType | 0-1 | Indicates the type of unit. May be:
| |||||||||||||||||||
| CumulativeUnits | 0-1 | 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. | |||||||||||||||||||
| @unit DeliveryUnitType | 1 | Indicates the type of unit. May be:
| |||||||||||||||||||
| RawCumulativeUnits | 0-1 | The number of applicable delivery units from all delivery attempts. This will be the un-rounded value. | |||||||||||||||||||
| @unit DeliveryUnitType | 0-1 | Indicates the type of unit. May be:
| |||||||||||||||||||
| BaudRate xs:int | 0-1 | Indicates the delivery baud rate, if applicable. | |||||||||||||||||||
| Att EncodableStringType | 0-1 | The attention string used for this destination. See EncodableStringType. | |||||||||||||||||||
| FaxTo EncodableStringType | 0-1 | The recipient name or subject used for this destination. See EncodableStringType. | |||||||||||||||||||
| SMSShortCode xs:string | 0-1 | The short code, if any, associated with an SMS delivery. | |||||||||||||||||||
| LocalizedDestination LocalizedDestinationType | 0-1 | The delivery address in the EasyLink domain local format. | |||||||||||||||||||
| @type AddressType | 0-1 | Indicates the address type. Same values as for DestinationType. | |||||||||||||||||||
| MessageReplayCount xs:int | 0-1 | Number of times a voice delivery recipient pressed the "message replay" key | |||||||||||||||||||
| FastForwardCount xs:int | 0-1 | Number of times a voice delivery recipient pressed the "fastforward" key | |||||||||||||||||||
| RewindCount xs:int | 0-1 | Number of times a voice delivery recipient pressed the "rewind" key | |||||||||||||||||||
| VoicePauseCount xs:int | 0-1 | Number of times a voice delivery recipient pressed the "pause" key | |||||||||||||||||||
| VoiceOptOut xs:string | 0-1 | Number of times a voice delivery recipient pressed the "opt-out" key | |||||||||||||||||||
| TransferNumber xs:string | 0-1 | Specifies the first hot key transfer number associated with this job. | |||||||||||||||||||
| AlternateTransferNumber xs:string | 0-1 | Specifies the hot key transfer number used by this recipient. | |||||||||||||||||||
| HotKeyTransferTimeToConnect xs:integer | 0-1 | Call duration (sec) from the time the transfer was requested by the recipient through the time when the call is answered by an operator. | |||||||||||||||||||
| MatchStatus xs:string | 0-8 | Indicates the status of Exact Match Validation in Voice Scripts | |||||||||||||||||||
| ExtendedDeliveryData ExtDataType | 0-1 | Contains requested extended delivery data, if available. | |||||||||||||||||||
| ExtSegment | 1- | Contains extended data from a particular segment. | |||||||||||||||||||
| @name xs:string | 0-1 | Name of the segment or data group of the data field being returned. (Optional - some data fields may not belong to a segment.) | |||||||||||||||||||
| ExtProp ExtPropType | 1- | Container for one data field value | |||||||||||||||||||
| @name xs:string | 0-1 | Name of the extended data field. | |||||||||||||||||||
| @idnum xs:string | 0-1 | Identifying number (if any) of the extended data field. | |||||||||||||||||||
| ExtString EncodableStringType | 1 | Used when the value is represented as a string. See EncodableStringType. | |||||||||||||||||||
| ExtNumber xs:decimal | 1 | Used when the value is represented as a number (integer or floating point) | |||||||||||||||||||
| ExtDateTime xs:dateTime | 1 | Used when the value is represented as a date/time. | |||||||||||||||||||
| Events EventsType | 0-1 | Contains information for events that may be recorded concerning this destination. (This data only applies to jobs handled by messageREACH®) | |||||||||||||||||||
| ArrivalEvent ArrivalEventType | 0- | Record of receipt of a Delivery Status Notification (DSN) for this item. See RFC 2822 for details on the DSN components. | |||||||||||||||||||
| ArrivalTime xs:dateTime | 1 | Time when the DSN was received | |||||||||||||||||||
| Class xs:string | 1 | Numeric DSN status class | |||||||||||||||||||
| Subject xs:string | 1 | Numeric DSN subject | |||||||||||||||||||
| Detail xs:string | 1 | Numeric DSN detail | |||||||||||||||||||
| RemovalEvent RemovalEventType | 0-1 | Record of a removal request (request for an address block) by the recipient of this item. | |||||||||||||||||||
| RemovalTime xs:dateTime | 1 | Time the removal request was processed. | |||||||||||||||||||
| Reason xs:string | 1 | Code indicating the interface used to process the removal request.
| |||||||||||||||||||
| PullEvent PullEventType | 0- | Record of a document pull event. | |||||||||||||||||||
| @attachmentNum xs:int | 1 | Indicates which attachment was pulled. (A value of -1 indicates a retrieval of the HTML open tracking image) | |||||||||||||||||||
| PullTime xs:dateTime | 1 | Time the document was pulled. | |||||||||||||||||||
| © 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 |