Job Delivery Status Request Extended Data

paramr

Hello,

I am using the JobDeliveryStatus API to access delivery status information on my fax jobs. The basic data being returned is fine and just contains high level status information. I would like additional detail specifically on fax failures. I am assuming if I request extended data I will get this information? Where can I get a list of attribute names available to submit in IncludedExtendedDeliveryData property of JobDeliveryStatusRequest?

 

Thanks,

Param

skamens

The detail for each individual item is already returned as part of the result you get.  You don't need to use any Extended Delivery Data.

Within the result you should have an element called <DeliveryGroup>, which contains the results - here's a sample of what it looks like:

<DeliveryGroup type="Normal">
                        <DeliveryGroupId>2</DeliveryGroupId>
                        <DeliveryDetail xqn="1">
                            <Ref> </Ref>
                            <Destination type="fax">8775551212</Destination>
                            <State code="7">Sent</State>
                            <PrimeAlt>0</PrimeAlt>
                            <ListId liststore="XDDS" ownership="user">adhoc</ListId>
                            <CoverPageCount>1</CoverPageCount>
                            <FirstAttemptTime>2012-08-21T17:47:50.000Z</FirstAttemptTime>
                            <LastAttemptTime>2012-08-21T17:48:36.000Z</LastAttemptTime>
                            <Attempts>1</Attempts>
                            <DeliveryUnits unit="seconds">53</DeliveryUnits>
                            <RawDeliveryUnits unit="seconds">53</RawDeliveryUnits>
                            <CumulativeUnits unit="seconds">53</CumulativeUnits>
                            <RawCumulativeUnits unit="seconds">53</RawCumulativeUnits>
                            <BaudRate>14400</BaudRate>
                            <Att>test fax for me</Att>
                            <FaxTo> </FaxTo>
                            <LocalizedDestination type="fax">8775551212</LocalizedDestination>
                        </DeliveryDetail>
                    </DeliveryGroup>

The place to look for extended status would be the <State> element.  If there is a failure, it will include an attribute called "gammacode" - something like this:

<State code="4" gammacode="3931">Error</State>

This indicates that an error occured, with a gamma code (essentially a detailed status code) of "3931".  These codes are documented here: https://apiforums.easylink.com/content/gamma-codes . In this case, the code in question means that the receiving fax machine was busy.