Client Questions on API

msantillo
msantillo
edited April 27, 2018 in Cloud Fax and Notifications #1
  • It says job IDs are eventually invalidated (https://apiforums.easylink.com/emapidocs/26/Common/JobIdType.html); how long until they are invalidated?
  • Is it possible to specify a subject and body text to be added to the fax cover page on each request? Likewise, is it possible to specify a custom sender value per request that will be added to the cover page?
  • JobSubmit allows specifying StopTime as a delivery option. Can StopTime be specified without also specifying StartTime? If so, would that act as a job expiration timer? i.e. if the job is not processed by then, it’ll be canceled?
  • In DocumentType (https://apiforums.easylink.com/emapidocs/26/JobSubmit/DocumentType.html)
    • What is SosObject, DocCfs? DocUrl? Are these all required fields?
    • There is a list of supported document types; do the Excel and Word formats support .xls, .xlsx, .doc, and .docx format files, respectively?
  • JobDeliveryStatus mentions that it can be used to query multiple jobs at once, but that it should be limited to a few at a time (https://apiforums.easylink.com/emapidocs/26/JobDeliveryStatus/JobDeliveryStatus.html). Why and what is meant by “a few”? Is there another API that can be used to query, say, 100 jobs at once?
  • JobState in JobDeliveryStatus lists many possible states
    • Which are the terminal states?
    • What is meant by the purged state?
    • For the Error state, where can we find the error reason\description?
  • Is there any way to query all completed jobs (API and mail2fax) by specifying completed time?
  • Do you have an API for getting Outbound/Inbound job status/statistics?

Comments

  • tgargiulo
    tgargiulo
    #2

     

    It says job IDs are eventually invalidated (https://apiforums.easylink.com/emapidocs/26/Common/JobIdType.html); how long until they are invalidated?

     

    Jobs are purged some time after they complete based on account settings. Typically 3-7 days after completion.

     

     

    Is it possible to specify a subject and body text to be added to the fax cover page on each request? Likewise, is it possible to specify a custom sender value per request that will be added to the cover page?

     

    Yes. A custom sender value can be set on a coverpage per job or destination. Coverpage details vary depending on what the customer is set up to use.

     

     

    JobSubmit allows specifying StopTime as a delivery option. Can StopTime be specified without also specifying StartTime? If so, would that act as a job expiration timer? i.e. if the job is not processed by then, it’ll be
    canceled?

     

    Yes

     

     

    In DocumentType (https://apiforums.easylink.com/emapidocs/26/JobSubmit/DocumentType.html)

    What is SosObject, DocCfs? DocUrl? Are these all required fields?

     

    SosObject could be any object stored in the Stored Object System (SOS) such as banners, email headers/trailers, etc.

     

    DocCfs can be any document stored in the Customer File Store.

     

    These are not required as indicated by “choice” (CHC) in the schema. Using these features may affect job security and performance.

     

     

    There is a list of supported document types; do the Excel and Word formats support .xls, .xlsx, .doc, and .docx format files, respectively?

     

    Yes. This is set as a value in the trans keyword in the profile.

     

     

    JobDeliveryStatus mentions that it can be used to query multiple jobs at once, but that it should be limited to a few at a time (https://apiforums.easylink.com/emapidocs/26/JobDeliveryStatus/JobDeliveryStatus.html). Why and what is meant by “a few”? Is there another API that can be used to query, say, 100 jobs at once?

     

    Generally, 10 jobs may be a safe limit that would not be subject to timeouts. Scheduled Reports can run every 15 minutes if the customer has the need.

     

     

    JobState in JobDeliveryStatus lists many possible states

    Which are the terminal states?

     

    The terminal states are:

    4 Error

    5 Cancelled

    8 Expired

     

    What is meant by the purged state?

     

    The job is no longer accessible on the system.

     

    For the Error state, where can we find the error reason\description?

     

    The Error Code and Message will be returned.

     

    Is there any way to query all completed jobs (API and mail2fax) by specifying completed time?

    JobList can be used to get a list of jobs (all kinds) that completed within a given period (using JobCompleteWindow). This will return the job status, not their delivery status. If delivery status is needed, individual status would need to be requested. Also, the job completion time will not match final delivery time.

     

    Another option would be to setup a scheduled event report to gather job details that can be delivered via email, ftp, or webservice push.

     

     

    Do you have an API for getting Outbound/Inbound job status/statistics?

     

    There is no API that provides an overall picture of job status/statistics. A scheduled report may provide the statistical data they may require.

Categories