GPApiClientLibraryCommunicator_v3


Click here for a complete list of operations.

setMessage

Communicator: Send sms, email or whatsapp message sender. Return registry IDMessage or ERROR

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 /apis/silver/communicator.asmx HTTP/1.1
Host: commcenter.greyphillips.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://greyphillips.com/setMessage"

<?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>
    <setMessage xmlns="http://greyphillips.com/">
      <strApiKey>string</strApiKey>
      <strApiUser>string</strApiUser>
      <strApiPassword>string</strApiPassword>
      <strType>string</strType>
      <strSubType>string</strSubType>
      <strDatetime>string</strDatetime>
      <strTo>string</strTo>
      <strSubject>string</strSubject>
      <strMessage>string</strMessage>
      <intPriority>int</intPriority>
      <strContactID>string</strContactID>
      <strAttachFilesIDs>string</strAttachFilesIDs>
      <strCampaignID>string</strCampaignID>
      <strSMTPAccountID>string</strSMTPAccountID>
      <strFromAppID>string</strFromAppID>
      <strTableRef>string</strTableRef>
      <strRefID>string</strRefID>
    </setMessage>
  </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>
    <setMessageResponse xmlns="http://greyphillips.com/">
      <setMessageResult>string</setMessageResult>
    </setMessageResponse>
  </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 /apis/silver/communicator.asmx HTTP/1.1
Host: commcenter.greyphillips.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>
    <setMessage xmlns="http://greyphillips.com/">
      <strApiKey>string</strApiKey>
      <strApiUser>string</strApiUser>
      <strApiPassword>string</strApiPassword>
      <strType>string</strType>
      <strSubType>string</strSubType>
      <strDatetime>string</strDatetime>
      <strTo>string</strTo>
      <strSubject>string</strSubject>
      <strMessage>string</strMessage>
      <intPriority>int</intPriority>
      <strContactID>string</strContactID>
      <strAttachFilesIDs>string</strAttachFilesIDs>
      <strCampaignID>string</strCampaignID>
      <strSMTPAccountID>string</strSMTPAccountID>
      <strFromAppID>string</strFromAppID>
      <strTableRef>string</strTableRef>
      <strRefID>string</strRefID>
    </setMessage>
  </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>
    <setMessageResponse xmlns="http://greyphillips.com/">
      <setMessageResult>string</setMessageResult>
    </setMessageResponse>
  </soap12:Body>
</soap12:Envelope>