Web Search

Web Search

About this guide

Product support and assistance

Essential information about Production Messaging

Switch types and domain types

Test and production domains

Production domain

APIs and security

Customer file store

Sample tasks using Messaging APIs

Send outbound faxes

Receive inbound faxes

Web Services Delivery Agent

Send basic and enhanced emails

Send voice messages

Send SMS messages

Receive reports for submitted jobs

Obtain job delivery status

Quick start to developing API applications

JobSubmit (fax)

Development steps for JobSubmit API to send a fax

1. Set user credentials.

2. Set any desired options.

3. Set up documents.

4. Provide content.

5. Provide destinations.

6. Launch the job

7. Check the results and extract data for further processing.

8. Review the results of the job request in the result.xml file.

Application design considerations

Runtime access to WSDL

Job status requests

Walk-through of JobSubmit API application using Microsoft Visual Studio

Stage 1: Obtain an EasyLink test account on the test domain

Stage 2: Ensure your application development environment is available to develop a SOAP API client application.

Stage 3: Create a project and add a Web reference

Stage 4: Prepare the documents to fax

Stage 5: Use the sample code in your project to invoke the JobSubmit API to submit a fax job to OpenText.

JobDeliveryStatus (detailed job information and its deliveries)

JobDeliveryStatus sample code (C# and Java)

Additional code samples

Frequently asked questions

What are domains, switch types, and URLs

What are job states and item states?

What are completion time, posted time, and last attempt time?

How do I check job status after submitting a job?

Get the current status of a job

Get the status of items in a job

How many JobIDs per request can be included for JobDelivery Status or JobSummary?

Can I push status to my own service?

Can I get all sent JobIDs by user or between timestamps?

Can I encrypt the password before calling the SOAP API?

What is message content and how is it structured?

Where can I find report status mapping information?

Can I receive inbound faxes?

Is there a Web service push available for delivery status?

Why does the JobDeliveryStatus API return “No information available”?

Is there a time limit for re-sending jobs?

Can I choose a platform, such as MessageREACH or XDDS, to process a message?

Does a phone number need to specify a country code?

Can 8.5 x 14 inch documents be delivered as faxes?

Can I send multiple files in one fax submission?

Can I customize fax cover sheets?

Does Production Messaging accept large PDFs (over 1000 pages)?

Can I customize the pilotline?

Does DeliveryRetryPattern suppress attempts to retry failed fax transmissions?

What are fax call detail records (CDR)?

Can I fax more than one document at a time?

Can the same document be sent to multiple fax numbers in a single call?

Can font attributes be set for an outbound fax?

Can the email subject vary for each email recipient?

Do emails support multi-byte languages?

Is there a limit to an email message job?

What is a voice job?

What is text-to-speech (TTS) template?

How do I create a TTS template?

What is a voice script?

Can several voice files be uploaded & played in sequence to generate a single message?

Additional API samples

JobSubmit (enhanced email)

JobSubmit (voice)

JobSubmit (SMS messages)

QueuedDocumentRetrieve & QueuedDocumentRelease (retrieve incoming fax from a queue)

JobSubmit sample code to send a fax request (Java)

JobSubmit sample code to send a fax request (VB)

Service descriptions

Sample XML files

JobSubmit API application to send faxes

Request.xml file

Result.xml file

JobDeliveryStatus API application to get fax job status

Result.xml file (successful delivery)

Result.xml file (unsuccessful delivery)