Difference between revisions of "IMPSCloud"
Line 133: | Line 133: | ||
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). | 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). | ||
+ | === CFAddRecipientWS === | ||
− | === CFCreateMessageWS === | + | This Operation adds a recipient to an existing (queued) message. It can be called once or as many times as is required. IMPSCloud will attempt to send the message to each recipient specified by each call and the delivery format will depend on the recipient type. |
+ | |||
+ | ==== Request Elements ==== | ||
+ | |||
+ | ===== clientMessageId ===== | ||
+ | String | ||
+ | |||
+ | |||
+ | This identifies the message to be updated and can be specified in the initial CFCreateMessageWS call. It can be provided as an alternative to the “presenceUniqueIdentifier” element. | ||
+ | |||
+ | ===== presenceUniqueIdentifier ===== | ||
+ | String | ||
+ | |||
+ | This identifies the message to be updated and is specified in the response to the initial CFCreateMessageWS. | ||
+ | |||
+ | ===== 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. | ||
+ | |||
+ | ===== recipientEmail ===== | ||
+ | String | ||
+ | |||
+ | This specifies the recipient’s email address and must be included if the recipientType element has a value of EMAIL. Messages to this recipient will be delivered in email format and attachment files will be included as MIME attachments. Multiple email addresses can be provided as a comma (,) separated list. | ||
+ | |||
+ | ===== recipientName===== | ||
+ | String | ||
+ | |||
+ | The name of the recipient. | ||
+ | |||
+ | ===== recipientPhone===== | ||
+ | String | ||
+ | The telephone number of the fax machine that this message is to be delivered to. This will be ignored if the recipientType is not set to "FAX" or "SMS". Multiple telephone numbers can be provided as a comma (,) separated list. | ||
+ | |||
+ | |||
+ | ===== recipientType===== | ||
+ | String | ||
+ | |||
+ | The type of recipient to add (required). The value of this element can be FAX, SMS or EMAIL. | ||
+ | |||
+ | ===== recipientEmailScope===== | ||
+ | String | ||
+ | |||
+ | Defines the scope of this recipient, if EMAIL type is specified. May be TO, CC or BCC. | ||
+ | Response Elements | ||
+ | |||
+ | ===== clientMessageId===== | ||
+ | String | ||
+ | |||
+ | This is identical to the clientMessageId specified in the original CFCreateMessageWS request and is echoed here for convenience. | ||
+ | |||
+ | ==== Response Elements ==== | ||
+ | |||
+ | ===== presenceUniqueIdentifier===== | ||
+ | String | ||
+ | |||
+ | This is the auto-generated unique identifier for the message. | ||
+ | |||
+ | ===== 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). | ||
+ | |||
+ | ===== recipientId ===== | ||
+ | Integer | ||
+ | |||
+ | This is the auto-generated ID for this recipient. | ||
− | |||
=== CFAddAttachmentWS === | === CFAddAttachmentWS === | ||
+ | |||
+ | This Operation updates an existing message (created using CFCreateMessageWS) to add an attachment file. It can be called as many times as necessary for each attachment. | ||
+ | |||
+ | ==== Request Elements ==== | ||
+ | |||
+ | =====clientMessageId===== | ||
+ | String | ||
+ | |||
+ | This identifies the message to be updated and can be specified in the initial CFCreateMessageWS call. It can be provided as an alternative to the “presenceUniqueIdentifier” element. | ||
+ | |||
+ | =====presenceUniqueIdentifier===== | ||
+ | String | ||
+ | |||
+ | This identifies the message to be updated and is specified in the response to the initial CFCreateMessageWS. | ||
+ | |||
+ | =====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. | ||
+ | |||
+ | =====attachment_data===== | ||
+ | Base64Binary | ||
+ | |||
+ | This is the base-64 encoded byte array that contains the contents of the attachment. | ||
+ | |||
+ | =====attachment_type===== | ||
+ | String | ||
+ | |||
+ | The MIME type of the attachment, e.g. “Image/TIFF”. | ||
+ | |||
+ | =====attachment_name===== | ||
+ | String | ||
+ | |||
+ | This element specifies the filename of the attachment. | ||
+ | |||
+ | =====SpecialHandling===== | ||
+ | String | ||
+ | |||
+ | This denotes that a custom Task should be used to perform any special handling on the document being processed. For example, this can be useful for bespoke functionality such as OCR scanning. This element can be omitted. | ||
+ | |||
+ | |||
+ | Response Elements | ||
+ | |||
+ | =====clientMessageId===== | ||
+ | String | ||
+ | |||
+ | This is identical to the clientMessageId specified in the original CFCreateMessageWS request and is echoed here for convenience. | ||
+ | |||
+ | =====presenceUniqueIdentifier===== | ||
+ | String | ||
+ | |||
+ | This is the auto-generated unique identifier for the message. | ||
+ | |||
+ | =====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). | ||
+ | |||
=== CFSendMessageWS === | === CFSendMessageWS === |
Revision as of 15:59, 3 February 2012
http://www.international-presence.com/wikidocs/images/impscloudlogo.png
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.
Contents
- 1 IMPSCloud
- 1.1 Operation Details
- 1.1.1 CFCreateMessageWS
- 1.1.1.1 Request Elements
- 1.1.1.2 password
- 1.1.1.3 clientMessageId
- 1.1.1.4 messageGroupId
- 1.1.1.5 coverPage
- 1.1.1.6 memo
- 1.1.1.7 messageBody
- 1.1.1.8 messageBodyType
- 1.1.1.9 messagePriority
- 1.1.1.10 resolution
- 1.1.1.11 sendTime
- 1.1.1.12 senderEmail
- 1.1.1.13 senderName
- 1.1.1.14 senderNumber
- 1.1.1.15 subject
- 1.1.1.16 preferredPresenceServer
- 1.1.2 Response Elements
- 1.1.3 CFAddRecipientWS
- 1.1.4 CFAddAttachmentWS
- 1.1.5 CFSendMessageWS
- 1.1.6 CFCancelMessageWS
- 1.1.7 CFHoldMessageWS
- 1.1.8 CFResendMessageWS
- 1.1.9 CFReleaseMessageWS
- 1.1.10 CFGetMessageStatusWS
- 1.1.11 CFListOutboundMessagesWS
- 1.1.12 CFListInboundMessagesWS
- 1.1.13 CFRetrieveInboundAttachmentsWS
- 1.1.14 CFDeleteMessageWS
- 1.1.15 CFUploadCoverpageWS
- 1.1.1 CFCreateMessageWS
- 1.1 Operation Details
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).
CFAddRecipientWS
This Operation adds a recipient to an existing (queued) message. It can be called once or as many times as is required. IMPSCloud will attempt to send the message to each recipient specified by each call and the delivery format will depend on the recipient type.
Request Elements
clientMessageId
String
This identifies the message to be updated and can be specified in the initial CFCreateMessageWS call. It can be provided as an alternative to the “presenceUniqueIdentifier” element.
presenceUniqueIdentifier
String
This identifies the message to be updated and is specified in the response to the initial CFCreateMessageWS.
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.
recipientEmail
String
This specifies the recipient’s email address and must be included if the recipientType element has a value of EMAIL. Messages to this recipient will be delivered in email format and attachment files will be included as MIME attachments. Multiple email addresses can be provided as a comma (,) separated list.
recipientName
String
The name of the recipient.
recipientPhone
String The telephone number of the fax machine that this message is to be delivered to. This will be ignored if the recipientType is not set to "FAX" or "SMS". Multiple telephone numbers can be provided as a comma (,) separated list.
recipientType
String
The type of recipient to add (required). The value of this element can be FAX, SMS or EMAIL.
recipientEmailScope
String
Defines the scope of this recipient, if EMAIL type is specified. May be TO, CC or BCC. Response Elements
clientMessageId
String
This is identical to the clientMessageId specified in the original CFCreateMessageWS request and is echoed here for convenience.
Response Elements
presenceUniqueIdentifier
String
This is the auto-generated unique identifier for the message.
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).
recipientId
Integer
This is the auto-generated ID for this recipient.
CFAddAttachmentWS
This Operation updates an existing message (created using CFCreateMessageWS) to add an attachment file. It can be called as many times as necessary for each attachment.
Request Elements
clientMessageId
String
This identifies the message to be updated and can be specified in the initial CFCreateMessageWS call. It can be provided as an alternative to the “presenceUniqueIdentifier” element.
presenceUniqueIdentifier
String
This identifies the message to be updated and is specified in the response to the initial CFCreateMessageWS.
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.
attachment_data
Base64Binary
This is the base-64 encoded byte array that contains the contents of the attachment.
attachment_type
String
The MIME type of the attachment, e.g. “Image/TIFF”.
attachment_name
String
This element specifies the filename of the attachment.
SpecialHandling
String
This denotes that a custom Task should be used to perform any special handling on the document being processed. For example, this can be useful for bespoke functionality such as OCR scanning. This element can be omitted.
Response Elements
clientMessageId
String
This is identical to the clientMessageId specified in the original CFCreateMessageWS request and is echoed here for convenience.
presenceUniqueIdentifier
String
This is the auto-generated unique identifier for the message.
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).