ContactService


Click here for a complete list of operations.

MessageFindMessagesToSend

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 /api/contactservice.asmx HTTP/1.1
Host: losalesdemo.mc.hostedcc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://datasquirt.com/webservices/MessageFindMessagesToSend"

<?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>
    <ContactCredentials xmlns="http://datasquirt.com/webservices/">
      <UserID>string</UserID>
      <Password>string</Password>
    </ContactCredentials>
  </soap:Header>
  <soap:Body>
    <MessageFindMessagesToSend xmlns="http://datasquirt.com/webservices/">
      <reSendInterval>int</reSendInterval>
      <retrievalLimit>int</retrievalLimit>
      <messageType>SMS or Email or Fax or Unknown or Phone or Chat or Twitter or Facebook or YouTube or LinkedIn or GenericMessageType1 or GenericMessageType2</messageType>
    </MessageFindMessagesToSend>
  </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>
    <MessageFindMessagesToSendResponse xmlns="http://datasquirt.com/webservices/">
      <MessageFindMessagesToSendResult>
        <Message>
          <MessageID>int</MessageID>
          <ParentMessageID>int</ParentMessageID>
          <CustomerID>int</CustomerID>
          <CategoryID>int</CategoryID>
          <AssignedToUserID>int</AssignedToUserID>
          <CreatedByUserID>int</CreatedByUserID>
          <SkillID>int</SkillID>
          <BatchID>int</BatchID>
          <SubCategoryID>int</SubCategoryID>
          <MessageUID>string</MessageUID>
          <Sender>string</Sender>
          <Receiver>string</Receiver>
          <ShortMessageText>string</ShortMessageText>
          <CarrierCode>string</CarrierCode>
          <MessageStateNo>int</MessageStateNo>
          <Created>dateTime</Created>
          <Scheduled>dateTime</Scheduled>
          <ForceThroughQA>boolean</ForceThroughQA>
          <IsPending>boolean</IsPending>
          <MessageType>SMS or Email or Fax or Unknown or Phone or Chat or Twitter or Facebook or YouTube or LinkedIn or GenericMessageType1 or GenericMessageType2</MessageType>
          <MessageDirection>Inbound or Outbound or AutoResponse or Unknown</MessageDirection>
        </Message>
        <Message>
          <MessageID>int</MessageID>
          <ParentMessageID>int</ParentMessageID>
          <CustomerID>int</CustomerID>
          <CategoryID>int</CategoryID>
          <AssignedToUserID>int</AssignedToUserID>
          <CreatedByUserID>int</CreatedByUserID>
          <SkillID>int</SkillID>
          <BatchID>int</BatchID>
          <SubCategoryID>int</SubCategoryID>
          <MessageUID>string</MessageUID>
          <Sender>string</Sender>
          <Receiver>string</Receiver>
          <ShortMessageText>string</ShortMessageText>
          <CarrierCode>string</CarrierCode>
          <MessageStateNo>int</MessageStateNo>
          <Created>dateTime</Created>
          <Scheduled>dateTime</Scheduled>
          <ForceThroughQA>boolean</ForceThroughQA>
          <IsPending>boolean</IsPending>
          <MessageType>SMS or Email or Fax or Unknown or Phone or Chat or Twitter or Facebook or YouTube or LinkedIn or GenericMessageType1 or GenericMessageType2</MessageType>
          <MessageDirection>Inbound or Outbound or AutoResponse or Unknown</MessageDirection>
        </Message>
      </MessageFindMessagesToSendResult>
    </MessageFindMessagesToSendResponse>
  </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 /api/contactservice.asmx HTTP/1.1
Host: losalesdemo.mc.hostedcc.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:Header>
    <ContactCredentials xmlns="http://datasquirt.com/webservices/">
      <UserID>string</UserID>
      <Password>string</Password>
    </ContactCredentials>
  </soap12:Header>
  <soap12:Body>
    <MessageFindMessagesToSend xmlns="http://datasquirt.com/webservices/">
      <reSendInterval>int</reSendInterval>
      <retrievalLimit>int</retrievalLimit>
      <messageType>SMS or Email or Fax or Unknown or Phone or Chat or Twitter or Facebook or YouTube or LinkedIn or GenericMessageType1 or GenericMessageType2</messageType>
    </MessageFindMessagesToSend>
  </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>
    <MessageFindMessagesToSendResponse xmlns="http://datasquirt.com/webservices/">
      <MessageFindMessagesToSendResult>
        <Message>
          <MessageID>int</MessageID>
          <ParentMessageID>int</ParentMessageID>
          <CustomerID>int</CustomerID>
          <CategoryID>int</CategoryID>
          <AssignedToUserID>int</AssignedToUserID>
          <CreatedByUserID>int</CreatedByUserID>
          <SkillID>int</SkillID>
          <BatchID>int</BatchID>
          <SubCategoryID>int</SubCategoryID>
          <MessageUID>string</MessageUID>
          <Sender>string</Sender>
          <Receiver>string</Receiver>
          <ShortMessageText>string</ShortMessageText>
          <CarrierCode>string</CarrierCode>
          <MessageStateNo>int</MessageStateNo>
          <Created>dateTime</Created>
          <Scheduled>dateTime</Scheduled>
          <ForceThroughQA>boolean</ForceThroughQA>
          <IsPending>boolean</IsPending>
          <MessageType>SMS or Email or Fax or Unknown or Phone or Chat or Twitter or Facebook or YouTube or LinkedIn or GenericMessageType1 or GenericMessageType2</MessageType>
          <MessageDirection>Inbound or Outbound or AutoResponse or Unknown</MessageDirection>
        </Message>
        <Message>
          <MessageID>int</MessageID>
          <ParentMessageID>int</ParentMessageID>
          <CustomerID>int</CustomerID>
          <CategoryID>int</CategoryID>
          <AssignedToUserID>int</AssignedToUserID>
          <CreatedByUserID>int</CreatedByUserID>
          <SkillID>int</SkillID>
          <BatchID>int</BatchID>
          <SubCategoryID>int</SubCategoryID>
          <MessageUID>string</MessageUID>
          <Sender>string</Sender>
          <Receiver>string</Receiver>
          <ShortMessageText>string</ShortMessageText>
          <CarrierCode>string</CarrierCode>
          <MessageStateNo>int</MessageStateNo>
          <Created>dateTime</Created>
          <Scheduled>dateTime</Scheduled>
          <ForceThroughQA>boolean</ForceThroughQA>
          <IsPending>boolean</IsPending>
          <MessageType>SMS or Email or Fax or Unknown or Phone or Chat or Twitter or Facebook or YouTube or LinkedIn or GenericMessageType1 or GenericMessageType2</MessageType>
          <MessageDirection>Inbound or Outbound or AutoResponse or Unknown</MessageDirection>
        </Message>
      </MessageFindMessagesToSendResult>
    </MessageFindMessagesToSendResponse>
  </soap12:Body>
</soap12:Envelope>