Broadcast Web Service

Click here for a complete list of operations.

AddUser

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 /Webservice.asmx HTTP/1.1
Host: message-service.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://message-service.org/AddUser"

<?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:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://message-service.org/" xmlns:types="http://message-service.org/encodedTypes" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <tns:AuthenticationHeader>
      <Username xsi:type="xsd:string">string</Username>
      <Password xsi:type="xsd:string">string</Password>
      <Usercode xsi:type="xsd:string">string</Usercode>
    </tns:AuthenticationHeader>
  </soap:Header>
  <soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <tns:AddUser>
      <user href="#id1" />
    </tns:AddUser>
    <tns:User id="id1" xsi:type="tns:User">
      <UserCode xsi:type="xsd:string">string</UserCode>
      <Title xsi:type="xsd:string">string</Title>
      <FirstName xsi:type="xsd:string">string</FirstName>
      <LastName xsi:type="xsd:string">string</LastName>
      <Email xsi:type="xsd:string">string</Email>
      <Phone xsi:type="xsd:string">string</Phone>
      <Fax xsi:type="xsd:string">string</Fax>
      <Mobile xsi:type="xsd:string">string</Mobile>
      <CallBackURL xsi:type="xsd:string">string</CallBackURL>
      <FaxHeaderText xsi:type="xsd:string">string</FaxHeaderText>
      <Company href="#id2" />
      <Password xsi:type="xsd:string">string</Password>
      <ReportType xsi:type="tns:ReportType">Detailed or Exception or Summary</ReportType>
      <MonthlyLimit xsi:type="xsd:double">double</MonthlyLimit>
      <IsFax xsi:type="xsd:boolean">boolean</IsFax>
      <IsSms xsi:type="xsd:boolean">boolean</IsSms>
      <IsTts xsi:type="xsd:boolean">boolean</IsTts>
      <IsTtsTwoWay xsi:type="xsd:boolean">boolean</IsTtsTwoWay>
      <IsEmail xsi:type="xsd:boolean">boolean</IsEmail>
      <IsAntiSpam xsi:type="xsd:boolean">boolean</IsAntiSpam>
      <IsLive xsi:type="xsd:boolean">boolean</IsLive>
      <EmailToBroadcastAuthType xsi:type="xsd:string">string</EmailToBroadcastAuthType>
      <EmailToBroadcastEmailAddress xsi:type="xsd:string">string</EmailToBroadcastEmailAddress>
      <BroadcastLimitWarnAddress xsi:type="xsd:string">string</BroadcastLimitWarnAddress>
      <DefaultTTSVoice xsi:type="xsd:string">string</DefaultTTSVoice>
      <TTSRepeatCount xsi:type="xsd:string">string</TTSRepeatCount>
      <SMSSenderID xsi:type="xsd:string">string</SMSSenderID>
      <EmailToBroadcastSubjectBehaviour xsi:type="xsd:string">string</EmailToBroadcastSubjectBehaviour>
      <EmailToBroadcastSignatureStart xsi:type="xsd:string">string</EmailToBroadcastSignatureStart>
      <EmailToBroadcastBodyAsFaxCover xsi:type="xsd:string">string</EmailToBroadcastBodyAsFaxCover>
      <FaxVoicePriority xsi:type="xsd:int">int</FaxVoicePriority>
      <VoiceCallerID xsi:type="xsd:string">string</VoiceCallerID>
      <CreditLimitForAlert xsi:type="xsd:string">string</CreditLimitForAlert>
      <CreditLimitAlertAddress xsi:type="xsd:string">string</CreditLimitAlertAddress>
      <EtoBXcode xsi:type="xsd:string">string</EtoBXcode>
      <HideCostsInReport xsi:type="xsd:string">string</HideCostsInReport>
      <SMSFilterOutNonAscii xsi:type="xsd:string">string</SMSFilterOutNonAscii>
      <TTSCharLimit xsi:type="xsd:string">string</TTSCharLimit>
      <DefaultSMSReplyEmail xsi:type="xsd:string">string</DefaultSMSReplyEmail>
      <TTSMsgPrefix xsi:type="xsd:string">string</TTSMsgPrefix>
      <DocRetentionHours xsi:type="xsd:string">string</DocRetentionHours>
      <InboundFaxEmail xsi:type="xsd:string">string</InboundFaxEmail>
      <ShowRecipientsInOnlineReport xsi:type="xsd:string">string</ShowRecipientsInOnlineReport>
      <ShowRecipientsInEmailReport xsi:type="xsd:string">string</ShowRecipientsInEmailReport>
      <IncludeCopyOfFaxInReport xsi:type="xsd:string">string</IncludeCopyOfFaxInReport>
      <HideAccounts xsi:type="xsd:string">string</HideAccounts>
      <EmailToBroadcastIPWhiteList xsi:type="xsd:string">string</EmailToBroadcastIPWhiteList>
      <EmailToBroadcastIPWhiteListAlertEmail xsi:type="xsd:string">string</EmailToBroadcastIPWhiteListAlertEmail>
      <TimeZoneID xsi:type="xsd:string">string</TimeZoneID>
      <DoNotBillUser xsi:type="xsd:string">string</DoNotBillUser>
      <AccountType xsi:type="xsd:string">string</AccountType>
      <PreferredSMSCarrier xsi:type="xsd:string">string</PreferredSMSCarrier>
      <UserReceiveReports xsi:type="xsd:string">string</UserReceiveReports>
      <ListCosts href="#id3" />
    </tns:User>
    <tns:Company id="id2" xsi:type="tns:Company">
      <CompanyName xsi:type="xsd:string">string</CompanyName>
      <Address xsi:type="xsd:string">string</Address>
      <City xsi:type="xsd:string">string</City>
      <Postcode xsi:type="xsd:string">string</Postcode>
      <State xsi:type="xsd:string">string</State>
      <Country xsi:type="xsd:string">string</Country>
      <ABN xsi:type="xsd:string">string</ABN>
      <AgentID xsi:type="xsd:int">int</AgentID>
      <IsNew xsi:type="xsd:boolean">boolean</IsNew>
    </tns:Company>
    <soapenc:Array id="id3" soapenc:arrayType="tns:ListCosts[2]">
      <Item href="#id4" />
      <Item href="#id5" />
    </soapenc:Array>
    <tns:ListCosts id="id4" xsi:type="tns:ListCosts">
      <ListType xsi:type="tns:ListType">AuMedia or AuBusinesss or AuGovernment or Messaging or USMedia or AsiaMedia or ChineseList or MediaUK</ListType>
      <Service xsi:type="tns:Service">Fax or Email or SMS or TextToSpeech or TextToSpeechMobile or TwoWaySMS or TwoWayTTS or TwoWayTTSMobile or InboundVoice</Service>
      <Cost xsi:type="xsd:double">double</Cost>
    </tns:ListCosts>
    <tns:ListCosts id="id5" xsi:type="tns:ListCosts">
      <ListType xsi:type="tns:ListType">AuMedia or AuBusinesss or AuGovernment or Messaging or USMedia or AsiaMedia or ChineseList or MediaUK</ListType>
      <Service xsi:type="tns:Service">Fax or Email or SMS or TextToSpeech or TextToSpeechMobile or TwoWaySMS or TwoWayTTS or TwoWayTTSMobile or InboundVoice</Service>
      <Cost xsi:type="xsd:double">double</Cost>
    </tns:ListCosts>
  </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:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://message-service.org/" xmlns:types="http://message-service.org/encodedTypes" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <tns:AddUserResponse>
      <AddUserResult xsi:type="xsd:boolean">boolean</AddUserResult>
    </tns:AddUserResponse>
  </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 /Webservice.asmx HTTP/1.1
Host: message-service.org
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:soapenc="http://www.w3.org/2003/05/soap-encoding" xmlns:tns="http://message-service.org/" xmlns:types="http://message-service.org/encodedTypes" xmlns:rpc="http://www.w3.org/2003/05/soap-rpc" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <tns:AuthenticationHeader soapenc:id="id0">
      <Username xsi:type="xsd:string">string</Username>
      <Password xsi:type="xsd:string">string</Password>
      <Usercode xsi:type="xsd:string">string</Usercode>
    </tns:AuthenticationHeader>
  </soap12:Header>
  <soap12:Body soap12:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
    <tns:AddUser>
      <user soapenc:id="id1" xsi:type="tns:User">
        <UserCode xsi:type="xsd:string">string</UserCode>
        <Title xsi:type="xsd:string">string</Title>
        <FirstName xsi:type="xsd:string">string</FirstName>
        <LastName xsi:type="xsd:string">string</LastName>
        <Email xsi:type="xsd:string">string</Email>
        <Phone xsi:type="xsd:string">string</Phone>
        <Fax xsi:type="xsd:string">string</Fax>
        <Mobile xsi:type="xsd:string">string</Mobile>
        <CallBackURL xsi:type="xsd:string">string</CallBackURL>
        <FaxHeaderText xsi:type="xsd:string">string</FaxHeaderText>
        <Company soapenc:id="id2" xsi:type="tns:Company">
          <CompanyName xsi:type="xsd:string">string</CompanyName>
          <Address xsi:type="xsd:string">string</Address>
          <City xsi:type="xsd:string">string</City>
          <Postcode xsi:type="xsd:string">string</Postcode>
          <State xsi:type="xsd:string">string</State>
          <Country xsi:type="xsd:string">string</Country>
          <ABN xsi:type="xsd:string">string</ABN>
          <AgentID xsi:type="xsd:int">int</AgentID>
          <IsNew xsi:type="xsd:boolean">boolean</IsNew>
        </Company>
        <Password xsi:type="xsd:string">string</Password>
        <ReportType xsi:type="tns:ReportType">Detailed or Exception or Summary</ReportType>
        <MonthlyLimit xsi:type="xsd:double">double</MonthlyLimit>
        <IsFax xsi:type="xsd:boolean">boolean</IsFax>
        <IsSms xsi:type="xsd:boolean">boolean</IsSms>
        <IsTts xsi:type="xsd:boolean">boolean</IsTts>
        <IsTtsTwoWay xsi:type="xsd:boolean">boolean</IsTtsTwoWay>
        <IsEmail xsi:type="xsd:boolean">boolean</IsEmail>
        <IsAntiSpam xsi:type="xsd:boolean">boolean</IsAntiSpam>
        <IsLive xsi:type="xsd:boolean">boolean</IsLive>
        <EmailToBroadcastAuthType xsi:type="xsd:string">string</EmailToBroadcastAuthType>
        <EmailToBroadcastEmailAddress xsi:type="xsd:string">string</EmailToBroadcastEmailAddress>
        <BroadcastLimitWarnAddress xsi:type="xsd:string">string</BroadcastLimitWarnAddress>
        <DefaultTTSVoice xsi:type="xsd:string">string</DefaultTTSVoice>
        <TTSRepeatCount xsi:type="xsd:string">string</TTSRepeatCount>
        <SMSSenderID xsi:type="xsd:string">string</SMSSenderID>
        <EmailToBroadcastSubjectBehaviour xsi:type="xsd:string">string</EmailToBroadcastSubjectBehaviour>
        <EmailToBroadcastSignatureStart xsi:type="xsd:string">string</EmailToBroadcastSignatureStart>
        <EmailToBroadcastBodyAsFaxCover xsi:type="xsd:string">string</EmailToBroadcastBodyAsFaxCover>
        <FaxVoicePriority xsi:type="xsd:int">int</FaxVoicePriority>
        <VoiceCallerID xsi:type="xsd:string">string</VoiceCallerID>
        <CreditLimitForAlert xsi:type="xsd:string">string</CreditLimitForAlert>
        <CreditLimitAlertAddress xsi:type="xsd:string">string</CreditLimitAlertAddress>
        <EtoBXcode xsi:type="xsd:string">string</EtoBXcode>
        <HideCostsInReport xsi:type="xsd:string">string</HideCostsInReport>
        <SMSFilterOutNonAscii xsi:type="xsd:string">string</SMSFilterOutNonAscii>
        <TTSCharLimit xsi:type="xsd:string">string</TTSCharLimit>
        <DefaultSMSReplyEmail xsi:type="xsd:string">string</DefaultSMSReplyEmail>
        <TTSMsgPrefix xsi:type="xsd:string">string</TTSMsgPrefix>
        <DocRetentionHours xsi:type="xsd:string">string</DocRetentionHours>
        <InboundFaxEmail xsi:type="xsd:string">string</InboundFaxEmail>
        <ShowRecipientsInOnlineReport xsi:type="xsd:string">string</ShowRecipientsInOnlineReport>
        <ShowRecipientsInEmailReport xsi:type="xsd:string">string</ShowRecipientsInEmailReport>
        <IncludeCopyOfFaxInReport xsi:type="xsd:string">string</IncludeCopyOfFaxInReport>
        <HideAccounts xsi:type="xsd:string">string</HideAccounts>
        <EmailToBroadcastIPWhiteList xsi:type="xsd:string">string</EmailToBroadcastIPWhiteList>
        <EmailToBroadcastIPWhiteListAlertEmail xsi:type="xsd:string">string</EmailToBroadcastIPWhiteListAlertEmail>
        <TimeZoneID xsi:type="xsd:string">string</TimeZoneID>
        <DoNotBillUser xsi:type="xsd:string">string</DoNotBillUser>
        <AccountType xsi:type="xsd:string">string</AccountType>
        <PreferredSMSCarrier xsi:type="xsd:string">string</PreferredSMSCarrier>
        <UserReceiveReports xsi:type="xsd:string">string</UserReceiveReports>
        <ListCosts soapenc:id="id3" soapenc:itemType="tns:ListCosts" soapenc:arraySize="2">
          <Item soapenc:id="id4">
            <ListType xsi:type="tns:ListType">AuMedia or AuBusinesss or AuGovernment or Messaging or USMedia or AsiaMedia or ChineseList or MediaUK</ListType>
            <Service xsi:type="tns:Service">Fax or Email or SMS or TextToSpeech or TextToSpeechMobile or TwoWaySMS or TwoWayTTS or TwoWayTTSMobile or InboundVoice</Service>
            <Cost xsi:type="xsd:double">double</Cost>
          </Item>
          <Item soapenc:id="id5">
            <ListType xsi:type="tns:ListType">AuMedia or AuBusinesss or AuGovernment or Messaging or USMedia or AsiaMedia or ChineseList or MediaUK</ListType>
            <Service xsi:type="tns:Service">Fax or Email or SMS or TextToSpeech or TextToSpeechMobile or TwoWaySMS or TwoWayTTS or TwoWayTTSMobile or InboundVoice</Service>
            <Cost xsi:type="xsd:double">double</Cost>
          </Item>
        </ListCosts>
      </user>
    </tns:AddUser>
  </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:soapenc="http://www.w3.org/2003/05/soap-encoding" xmlns:tns="http://message-service.org/" xmlns:types="http://message-service.org/encodedTypes" xmlns:rpc="http://www.w3.org/2003/05/soap-rpc" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body soap12:encodingStyle="http://www.w3.org/2003/05/soap-encoding">
    <tns:AddUserResponse>
      <rpc:result xmlns="">AddUserResult</rpc:result>
      <AddUserResult xsi:type="xsd:boolean">boolean</AddUserResult>
    </tns:AddUserResponse>
  </soap12:Body>
</soap12:Envelope>