CEAAPI_v2 Web Service

CEAAPI_v2

Click here for a complete list of operations.

ExtCreateBroadcast

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/CEAAPI_v2.asmx HTTP/1.1
Host: api.call-em-all.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://call-em-all.com/ExtCreateBroadcast"

<?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>
    <ExtCreateBroadcast xmlns="http://call-em-all.com/">
      <myRequest>
        <username>string</username>
        <pin>string</pin>
        <TTSText>string</TTSText>
        <TTSTextVM>string</TTSTextVM>
        <answerHandling>string</answerHandling>
        <broadcastName>string</broadcastName>
        <broadcastType>string</broadcastType>
        <callerID>string</callerID>
        <checkCallingWindow>string</checkCallingWindow>
        <commaDelimitedPhoneNumbers>string</commaDelimitedPhoneNumbers>
        <launchDateTime>string</launchDateTime>
        <listID>string</listID>
        <messageID>string</messageID>
        <messageIDVM>string</messageIDVM>
        <notifyEmail>string</notifyEmail>
        <phoneNumberCSV>base64Binary</phoneNumberCSV>
        <phoneNumberSource>string</phoneNumberSource>
        <smsMsg>string</smsMsg>
        <survey>
          <Surveyoptions>
            <AudioID>string</AudioID>
            <TTSTextResponse>string</TTSTextResponse>
            <action>string</action>
            <followUp>string</followUp>
          </Surveyoptions>
          <Surveyoptions>
            <AudioID>string</AudioID>
            <TTSTextResponse>string</TTSTextResponse>
            <action>string</action>
            <followUp>string</followUp>
          </Surveyoptions>
        </survey>
        <throttle>string</throttle>
      </myRequest>
    </ExtCreateBroadcast>
  </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>
    <ExtCreateBroadcastResponse xmlns="http://call-em-all.com/">
      <ExtCreateBroadcastResult>
        <MaxCallUnitsUsed>int</MaxCallUnitsUsed>
        <MaxMessageLength>int</MaxMessageLength>
        <SMSbroadcastID>string</SMSbroadcastID>
        <badRecordCountOnFile>int</badRecordCountOnFile>
        <broadcastID>string</broadcastID>
        <duplicateRecrodCountOnFile>int</duplicateRecrodCountOnFile>
        <errorCode>int</errorCode>
        <errorMessage>string</errorMessage>
        <fileUploadErrors>
          <ExtFileUploadError>
            <PhoneNumber>string</PhoneNumber>
            <errorCode>int</errorCode>
            <errorMessage>string</errorMessage>
            <lineNumber>long</lineNumber>
          </ExtFileUploadError>
          <ExtFileUploadError>
            <PhoneNumber>string</PhoneNumber>
            <errorCode>int</errorCode>
            <errorMessage>string</errorMessage>
            <lineNumber>long</lineNumber>
          </ExtFileUploadError>
        </fileUploadErrors>
        <goodRecordCountOnFile>int</goodRecordCountOnFile>
        <messageRecordingID>string</messageRecordingID>
        <smsRecordCountOnFile>int</smsRecordCountOnFile>
        <tollFreeNumber>string</tollFreeNumber>
        <totalRecordCountOnFile>int</totalRecordCountOnFile>
        <voiceRecordCountOnFile>int</voiceRecordCountOnFile>
        <duplicateRecordCountOnFile>int</duplicateRecordCountOnFile>
      </ExtCreateBroadcastResult>
    </ExtCreateBroadcastResponse>
  </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/CEAAPI_v2.asmx HTTP/1.1
Host: api.call-em-all.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>
    <ExtCreateBroadcast xmlns="http://call-em-all.com/">
      <myRequest>
        <username>string</username>
        <pin>string</pin>
        <TTSText>string</TTSText>
        <TTSTextVM>string</TTSTextVM>
        <answerHandling>string</answerHandling>
        <broadcastName>string</broadcastName>
        <broadcastType>string</broadcastType>
        <callerID>string</callerID>
        <checkCallingWindow>string</checkCallingWindow>
        <commaDelimitedPhoneNumbers>string</commaDelimitedPhoneNumbers>
        <launchDateTime>string</launchDateTime>
        <listID>string</listID>
        <messageID>string</messageID>
        <messageIDVM>string</messageIDVM>
        <notifyEmail>string</notifyEmail>
        <phoneNumberCSV>base64Binary</phoneNumberCSV>
        <phoneNumberSource>string</phoneNumberSource>
        <smsMsg>string</smsMsg>
        <survey>
          <Surveyoptions>
            <AudioID>string</AudioID>
            <TTSTextResponse>string</TTSTextResponse>
            <action>string</action>
            <followUp>string</followUp>
          </Surveyoptions>
          <Surveyoptions>
            <AudioID>string</AudioID>
            <TTSTextResponse>string</TTSTextResponse>
            <action>string</action>
            <followUp>string</followUp>
          </Surveyoptions>
        </survey>
        <throttle>string</throttle>
      </myRequest>
    </ExtCreateBroadcast>
  </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>
    <ExtCreateBroadcastResponse xmlns="http://call-em-all.com/">
      <ExtCreateBroadcastResult>
        <MaxCallUnitsUsed>int</MaxCallUnitsUsed>
        <MaxMessageLength>int</MaxMessageLength>
        <SMSbroadcastID>string</SMSbroadcastID>
        <badRecordCountOnFile>int</badRecordCountOnFile>
        <broadcastID>string</broadcastID>
        <duplicateRecrodCountOnFile>int</duplicateRecrodCountOnFile>
        <errorCode>int</errorCode>
        <errorMessage>string</errorMessage>
        <fileUploadErrors>
          <ExtFileUploadError>
            <PhoneNumber>string</PhoneNumber>
            <errorCode>int</errorCode>
            <errorMessage>string</errorMessage>
            <lineNumber>long</lineNumber>
          </ExtFileUploadError>
          <ExtFileUploadError>
            <PhoneNumber>string</PhoneNumber>
            <errorCode>int</errorCode>
            <errorMessage>string</errorMessage>
            <lineNumber>long</lineNumber>
          </ExtFileUploadError>
        </fileUploadErrors>
        <goodRecordCountOnFile>int</goodRecordCountOnFile>
        <messageRecordingID>string</messageRecordingID>
        <smsRecordCountOnFile>int</smsRecordCountOnFile>
        <tollFreeNumber>string</tollFreeNumber>
        <totalRecordCountOnFile>int</totalRecordCountOnFile>
        <voiceRecordCountOnFile>int</voiceRecordCountOnFile>
        <duplicateRecordCountOnFile>int</duplicateRecordCountOnFile>
      </ExtCreateBroadcastResult>
    </ExtCreateBroadcastResponse>
  </soap12:Body>
</soap12:Envelope>