EP


Click here for a complete list of operations.

ByAccount

Reports messages received from address book contacts by group name or group ID.

Parameter
Notes
Username: 
Password: 
ReportType:Provide a valid integer representing one of the report types. The following shows the integers and their corresponding report types:
  • 10 = ByAccount.
  • 11 = ByAccountBetweenDates.
Shared:Provide a string value of 'True' or 'False'. Set this parameter to 'True' if you are stating that you are using a shared 2-way number. Set this parameter to 'False' if you are stating that you are using a private 2-way number.
GroupType:Provide a valid integer group type. This can be set to one of the following:
  • 1 = GroupID.
  • 2 = GroupName.
Group:Provide a valid group name or group ID from your address book.
StartDate:Provide a valid date/time string that represents the start date/time of the report. If you select the report type ByAccount you can set this parameter to null.
EndDate:Provide a valid date/time string that represents the end date/time of the report. If you select the report type ByAccount you can set this parameter to null.
ReportCSV:Provide a string data type output parameter. This will be populated with a CSV standard format string of records containing information about all of contacts that have sent a message to the emergency planning number.
ResultText:E.g. 3 records were returned.
Code: 

Test

The test form is only available for methods with primitive types as parameters.

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/2.0/Simple/EP.asmx HTTP/1.1
Host: www.2sms.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.2sms.com/WebServices/2.0/Simple/ByAccount"

<?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>
    <ByAccount xmlns="http://www.2sms.com/WebServices/2.0/Simple/">
      <Username>string</Username>
      <Password>string</Password>
      <ReportType>int</ReportType>
      <Shared>string</Shared>
      <GroupType>int</GroupType>
      <Group>string</Group>
      <StartDate>string</StartDate>
      <EndDate>string</EndDate>
      <ReportCSV>string</ReportCSV>
      <ResultText>string</ResultText>
      <Code>string</Code>
    </ByAccount>
  </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>
    <ByAccountResponse xmlns="http://www.2sms.com/WebServices/2.0/Simple/">
      <ByAccountResult>string</ByAccountResult>
      <ReportCSV>string</ReportCSV>
      <ResultText>string</ResultText>
      <Code>string</Code>
    </ByAccountResponse>
  </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/2.0/Simple/EP.asmx HTTP/1.1
Host: www.2sms.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>
    <ByAccount xmlns="http://www.2sms.com/WebServices/2.0/Simple/">
      <Username>string</Username>
      <Password>string</Password>
      <ReportType>int</ReportType>
      <Shared>string</Shared>
      <GroupType>int</GroupType>
      <Group>string</Group>
      <StartDate>string</StartDate>
      <EndDate>string</EndDate>
      <ReportCSV>string</ReportCSV>
      <ResultText>string</ResultText>
      <Code>string</Code>
    </ByAccount>
  </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>
    <ByAccountResponse xmlns="http://www.2sms.com/WebServices/2.0/Simple/">
      <ByAccountResult>string</ByAccountResult>
      <ReportCSV>string</ReportCSV>
      <ResultText>string</ResultText>
      <Code>string</Code>
    </ByAccountResponse>
  </soap12:Body>
</soap12:Envelope>