SendMessage Web Service

SendMessage

Click here for a complete list of operations.

sendTextByType

Sends a text message

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 /WebServices/SendMessage.asmx HTTP/1.1
Host: alert.groupcall.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://groupcallalert.com/sendTextByType"

<?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>
    <sendTextByType xmlns="http://groupcallalert.com/">
      <userName>string</userName>
      <password>string</password>
      <message>
        <savedMessageFolder>string</savedMessageFolder>
        <savedMessageName>string</savedMessageName>
        <smsText>string</smsText>
        <sendDateTime>dateTime</sendDateTime>
        <contacts>
          <Contact>
            <ID>string</ID>
            <mobileNumber>string</mobileNumber>
            <forename>string</forename>
            <surname>string</surname>
            <name>string</name>
            <callbackref>string</callbackref>
            <contactAttributes xsi:nil="true" />
          </Contact>
          <Contact>
            <ID>string</ID>
            <mobileNumber>string</mobileNumber>
            <forename>string</forename>
            <surname>string</surname>
            <name>string</name>
            <callbackref>string</callbackref>
            <contactAttributes xsi:nil="true" />
          </Contact>
        </contacts>
        <personIds>
          <string>string</string>
          <string>string</string>
        </personIds>
        <ClientRef>string</ClientRef>
        <UserName>string</UserName>
        <Password>string</Password>
        <MessageCategoryId>int</MessageCategoryId>
      </message>
      <sendType>string</sendType>
    </sendTextByType>
  </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>
    <sendTextByTypeResponse xmlns="http://groupcallalert.com/">
      <sendTextByTypeResult>
        <errorMsg>string</errorMsg>
        <MessageSentId>int</MessageSentId>
        <statusMsg>string</statusMsg>
        <transmitDateTime>dateTime</transmitDateTime>
        <ClientRef>string</ClientRef>
        <status>
          <SMSMessageStatus>
            <mobileNumber>string</mobileNumber>
            <status>string</status>
            <units>int</units>
            <externalid>string</externalid>
          </SMSMessageStatus>
          <SMSMessageStatus>
            <mobileNumber>string</mobileNumber>
            <status>string</status>
            <units>int</units>
            <externalid>string</externalid>
          </SMSMessageStatus>
        </status>
      </sendTextByTypeResult>
    </sendTextByTypeResponse>
  </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 /WebServices/SendMessage.asmx HTTP/1.1
Host: alert.groupcall.com
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>
    <sendTextByType xmlns="http://groupcallalert.com/">
      <userName>string</userName>
      <password>string</password>
      <message>
        <savedMessageFolder>string</savedMessageFolder>
        <savedMessageName>string</savedMessageName>
        <smsText>string</smsText>
        <sendDateTime>dateTime</sendDateTime>
        <contacts>
          <Contact>
            <ID>string</ID>
            <mobileNumber>string</mobileNumber>
            <forename>string</forename>
            <surname>string</surname>
            <name>string</name>
            <callbackref>string</callbackref>
            <contactAttributes xsi:nil="true" />
          </Contact>
          <Contact>
            <ID>string</ID>
            <mobileNumber>string</mobileNumber>
            <forename>string</forename>
            <surname>string</surname>
            <name>string</name>
            <callbackref>string</callbackref>
            <contactAttributes xsi:nil="true" />
          </Contact>
        </contacts>
        <personIds>
          <string>string</string>
          <string>string</string>
        </personIds>
        <ClientRef>string</ClientRef>
        <UserName>string</UserName>
        <Password>string</Password>
        <MessageCategoryId>int</MessageCategoryId>
      </message>
      <sendType>string</sendType>
    </sendTextByType>
  </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>
    <sendTextByTypeResponse xmlns="http://groupcallalert.com/">
      <sendTextByTypeResult>
        <errorMsg>string</errorMsg>
        <MessageSentId>int</MessageSentId>
        <statusMsg>string</statusMsg>
        <transmitDateTime>dateTime</transmitDateTime>
        <ClientRef>string</ClientRef>
        <status>
          <SMSMessageStatus>
            <mobileNumber>string</mobileNumber>
            <status>string</status>
            <units>int</units>
            <externalid>string</externalid>
          </SMSMessageStatus>
          <SMSMessageStatus>
            <mobileNumber>string</mobileNumber>
            <status>string</status>
            <units>int</units>
            <externalid>string</externalid>
          </SMSMessageStatus>
        </status>
      </sendTextByTypeResult>
    </sendTextByTypeResponse>
  </soap12:Body>
</soap12:Envelope>