Difference between revisions of "IMPSCloud API"
| Line 5: | Line 5: | ||
This document describes the web services API for sending, receiving and querying | This document describes the web services API for sending, receiving and querying | ||
messages via the Presence / IMPSCloud service. | messages via the Presence / IMPSCloud service. | ||
| + | |||
| + | === Sending a fax or email message === | ||
| + | |||
| + | In order to create and send an outgoing fax or email message, the following web service calls should be made: | ||
| + | |||
| + | * CFCreateMessageWS – creates the new message and places it in a | ||
| + | pending state on the outgoing queue. | ||
| + | * CFAddRecipientWS – must be called at least once in order to specify | ||
| + | a recipient for this message. Multiple recipients can be added be | ||
| + | making successive calls. The recipient type will determine how the | ||
| + | message is delivered, i.e. by fax or by email. | ||
| + | * CFAddAttachmentWS – may be called zero or more times in order to | ||
| + | add an attachment file to the outgoing message (one per request). Note | ||
| + | that attachments will be ignored for SMS messages. | ||
| + | * CFSendMessageWS - finalizes and commits the outgoing message, | ||
| + | which will then be scheduled for delivery at the earliest opportunity. | ||
| + | |||
| + | After the message has been sent using CFSendMessageWS, its status can be monitored using the CFGetMessageStatusWS operation. | ||
Revision as of 17:36, 1 November 2011
IMPSCloud API
Introduction
This document describes the web services API for sending, receiving and querying messages via the Presence / IMPSCloud service.
Sending a fax or email message
In order to create and send an outgoing fax or email message, the following web service calls should be made:
- CFCreateMessageWS – creates the new message and places it in a
pending state on the outgoing queue.
- CFAddRecipientWS – must be called at least once in order to specify
a recipient for this message. Multiple recipients can be added be making successive calls. The recipient type will determine how the message is delivered, i.e. by fax or by email.
- CFAddAttachmentWS – may be called zero or more times in order to
add an attachment file to the outgoing message (one per request). Note that attachments will be ignored for SMS messages.
- CFSendMessageWS - finalizes and commits the outgoing message,
which will then be scheduled for delivery at the earliest opportunity.
After the message has been sent using CFSendMessageWS, its status can be monitored using the CFGetMessageStatusWS operation.
