API

Click here for a complete list of operations.

SendMailTemplate

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.asmx HTTP/1.1
Host: extws.sgs1.ott.kaltura.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.tvinci.com/SendMailTemplate"

<?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>
    <SendMailTemplate xmlns="http://api.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <request>
        <m_sTemplateName>string</m_sTemplateName>
        <m_sFirstName>string</m_sFirstName>
        <m_sLastName>string</m_sLastName>
        <m_sSubject>string</m_sSubject>
        <m_sSenderName>string</m_sSenderName>
        <m_sSenderFrom>string</m_sSenderFrom>
        <m_sSenderTo>string</m_sSenderTo>
        <m_sBCCAddress>string</m_sBCCAddress>
        <m_emailKey>string</m_emailKey>
        <groupId>int</groupId>
        <m_eMailType>Welcome or ForgotPassword or Purchase or SendToFriend or Token or PaymentFail or SendPassword or ChangedPin or Notification or AddUserToDomain or ChangePassword or PreviewModuleCancelOrRefund or PurchaseWithPreviewModule or AddDeviceToDomain or RemoveDomain or PurchaseWithGiftCard or GiftCardRenewReminder or Churn</m_eMailType>
      </request>
    </SendMailTemplate>
  </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>
    <SendMailTemplateResponse xmlns="http://api.tvinci.com/">
      <SendMailTemplateResult>boolean</SendMailTemplateResult>
    </SendMailTemplateResponse>
  </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.asmx HTTP/1.1
Host: extws.sgs1.ott.kaltura.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>
    <SendMailTemplate xmlns="http://api.tvinci.com/">
      <sWSUserName>string</sWSUserName>
      <sWSPassword>string</sWSPassword>
      <request>
        <m_sTemplateName>string</m_sTemplateName>
        <m_sFirstName>string</m_sFirstName>
        <m_sLastName>string</m_sLastName>
        <m_sSubject>string</m_sSubject>
        <m_sSenderName>string</m_sSenderName>
        <m_sSenderFrom>string</m_sSenderFrom>
        <m_sSenderTo>string</m_sSenderTo>
        <m_sBCCAddress>string</m_sBCCAddress>
        <m_emailKey>string</m_emailKey>
        <groupId>int</groupId>
        <m_eMailType>Welcome or ForgotPassword or Purchase or SendToFriend or Token or PaymentFail or SendPassword or ChangedPin or Notification or AddUserToDomain or ChangePassword or PreviewModuleCancelOrRefund or PurchaseWithPreviewModule or AddDeviceToDomain or RemoveDomain or PurchaseWithGiftCard or GiftCardRenewReminder or Churn</m_eMailType>
      </request>
    </SendMailTemplate>
  </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>
    <SendMailTemplateResponse xmlns="http://api.tvinci.com/">
      <SendMailTemplateResult>boolean</SendMailTemplateResult>
    </SendMailTemplateResponse>
  </soap12:Body>
</soap12:Envelope>