#Building A Request
To use Monopond SOAP Ruby Client, start by including the MonopondSOAPClient.rb (line 1) then creating an instance of the client by supplying your credentials (line 4). Your username and password should be enclosed in quotation marks. Monopond SOAP Ruby Client uses the following gems: savon and builder. Please check the Gemfile is included.
require_relative ‘monopondSOAPClient’
// TODO: Enter your own credentials here
@wsseToken = WSSEToken.new('username', 'password')
@client = MonopondSOAPClientV2.new(@wsseToken, MPENV::LOCAL)
// TODO: Set up your request here#SendFax ###Description This is the core function in the API allowing you to send faxes on the platform.
Your specific faxing requirements will dictate which send request type below should be used. The two common use cases would be the sending of a single fax document to one destination and the sending of a single fax document to multiple destinations.
###Sending a single fax: To send a fax to a single destination a request similar to the following example can be used:
// TODO: Setup Document
// ’filename’, ‘base64’
@document = MonopondDocument.new('test.txt','VGhpcyBpcyBhIGZheA==')
@document.order = 0
// TODO: Setup FaxMessage
// ‘messageRef’, ‘sendTo’
@faxMessage = MonopondFaxMessage.new('msg-ref-1', '6011111111')
@faxMessage.sendFrom = 'Test Fax'
@faxMessage.resolution = 'normal'
@faxMessage.retries = 0
@faxMessage.busyRetries = 2
// TODO: Setup FaxSendRequest
@faxMessages = []
@faxMessages << @faxMessage
@documents = []
@documents << @document
@request = MonopondSendFaxRequest.new(@faxMessages, @documents)
@request.resolution = 'fine'
@request.broadcastRef = "broadcast-ref-1"
// Call sendFax method
@sendRespone = @client.sendFax(@request)###Sending multiple faxes: To send faxes to multiple destinations a request similar to the following example can be used. Please note the addition of another “FaxMessage”:
// TODO: Setup Document
// ’filename’, ‘base64’
@document = MonopondDocument.new('test.txt','VGhpcyBpcyBhIGZheA==')
@document1 = MonopondDocument.new('test1.txt','VGhpcyBpcyBhIGZheA==')
@document2 = MonopondDocument.new('test2.txt','VGhpcyBpcyBhIGZheA==')
@document.order = 0;
@documents = []
@documents << @document
@documents << @document1
@documents << @document2
// TODO: Setup FaxMessage
// ‘messageRef’, ‘sendTo’
@faxMessage = MonopondFaxMessage.new('msg-ref-1', '6011111111')
@faxMessage.sendFrom = 'Test Fax'
@faxMessage.resolution = 'normal'
@faxMessage.retries = 0
@faxMessage.documents = @documents
@faxMessage.busyRetries = 2
// TODO: Setup FaxSendRequest
@faxMessages = []
@faxMessages << @faxMessage
@request = MonopondSendFaxRequest.new(@faxMessages, [])
@request.resolution = 'fine'
@request.broadcastRef = "broadcast-ref-1"
// Call send fax method
@sendRespone = @client.sendFax(@request)###Sending faxes to multiple destinations with the same document (broadcasting): To send the same fax content to multiple destinations (broadcasting) a request similar to the example below can be used.
This method is recommended for broadcasting as it takes advantage of the multiple tiers in the send request. This eliminates the repeated parameters out of the individual fax message elements which are instead inherited from the parent send fax request. An example below shows “SendFrom” being used for both FaxMessages. While not shown in the example below further control can be achieved over individual fax elements to override the parameters set in the parent.
// TODO: Setup Document
// ’filename’, ‘base64’
@document = MonopondDocument.new('test.txt','VGhpcyBpcyBhIGZheA==')
@document.order = 0;
// TODO: Setup FaxMessage
// ‘messageRef’, ‘sendTo’
@faxMessage = MonopondFaxMessage.new('msg-ref-1', '6011111111')
@faxMessage.sendFrom = 'Test Fax'
@faxMessage.resolution = 'normal'
@faxMessage.retries = 0
@faxMessage.busyRetries = 2
@faxMessage1 = MonopondFaxMessage.new('msg-ref-1', '6011111112')
@faxMessage1.sendFrom = 'Test Fax'
@faxMessage1.resolution = 'normal'
@faxMessage1.retries = 0
@faxMessage1.busyRetries = 2
@faxMessage2 = MonopondFaxMessage.new('msg-ref-1', '6011111113')
@faxMessage2.sendFrom = 'Test Fax'
@faxMessage2.resolution = 'normal'
@faxMessage2.retries = 0
@faxMessage2.busyRetries = 2
// TODO: Setup FaxSendRequest
@faxMessages = []
@faxMessages << @faxMessage
@faxMessages << @faxMessage1
@faxMessages << @faxMessage2
@documents = []
@documents << @document
@request = MonopondSendFaxRequest.new(@faxMessages, @documents)
@request.resolution = 'fine'
@request.broadcastRef = "broadcast-ref-1"
// Call send fax method
@sendRespone = @client.sendFax(@request)When sending multiple faxes in batch it is recommended to group them into requests of around 600 fax messages for optimal performance. If you are sending the same document to multiple destinations it is strongly advised to only attach the document once in the root of the send request rather than attaching a document for each destination.
###Sending Microsoft Documents With DocMergeData: (This request only works in version 2.1(or higher) of the fax-api.)
This request is used to send a Microsoft document with replaceable variables or merge fields. The merge field follows the pattern <mf:key>. If your key is field1, it should be typed as <mf:field1> in the document. Note that the key must be unique within the whole document. The screenshots below are examples of what the request does.
This is what the file looks like after the fields field1,field2 and field3 have been replaced with values lazy dog, fat pig and fat pig:
The example below shows field1 will be replaced by the value of Test.
//TODO: Add code here.###Sending Tiff and PDF files with StampMergeData: (This request only works in version 2.1(or higher) of the fax-api.)
This request allows a PDF or TIFF file to be stamped with an image or text, based on X-Y coordinates. The x and y coordinates (0,0) starts at the top left part of the document. The screenshots below are examples of what the request does.
Original tiff file:
Sample stamp image:
This is what the tiff file looks like after stamping it with the image above:
The same tiff file, but this time, with a text stamp:
The example below shows a PDF that will be stamped with the text “Hello” at xCoord=“1287” and yCoord=“421”, and an image at xCoord=“283” and yCoord=“120”
//TODO: code here###MonopondSendFaxRequest Parameters:
| Name | Required | Type | Description | Default |
|---|---|---|---|---|
| BroadcastRef | String | Allows the user to tag all faxes in this request with a user-defined broadcastreference. These faxes can then be retrieved at a later point based on this reference. | ||
| SendRef | String | Similar to the BroadcastRef, this allows the user to tag all faxes in this request with a send reference. The SendRef is used to represent all faxes in this request only, so naturally it must be unique. | ||
| FaxMessages | X | Array of FaxMessage | FaxMessages describe each individual fax message and its destination. See below for details. | |
| SendFrom | Alphanumeric String | A customisable string used to identify the sender of the fax. Also known as the Transmitting Subscriber Identification (TSID). The maximum string length is 32 characters | Fax | |
| Documents | X | Array of apiFaxDocument | Each FaxDocument object describes a fax document to be sent. Multiple documents can be defined here which will be concatenated and sent in the same message. See below for details. | |
| Resolution | Resolution | Resolution setting of the fax document. Refer to the resolution table below for possible resolution values. | normal | |
| ScheduledStartTime | DateTime | The date and time the transmission of the fax will start. | Current time (immediate sending) | |
| Blocklists | Blocklists | The blocklists that will be checked and filtered against before sending the message. See below for details.WARNING: This feature is inactive and non-functional in this (2.1) version of the Fax API. | ||
| Retries | Unsigned Integer | The number of times to retry sending the fax if it fails. Each account has a maximum number of retries that can be changed by consultation with your account manager. | Account Default | |
| BusyRetries | Unsigned Integer | Certain fax errors such as “NO_ANSWER” or “BUSY” are not included in the above retries limit and can be set separately. Each account has a maximum number of busy retries that can be changed by consultation with your account manager. | Account default | |
| HeaderFormat | String | Allows the header format that appears at the top of the transmitted fax to be changed. See below for an explanation of how to format this field. | From: X, To: X | |
| MustBeSentBeforeDate | DateTime | Specifies a time the fax must be delivered by. Once the specified time is reached the fax will be cancelled across the system. | ||
| MaxFaxPages | Unsigned Integer | Sets a limit on the amount of pages allowed in a single fax transmission. Especially useful if the user is blindly submitting their customer's documents to the platform. | 20 |
MonopondFaxMessage Parameters: This represents a single fax message being sent to a destination.
| Name | Required | Type | Description | Default |
|---|---|---|---|---|
| MessageRef | X | String | A unique user-provided identifier that is used to identify the fax message. This can be used at a later point to retrieve the results of the fax message. | |
| SendTo | X | String | The phone number the fax message will be sent to. | |
| SendFrom | Alphanumeric String | A customisable string used to identify the sender of the fax. Also known as the Transmitting Subscriber Identification (TSID). The maximum string length is 32 characters | Empty | |
| Documents | X | Array of apiFaxDocument | Each FaxDocument object describes a fax document to be sent. Multiple documents can be defined here which will be concatenated and sent in the same message. See below for details. | |
| Resolution | Resolution | Resolution setting of the fax document. Refer to the resolution table below for possible resolution values. | normal | |
| ScheduledStartTime | DateTime | The date and time the transmission of the fax will start. | Start now | |
| Blocklists | Blocklists | The blocklists that will be checked and filtered against before sending the message. See below for details. WARNING: This feature is inactive and non-functional in this (2.1) version of the Fax API. | ||
| Retries | Unsigned Integer | The number of times to retry sending the fax if it fails. Each account has a maximum number of retries that can be changed by consultation with your account manager. | Account Default | |
| BusyRetries | Unsigned Integer | Certain fax errors such as “NO_ANSWER” or “BUSY” are not included in the above retries limit and can be set separately. Please consult with your account manager in regards to maximum value. | account default | |
| HeaderFormat | String | Allows the header format that appears at the top of the transmitted fax to be changed. See below for an explanation of how to format this field. | From： X, To: X | |
| MustBeSentBeforeDate | DateTime | Specifies a time the fax must be delivered by. Once the specified time is reached the fax will be cancelled across the system. | ||
| MaxFaxPages | Unsigned Integer | Sets a limit on the amount of pages allowed in a single fax transmission. Especially useful if the user is blindly submitting their customer's documents to the platform. | 20 | |
| CLI | String | Allows a customer called ID. Note: Must be enabled on the account before it can be used. |
MonopondFaxDocument Parameters: Represents a fax document to be sent through the system. Supported file types are: PDF, TIFF, PNG, JPG, GIF, TXT, PS, RTF, DOC, DOCX, XLS, XLSX, PPT, PPTX.
| Name | Required | Type | Description | Default |
|---|---|---|---|---|
| FileName | X | String | The document filename including extension. This is important as it is used to help identify the document MIME type. | |
| FileData | X | Base64 | The document encoded in Base64 format. | |
| Order | Integer | If multiple documents are defined on a message this value will determine the order in which they will be transmitted. | 0 | |
| DocMergeData | An Array of MergeFields | |||
| StampMergeData | An Array of MergeFields |
Resolution Levels:
| Value | Description |
|---|---|
| normal | Normal standard resolution (98 scan lines per inch) |
| fine | Fine resolution (196 scan lines per inch) |
Header Format: Determines the format of the header line that is printed on the top of the transmitted fax message. This is set to **rom %from%, To %to%|%a %b %d %H:%M %Y”**y default which produces the following:
From TSID, To 61022221234 Mon Aug 28 15:32 2012 1 of 1
| Value | Description |
|---|---|
| %from% | The value of the SendFrom field in the message. |
| %to% | The value of the SendTo field in the message. |
| %a | Weekday name (abbreviated) |
| %A | Weekday name |
| %b | Month name (abbreviated) |
| %B | Month name |
| %d | Day of the month as a decimal (01 – 31) |
| %m | Month as a decimal (01 – 12) |
| %y | Year as a decimal (abbreviated) |
| %Y | Year as a decimal |
| %H | Hour as a decimal using a 24-hour clock (00 – 23) |
| %I | Hour as a decimal using a 12-hour clock (01 – 12) |
| %M | Minute as a decimal (00 – 59) |
| %S | Second as a decimal (00 – 59) |
| %p | AM or PM |
| %j | Day of the year as a decimal (001 – 366) |
| %U | Week of the year as a decimal (Monday as first day of the week) (00 – 53) |
| %W | Day of the year as a decimal (001 – 366) |
| %w | Day of the week as a decimal (0 – 6) (Sunday being 0) |
| %% | A literal % character |
TODO: The default value is set to: “From %from%, To %to%|%a %b %d %H:%M %Y”
DocMergeData Mergefield Parameters:
| Name | Required | Type | Description |
|---|---|---|---|
| Key | String | A unique identifier used to determine which fields need replacing. | |
| Value | String | The value that replaces the key. |
StampMergeData Mergefield Parameters:
| Name | Required | Type | Description |
|---|---|---|---|
| Key | StampMergeFieldKey | Contains x and y coordinates where the ImageValue or TextValue should be placed. | |
| TextValue | StampMergeFieldTextValue | The text value that replaces the key. | |
| ImageValue | StampMergeFieldImageValue | The image value that replaces the key. |
StampMergeFieldKey Parameters:
| Name | Required | Type | Description |
|---|---|---|---|
| xCoord | Int | X coordinate. | |
| yCoord | Int | Y coordinate. |
StampMergeFieldTextValue Parameters:
| Name | Required | Type | Description |
|---|---|---|---|
| fontName | String | Font name to be used. | |
| fontSize | Decimal | Font size to be used. |
StampMergeFieldImageValue Parameters:
| Name | Required | Type | Description |
|---|---|---|---|
| fileName | String | The document filename including extension. This is important as it is used to help identify the document MIME type. | |
| fileData | Base64 | The document encoded in Base64 format. |
###MonopondSendFaxResponse
The response received from a SendFaxRequest matches the response you receive when calling the FaxStatus method call with a send verbosity level.
###SOAP Faults This function will throw one of the following SOAP faults/exceptions if something went wrong: InvalidArgumentsException, NoMessagesFoundException, DocumentContentTypeNotFoundException, or InternalServerException. You can find more details on these faults here.
##FaxStatus ###Description
This function provides you with a method of retrieving the status, details and results of fax messages sent. While this is a legitimate method of retrieving results we strongly advise that you take advantage of our callback service, which will push these fax results to you as they are completed.
When making a status request, you must provide at least a BroadcastRef, SendRef or MessageRef. The
function will also accept a combination of these to further narrow the request query.
- Limiting by a
BroadcastRefallows you to retrieve faxes contained in a group of send requests. - Limiting by
SendRefallows you to retrieve faxes contained in a single send request. - Limiting by
MessageRefallows you to retrieve a single fax message.
There are multiple levels of verbosity available in the request; these are explained in detail below.
###MonopondFaxStatusRequest Parameters: FaxStatusRequest Properties:
| Name | Required | Type | Description | |--- | --- | --- | --- | ---| |BroadcastRef| | String | User-defined broadcast reference. | |SendRef| | String | User-defined send reference. | |MessageRef| | String | User-defined message reference. | |Verbosity| | String | Verbosity String The level of detail in the status response. Please see below for a list of possible values.| |
Verbosity Levels:
| Value | Description |
|---|---|
| brief | Gives you an overall view of the messages. This simply shows very high-level statistics, consisting of counts of how many faxes are at each status (i.e. processing, queued,sending) and totals of the results of these faxes (success, failed, blocked). |
| send | send Includes the results from “brief” while also including an itemised list of each fax message in the request. |
| details | details Includes the results from “send” along with details of the properties used to send the fax messages. |
| results | Includes the results from “send” along with the sending results of the fax messages. |
| all | all Includes the results from both “details” and “results” along with some extra uncommon fields. |
###Sending a faxStatus Request with “brief” verbosity:
// TODO: Setup FaxStatusRequest
@faxStatusRequest = MonopondFaxStatusRequest.new
@faxStatusRequest.messageRef = "Testing-message-1"
// Call fax status method
@faxStatus = @client.faxStatus(@faxStatusRequest)###Status Request with “send” verbosity:
// TODO: Setup FaxStatusRequest
@faxStatusRequest = MonopondFaxStatusRequest.new
@faxStatusRequest.broadcastRef = "Broadcast-test-1"
@faxStatusRequest.verbosity = "send"
// Call fax status method
@faxStatus = @client.faxStatus(@faxStatusRequest)###Status Request with “details” verbosity:
// TODO: Setup FaxStatusRequest
@faxStatusRequest = MonopondFaxStatusRequest.new
@faxStatusRequest.sendRef = "Send-Ref-1"
@faxStatusRequest.verbosity = "details"
// Call fax status method
@faxStatus = @client.faxStatus(@faxStatusRequest)###Status Request with “results” verbosity:
// TODO: Setup FaxStatusRequest
@faxStatusRequest = MonopondFaxStatusRequest.new
@faxStatusRequest.broadcastRef = "Broadcast-test-1"
@faxStatusRequest.sendRef = "Send-Ref-1"
@faxStatusRequest.verbosity = "results"
// Call fax status method
@faxStatus = @client.faxStatus(@faxStatusRequest)