ContactService

Click here for a complete list of operations.

BroadcastCreate

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/BroadcastCreate"

<?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>
    <BroadcastCreate xmlns="http://datasquirt.com/webservices/">
      <broadcastSetup>
        <Name>string</Name>
        <Description>string</Description>
        <ContactUserID>int</ContactUserID>
        <ContactUser_UserID>string</ContactUser_UserID>
        <CustomersPerHour>int</CustomersPerHour>
        <SendOnPreferredChannelOnly>boolean</SendOnPreferredChannelOnly>
        <DatesBasedOnCustomerTimeZones>boolean</DatesBasedOnCustomerTimeZones>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <DailyStartTime>dateTime</DailyStartTime>
        <DailyEndTime>dateTime</DailyEndTime>
        <Days>
          <int>int</int>
          <int>int</int>
        </Days>
        <BroadcastSetupGroups>
          <BroadcastSetupGroup>
            <CustomerGroupID>int</CustomerGroupID>
            <CustomerGroupName>string</CustomerGroupName>
          </BroadcastSetupGroup>
          <BroadcastSetupGroup>
            <CustomerGroupID>int</CustomerGroupID>
            <CustomerGroupName>string</CustomerGroupName>
          </BroadcastSetupGroup>
        </BroadcastSetupGroups>
        <BroadcastSetupTemplates>
          <BroadcastSetupTemplate>
            <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>
            <TemplateID>int</TemplateID>
            <TemplateName>string</TemplateName>
            <Subject>string</Subject>
            <MessageText>string</MessageText>
            <Queue>string</Queue>
            <CategoryID>int</CategoryID>
            <CategoryName>string</CategoryName>
            <SubCategoryID>int</SubCategoryID>
            <SubCategoryName>string</SubCategoryName>
          </BroadcastSetupTemplate>
          <BroadcastSetupTemplate>
            <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>
            <TemplateID>int</TemplateID>
            <TemplateName>string</TemplateName>
            <Subject>string</Subject>
            <MessageText>string</MessageText>
            <Queue>string</Queue>
            <CategoryID>int</CategoryID>
            <CategoryName>string</CategoryName>
            <SubCategoryID>int</SubCategoryID>
            <SubCategoryName>string</SubCategoryName>
          </BroadcastSetupTemplate>
        </BroadcastSetupTemplates>
        <CreateAsDraft>boolean</CreateAsDraft>
      </broadcastSetup>
    </BroadcastCreate>
  </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>
    <BroadcastCreateResponse xmlns="http://datasquirt.com/webservices/">
      <BroadcastCreateResult>int</BroadcastCreateResult>
    </BroadcastCreateResponse>
  </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>
    <BroadcastCreate xmlns="http://datasquirt.com/webservices/">
      <broadcastSetup>
        <Name>string</Name>
        <Description>string</Description>
        <ContactUserID>int</ContactUserID>
        <ContactUser_UserID>string</ContactUser_UserID>
        <CustomersPerHour>int</CustomersPerHour>
        <SendOnPreferredChannelOnly>boolean</SendOnPreferredChannelOnly>
        <DatesBasedOnCustomerTimeZones>boolean</DatesBasedOnCustomerTimeZones>
        <StartDate>dateTime</StartDate>
        <EndDate>dateTime</EndDate>
        <DailyStartTime>dateTime</DailyStartTime>
        <DailyEndTime>dateTime</DailyEndTime>
        <Days>
          <int>int</int>
          <int>int</int>
        </Days>
        <BroadcastSetupGroups>
          <BroadcastSetupGroup>
            <CustomerGroupID>int</CustomerGroupID>
            <CustomerGroupName>string</CustomerGroupName>
          </BroadcastSetupGroup>
          <BroadcastSetupGroup>
            <CustomerGroupID>int</CustomerGroupID>
            <CustomerGroupName>string</CustomerGroupName>
          </BroadcastSetupGroup>
        </BroadcastSetupGroups>
        <BroadcastSetupTemplates>
          <BroadcastSetupTemplate>
            <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>
            <TemplateID>int</TemplateID>
            <TemplateName>string</TemplateName>
            <Subject>string</Subject>
            <MessageText>string</MessageText>
            <Queue>string</Queue>
            <CategoryID>int</CategoryID>
            <CategoryName>string</CategoryName>
            <SubCategoryID>int</SubCategoryID>
            <SubCategoryName>string</SubCategoryName>
          </BroadcastSetupTemplate>
          <BroadcastSetupTemplate>
            <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>
            <TemplateID>int</TemplateID>
            <TemplateName>string</TemplateName>
            <Subject>string</Subject>
            <MessageText>string</MessageText>
            <Queue>string</Queue>
            <CategoryID>int</CategoryID>
            <CategoryName>string</CategoryName>
            <SubCategoryID>int</SubCategoryID>
            <SubCategoryName>string</SubCategoryName>
          </BroadcastSetupTemplate>
        </BroadcastSetupTemplates>
        <CreateAsDraft>boolean</CreateAsDraft>
      </broadcastSetup>
    </BroadcastCreate>
  </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>
    <BroadcastCreateResponse xmlns="http://datasquirt.com/webservices/">
      <BroadcastCreateResult>int</BroadcastCreateResult>
    </BroadcastCreateResponse>
  </soap12:Body>
</soap12:Envelope>