IMPSCloud

Does this go at the top?

IMPSCloud

IMPSCloud (Integrated Messaging Platform Service) is a hosted, high-volume messaging service which can send, receive and relay faxes, SMS and emails and is specifically designed for the enterprise.

http://www.international-presence.com/wikidocs/images/soap_architecture_2.png

Calls to IMPSCloud are made via the following SOAP operations:

• CFCreateMessageWS
• CFAddRecipientWS
• CFAddAttachmentWS
• CFSendMessageWS
• CFCancelMessageWS
• CFHoldMessageWS
• CFResendMessageWS
• CFReleaseMessageWS
• CFGetMessageStatusWS
• CFListOutboundMessagesWS
• CFListInboundMessagesWS
• CFRetrieveInboundAttachmentsWS
• CFDeleteMessageWS
• CFUploadCoverpageWS

Operation Details

CFCreateMessageWS

This Operation creates a new message and places it in a Waiting state on the outgoing queue. The message will not be ready for delivery until the CFSendFaxWS operation is called. Below is a list of elements that can be defined when making the call. Request Elements

Request Elements

username

String

This is your account username, which will be used for authentication purposes. This will be supplied by Presence. This element must appear exactly once.

password

String

The password matching the username specified above. This element must appear exactly once.

clientMessageId

String

This is a unique identifier specified by the client. The value will be stored against the message in the queue and can be used to identify it in subsequent calls. It will be echoed in the server response. This element can be omitted.

messageGroupId

String

The MessageGroupId value identifies this message as belonging to a group of messages as defined by the client business logic. It can be used as a filter when retrieving the status of queued messages. This element can be omitted.

coverPage

String

This specifies the name of the cover page to include with this message, if any. It can be omitted. Cover pages are in HTML format and must be installed separately using the CFInstallCoverPageWS operation (to be defined).

memo

String

The memo field will be stored against the message in the queue and may be included in the fax coverpage using the $[COMMENTS] token.

messageBody

String

The body text of the message, which will be the contents of an email message or the fax message. This can be HTML formatted, plain text or XML formatting instructions for creating a PDF file – this can be omitted.

messageBodyType

String

This specifies the format of the messageBody text, and the value can be either PDF, HTML or TEXT. It is required if a messageBody element is included in the request.

messagePriority

Integer

The value must be a number between 1 and 10 and specifies the priority of this message. 1 is the lowest priority and 10 is the highest.

resolution

String

Specifies the resolution of the fax message if appropriate. Value may either be C (coarse) or F (fine).

sendTime

dateTime

If included, the system will not attempt to deliver the message until after the specified date and time.

senderEmail

String

For email messages this specifies the “from” address of the message.

senderName

String

The name of the sender, which will be included in the cover page if present using the $[FROM] token.

senderNumber

String

The originating fax number for fax messages. Will be included in the cover page if present using the $[SND_FAX#] token.

subject

String

The subject of the message. The value can be included in the cover page if present using the $[SUBJECT] token.

preferredPresenceServer

String

This indicates that a specified Presence server should handle the message. It can be omitted.

Response Elements

clientMessageId

String

This is identical to the clientMessageId specified in the request and is echoed here for convenience.

presenceUniqueIdentifier

String

This is the auto-generated unique identifier for the message and can be used for subsequence requests pertaining to this message (as an alternative, or in addition to, the clientMessageId).

serverResponse

String

A three digit response code followed by a colon ( : ) followed by a descriptive message. Please see http://www.international-presence.com/wikidocs/index.php?title=CloudFax_Server_Responses for further information (document in progress).