MagnetMail Web Service Web Service

MagnetMail Web Service

Click here for a complete list of operations.

sendMessageToGroup

BETA: Send message to a group.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /mmapi.asmx HTTP/1.1
Host: hlma-apie1.magnetmail.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.magnetmail.net/sendMessageToGroup"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <mmAuthHeader xmlns="http://www.magnetmail.net/">
      <sessionId>string</sessionId>
      <user_id>string</user_id>
    </mmAuthHeader>
  </soap:Header>
  <soap:Body>
    <sendMessageToGroup xmlns="http://www.magnetmail.net/">
      <user_id>string</user_id>
      <loginid>int</loginid>
      <message_id>int</message_id>
      <scheduledDateTime>dateTime</scheduledDateTime>
      <group_ids>
        <int>int</int>
        <int>int</int>
      </group_ids>
      <filteredout_groups>
        <int>int</int>
        <int>int</int>
      </filteredout_groups>
      <test_emails>
        <string>string</string>
        <string>string</string>
      </test_emails>
      <send_type>EmailOnly or FaxOnly or EmailFaxPriorityEmail or EmailFaxPriorityFax</send_type>
      <faxToFailedEmail_emailToFailedFax>boolean</faxToFailedEmail_emailToFailedFax>
      <html_web_version_link>boolean</html_web_version_link>
      <text_web_version_link>boolean</text_web_version_link>
      <message_subject>string</message_subject>
      <message_from>string</message_from>
      <billing_code>string</billing_code>
      <billing_initial>string</billing_initial>
      <sendDespiteArchived>boolean</sendDespiteArchived>
      <sendDespiteBadFrom>boolean</sendDespiteBadFrom>
      <ignore_dedupe>boolean</ignore_dedupe>
      <fax_resolution>standard or fine</fax_resolution>
      <Newsletter>
        <newsletter_archive>boolean</newsletter_archive>
        <newsletter_name>string</newsletter_name>
        <newsletter_publish_date>dateTime</newsletter_publish_date>
      </Newsletter>
      <job_notification>
        <send_notification>boolean</send_notification>
        <send_notification_from>string</send_notification_from>
        <send_notification_to>string</send_notification_to>
        <send_notification_when>int</send_notification_when>
        <complete_notification>boolean</complete_notification>
        <send_complete_notification_from>string</send_complete_notification_from>
        <send_complete_notification_to>string</send_complete_notification_to>
        <send_complete_notification_when>int</send_complete_notification_when>
      </job_notification>
      <rssPublishType>noRSS or RSSToSelectedGroups or RSSOnly</rssPublishType>
      <MiscArguments>string</MiscArguments>
    </sendMessageToGroup>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <sendMessageToGroupResponse xmlns="http://www.magnetmail.net/">
      <sendMessageToGroupResult>
        <email_job_ids>
          <anyType />
          <anyType />
        </email_job_ids>
        <error>double</error>
        <errorObj>
          <errorCode>string</errorCode>
          <errorDetails>string</errorDetails>
          <errorMessage>string</errorMessage>
          <errorNumber>double</errorNumber>
          <errorType>string</errorType>
        </errorObj>
        <fax_job_ids>
          <anyType />
          <anyType />
        </fax_job_ids>
        <msg>string</msg>
      </sendMessageToGroupResult>
    </sendMessageToGroupResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /mmapi.asmx HTTP/1.1
Host: hlma-apie1.magnetmail.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <mmAuthHeader xmlns="http://www.magnetmail.net/">
      <sessionId>string</sessionId>
      <user_id>string</user_id>
    </mmAuthHeader>
  </soap12:Header>
  <soap12:Body>
    <sendMessageToGroup xmlns="http://www.magnetmail.net/">
      <user_id>string</user_id>
      <loginid>int</loginid>
      <message_id>int</message_id>
      <scheduledDateTime>dateTime</scheduledDateTime>
      <group_ids>
        <int>int</int>
        <int>int</int>
      </group_ids>
      <filteredout_groups>
        <int>int</int>
        <int>int</int>
      </filteredout_groups>
      <test_emails>
        <string>string</string>
        <string>string</string>
      </test_emails>
      <send_type>EmailOnly or FaxOnly or EmailFaxPriorityEmail or EmailFaxPriorityFax</send_type>
      <faxToFailedEmail_emailToFailedFax>boolean</faxToFailedEmail_emailToFailedFax>
      <html_web_version_link>boolean</html_web_version_link>
      <text_web_version_link>boolean</text_web_version_link>
      <message_subject>string</message_subject>
      <message_from>string</message_from>
      <billing_code>string</billing_code>
      <billing_initial>string</billing_initial>
      <sendDespiteArchived>boolean</sendDespiteArchived>
      <sendDespiteBadFrom>boolean</sendDespiteBadFrom>
      <ignore_dedupe>boolean</ignore_dedupe>
      <fax_resolution>standard or fine</fax_resolution>
      <Newsletter>
        <newsletter_archive>boolean</newsletter_archive>
        <newsletter_name>string</newsletter_name>
        <newsletter_publish_date>dateTime</newsletter_publish_date>
      </Newsletter>
      <job_notification>
        <send_notification>boolean</send_notification>
        <send_notification_from>string</send_notification_from>
        <send_notification_to>string</send_notification_to>
        <send_notification_when>int</send_notification_when>
        <complete_notification>boolean</complete_notification>
        <send_complete_notification_from>string</send_complete_notification_from>
        <send_complete_notification_to>string</send_complete_notification_to>
        <send_complete_notification_when>int</send_complete_notification_when>
      </job_notification>
      <rssPublishType>noRSS or RSSToSelectedGroups or RSSOnly</rssPublishType>
      <MiscArguments>string</MiscArguments>
    </sendMessageToGroup>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <sendMessageToGroupResponse xmlns="http://www.magnetmail.net/">
      <sendMessageToGroupResult>
        <email_job_ids>
          <anyType />
          <anyType />
        </email_job_ids>
        <error>double</error>
        <errorObj>
          <errorCode>string</errorCode>
          <errorDetails>string</errorDetails>
          <errorMessage>string</errorMessage>
          <errorNumber>double</errorNumber>
          <errorType>string</errorType>
        </errorObj>
        <fax_job_ids>
          <anyType />
          <anyType />
        </fax_job_ids>
        <msg>string</msg>
      </sendMessageToGroupResult>
    </sendMessageToGroupResponse>
  </soap12:Body>
</soap12:Envelope>