APIService Web Service

APIService

Click here for a complete list of operations.

ConfigSMSDestination

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 /Services/APIService.asmx HTTP/1.1
Host: backoffice.voipinnovations.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/ConfigSMSDestination"

<?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>
    <ConfigSMSDestination xmlns="http://tempuri.org/">
      <login>string</login>
      <secret>string</secret>
      <tn>string</tn>
      <destinationType>NONE or SIP or EMAIL or FORWARD or POST or GET or PROGTELCO or MSTEAMS</destinationType>
      <destination>string</destination>
      <authToken>string</authToken>
    </ConfigSMSDestination>
  </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>
    <ConfigSMSDestinationResponse xmlns="http://tempuri.org/">
      <ConfigSMSDestinationResult>
        <responseCode>int</responseCode>
        <responseMessage>string</responseMessage>
        <DIDs>
          <SMSDID>
            <TN>string</TN>
            <ForwardEmail>string</ForwardEmail>
            <Editable>boolean</Editable>
            <Enabled>boolean</Enabled>
            <DLR>boolean</DLR>
            <OffNetwork>boolean</OffNetwork>
            <CampaignID>string</CampaignID>
            <CampaignName>string</CampaignName>
            <Is10DLCRegistered>boolean</Is10DLCRegistered>
            <Failed10DLCNote>string</Failed10DLCNote>
            <DestinationType>NONE or SIP or EMAIL or FORWARD or POST or GET or PROGTELCO or MSTEAMS</DestinationType>
            <Destination>string</Destination>
            <APIAuthToken>string</APIAuthToken>
          </SMSDID>
          <SMSDID>
            <TN>string</TN>
            <ForwardEmail>string</ForwardEmail>
            <Editable>boolean</Editable>
            <Enabled>boolean</Enabled>
            <DLR>boolean</DLR>
            <OffNetwork>boolean</OffNetwork>
            <CampaignID>string</CampaignID>
            <CampaignName>string</CampaignName>
            <Is10DLCRegistered>boolean</Is10DLCRegistered>
            <Failed10DLCNote>string</Failed10DLCNote>
            <DestinationType>NONE or SIP or EMAIL or FORWARD or POST or GET or PROGTELCO or MSTEAMS</DestinationType>
            <Destination>string</Destination>
            <APIAuthToken>string</APIAuthToken>
          </SMSDID>
        </DIDs>
        <MsgDetails>
          <success>boolean</success>
          <code>string</code>
          <data>string</data>
          <status>string</status>
          <uuid>string</uuid>
          <remote_ids>
            <string>string</string>
            <string>string</string>
          </remote_ids>
        </MsgDetails>
        <Uuid>string</Uuid>
      </ConfigSMSDestinationResult>
    </ConfigSMSDestinationResponse>
  </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 /Services/APIService.asmx HTTP/1.1
Host: backoffice.voipinnovations.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>
    <ConfigSMSDestination xmlns="http://tempuri.org/">
      <login>string</login>
      <secret>string</secret>
      <tn>string</tn>
      <destinationType>NONE or SIP or EMAIL or FORWARD or POST or GET or PROGTELCO or MSTEAMS</destinationType>
      <destination>string</destination>
      <authToken>string</authToken>
    </ConfigSMSDestination>
  </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>
    <ConfigSMSDestinationResponse xmlns="http://tempuri.org/">
      <ConfigSMSDestinationResult>
        <responseCode>int</responseCode>
        <responseMessage>string</responseMessage>
        <DIDs>
          <SMSDID>
            <TN>string</TN>
            <ForwardEmail>string</ForwardEmail>
            <Editable>boolean</Editable>
            <Enabled>boolean</Enabled>
            <DLR>boolean</DLR>
            <OffNetwork>boolean</OffNetwork>
            <CampaignID>string</CampaignID>
            <CampaignName>string</CampaignName>
            <Is10DLCRegistered>boolean</Is10DLCRegistered>
            <Failed10DLCNote>string</Failed10DLCNote>
            <DestinationType>NONE or SIP or EMAIL or FORWARD or POST or GET or PROGTELCO or MSTEAMS</DestinationType>
            <Destination>string</Destination>
            <APIAuthToken>string</APIAuthToken>
          </SMSDID>
          <SMSDID>
            <TN>string</TN>
            <ForwardEmail>string</ForwardEmail>
            <Editable>boolean</Editable>
            <Enabled>boolean</Enabled>
            <DLR>boolean</DLR>
            <OffNetwork>boolean</OffNetwork>
            <CampaignID>string</CampaignID>
            <CampaignName>string</CampaignName>
            <Is10DLCRegistered>boolean</Is10DLCRegistered>
            <Failed10DLCNote>string</Failed10DLCNote>
            <DestinationType>NONE or SIP or EMAIL or FORWARD or POST or GET or PROGTELCO or MSTEAMS</DestinationType>
            <Destination>string</Destination>
            <APIAuthToken>string</APIAuthToken>
          </SMSDID>
        </DIDs>
        <MsgDetails>
          <success>boolean</success>
          <code>string</code>
          <data>string</data>
          <status>string</status>
          <uuid>string</uuid>
          <remote_ids>
            <string>string</string>
            <string>string</string>
          </remote_ids>
        </MsgDetails>
        <Uuid>string</Uuid>
      </ConfigSMSDestinationResult>
    </ConfigSMSDestinationResponse>
  </soap12:Body>
</soap12:Envelope>