CEAAPI_v3_2_13


Click here for a complete list of operations.

CreateDetailedBroadcast

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_v3-2-13.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/CreateDetailedBroadcast"

<?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>
    <CreateDetailedBroadcast xmlns="http://call-em-all.com/">
      <myRequest>
        <username>string</username>
        <pin>string</pin>
        <broadcastType>string</broadcastType>
        <broadcastName>string</broadcastName>
        <launchDateTime>string</launchDateTime>
        <checkCallingWindow>string</checkCallingWindow>
        <callerID>string</callerID>
        <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>
        <answerHandling>string</answerHandling>
        <notifyEmail>string</notifyEmail>
        <defaultAudio>
          <messageID>string</messageID>
          <TTSText>string</TTSText>
        </defaultAudio>
        <callDetails>
          <DetailedBroadcastContact>
            <phoneNumber>string</phoneNumber>
            <firstName>string</firstName>
            <lastName>string</lastName>
            <messageID>string</messageID>
            <TTSText>string</TTSText>
            <smsMsg>string</smsMsg>
          </DetailedBroadcastContact>
          <DetailedBroadcastContact>
            <phoneNumber>string</phoneNumber>
            <firstName>string</firstName>
            <lastName>string</lastName>
            <messageID>string</messageID>
            <TTSText>string</TTSText>
            <smsMsg>string</smsMsg>
          </DetailedBroadcastContact>
        </callDetails>
      </myRequest>
    </CreateDetailedBroadcast>
  </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>
    <CreateDetailedBroadcastResponse xmlns="http://call-em-all.com/">
      <CreateDetailedBroadcastResult>
        <errorCode>int</errorCode>
        <errorMessage>string</errorMessage>
        <broadcastID>string</broadcastID>
        <callDetailErrors>
          <BroadcastDetailError>
            <phoneNumber>string</phoneNumber>
            <errorCode>int</errorCode>
            <errorMessage>string</errorMessage>
          </BroadcastDetailError>
          <BroadcastDetailError>
            <phoneNumber>string</phoneNumber>
            <errorCode>int</errorCode>
            <errorMessage>string</errorMessage>
          </BroadcastDetailError>
        </callDetailErrors>
      </CreateDetailedBroadcastResult>
    </CreateDetailedBroadcastResponse>
  </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_v3-2-13.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>
    <CreateDetailedBroadcast xmlns="http://call-em-all.com/">
      <myRequest>
        <username>string</username>
        <pin>string</pin>
        <broadcastType>string</broadcastType>
        <broadcastName>string</broadcastName>
        <launchDateTime>string</launchDateTime>
        <checkCallingWindow>string</checkCallingWindow>
        <callerID>string</callerID>
        <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>
        <answerHandling>string</answerHandling>
        <notifyEmail>string</notifyEmail>
        <defaultAudio>
          <messageID>string</messageID>
          <TTSText>string</TTSText>
        </defaultAudio>
        <callDetails>
          <DetailedBroadcastContact>
            <phoneNumber>string</phoneNumber>
            <firstName>string</firstName>
            <lastName>string</lastName>
            <messageID>string</messageID>
            <TTSText>string</TTSText>
            <smsMsg>string</smsMsg>
          </DetailedBroadcastContact>
          <DetailedBroadcastContact>
            <phoneNumber>string</phoneNumber>
            <firstName>string</firstName>
            <lastName>string</lastName>
            <messageID>string</messageID>
            <TTSText>string</TTSText>
            <smsMsg>string</smsMsg>
          </DetailedBroadcastContact>
        </callDetails>
      </myRequest>
    </CreateDetailedBroadcast>
  </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>
    <CreateDetailedBroadcastResponse xmlns="http://call-em-all.com/">
      <CreateDetailedBroadcastResult>
        <errorCode>int</errorCode>
        <errorMessage>string</errorMessage>
        <broadcastID>string</broadcastID>
        <callDetailErrors>
          <BroadcastDetailError>
            <phoneNumber>string</phoneNumber>
            <errorCode>int</errorCode>
            <errorMessage>string</errorMessage>
          </BroadcastDetailError>
          <BroadcastDetailError>
            <phoneNumber>string</phoneNumber>
            <errorCode>int</errorCode>
            <errorMessage>string</errorMessage>
          </BroadcastDetailError>
        </callDetailErrors>
      </CreateDetailedBroadcastResult>
    </CreateDetailedBroadcastResponse>
  </soap12:Body>
</soap12:Envelope>