Contacts Web Service

Contacts

Click here for a complete list of operations.

GetContacts

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
username:
password:
groupId:
keyword:
from:
count:

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 /post/contacts.asmx HTTP/1.1
Host: api.smsdev.ir
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/GetContacts"

<?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>
    <GetContacts xmlns="http://tempuri.org/">
      <username>string</username>
      <password>string</password>
      <groupId>int</groupId>
      <keyword>string</keyword>
      <from>int</from>
      <count>int</count>
    </GetContacts>
  </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>
    <GetContactsResponse xmlns="http://tempuri.org/">
      <GetContactsResult>
        <ContactsGridList>
          <ContactID>int</ContactID>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <NickName>string</NickName>
          <Corporation>string</Corporation>
          <MobileNumbers>string</MobileNumbers>
          <FaxNumber>string</FaxNumber>
          <Email>string</Email>
          <Gender>unsignedByte</Gender>
          <Descriptions>string</Descriptions>
          <CreateDate>dateTime</CreateDate>
          <Groups>string</Groups>
          <Credit>double</Credit>
          <AdditionalDate>dateTime</AdditionalDate>
          <BirthDate>dateTime</BirthDate>
          <ContactSort>int</ContactSort>
          <ContactStatus>unsignedByte</ContactStatus>
          <AdditionalText>string</AdditionalText>
        </ContactsGridList>
        <ContactsGridList>
          <ContactID>int</ContactID>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <NickName>string</NickName>
          <Corporation>string</Corporation>
          <MobileNumbers>string</MobileNumbers>
          <FaxNumber>string</FaxNumber>
          <Email>string</Email>
          <Gender>unsignedByte</Gender>
          <Descriptions>string</Descriptions>
          <CreateDate>dateTime</CreateDate>
          <Groups>string</Groups>
          <Credit>double</Credit>
          <AdditionalDate>dateTime</AdditionalDate>
          <BirthDate>dateTime</BirthDate>
          <ContactSort>int</ContactSort>
          <ContactStatus>unsignedByte</ContactStatus>
          <AdditionalText>string</AdditionalText>
        </ContactsGridList>
      </GetContactsResult>
    </GetContactsResponse>
  </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 /post/contacts.asmx HTTP/1.1
Host: api.smsdev.ir
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>
    <GetContacts xmlns="http://tempuri.org/">
      <username>string</username>
      <password>string</password>
      <groupId>int</groupId>
      <keyword>string</keyword>
      <from>int</from>
      <count>int</count>
    </GetContacts>
  </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>
    <GetContactsResponse xmlns="http://tempuri.org/">
      <GetContactsResult>
        <ContactsGridList>
          <ContactID>int</ContactID>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <NickName>string</NickName>
          <Corporation>string</Corporation>
          <MobileNumbers>string</MobileNumbers>
          <FaxNumber>string</FaxNumber>
          <Email>string</Email>
          <Gender>unsignedByte</Gender>
          <Descriptions>string</Descriptions>
          <CreateDate>dateTime</CreateDate>
          <Groups>string</Groups>
          <Credit>double</Credit>
          <AdditionalDate>dateTime</AdditionalDate>
          <BirthDate>dateTime</BirthDate>
          <ContactSort>int</ContactSort>
          <ContactStatus>unsignedByte</ContactStatus>
          <AdditionalText>string</AdditionalText>
        </ContactsGridList>
        <ContactsGridList>
          <ContactID>int</ContactID>
          <FirstName>string</FirstName>
          <LastName>string</LastName>
          <NickName>string</NickName>
          <Corporation>string</Corporation>
          <MobileNumbers>string</MobileNumbers>
          <FaxNumber>string</FaxNumber>
          <Email>string</Email>
          <Gender>unsignedByte</Gender>
          <Descriptions>string</Descriptions>
          <CreateDate>dateTime</CreateDate>
          <Groups>string</Groups>
          <Credit>double</Credit>
          <AdditionalDate>dateTime</AdditionalDate>
          <BirthDate>dateTime</BirthDate>
          <ContactSort>int</ContactSort>
          <ContactStatus>unsignedByte</ContactStatus>
          <AdditionalText>string</AdditionalText>
        </ContactsGridList>
      </GetContactsResult>
    </GetContactsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /post/contacts.asmx/GetContacts?username=string&password=string&groupId=string&keyword=string&from=string&count=string HTTP/1.1
Host: api.smsdev.ir

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfContactsGridList xmlns="http://tempuri.org/">
  <ContactsGridList>
    <ContactID>int</ContactID>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <NickName>string</NickName>
    <Corporation>string</Corporation>
    <MobileNumbers>string</MobileNumbers>
    <FaxNumber>string</FaxNumber>
    <Email>string</Email>
    <Gender>unsignedByte</Gender>
    <Descriptions>string</Descriptions>
    <CreateDate>dateTime</CreateDate>
    <Groups>string</Groups>
    <Credit>double</Credit>
    <AdditionalDate>dateTime</AdditionalDate>
    <BirthDate>dateTime</BirthDate>
    <ContactSort>int</ContactSort>
    <ContactStatus>unsignedByte</ContactStatus>
    <AdditionalText>string</AdditionalText>
  </ContactsGridList>
  <ContactsGridList>
    <ContactID>int</ContactID>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <NickName>string</NickName>
    <Corporation>string</Corporation>
    <MobileNumbers>string</MobileNumbers>
    <FaxNumber>string</FaxNumber>
    <Email>string</Email>
    <Gender>unsignedByte</Gender>
    <Descriptions>string</Descriptions>
    <CreateDate>dateTime</CreateDate>
    <Groups>string</Groups>
    <Credit>double</Credit>
    <AdditionalDate>dateTime</AdditionalDate>
    <BirthDate>dateTime</BirthDate>
    <ContactSort>int</ContactSort>
    <ContactStatus>unsignedByte</ContactStatus>
    <AdditionalText>string</AdditionalText>
  </ContactsGridList>
</ArrayOfContactsGridList>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /post/contacts.asmx/GetContacts HTTP/1.1
Host: api.smsdev.ir
Content-Type: application/x-www-form-urlencoded
Content-Length: length

username=string&password=string&groupId=string&keyword=string&from=string&count=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfContactsGridList xmlns="http://tempuri.org/">
  <ContactsGridList>
    <ContactID>int</ContactID>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <NickName>string</NickName>
    <Corporation>string</Corporation>
    <MobileNumbers>string</MobileNumbers>
    <FaxNumber>string</FaxNumber>
    <Email>string</Email>
    <Gender>unsignedByte</Gender>
    <Descriptions>string</Descriptions>
    <CreateDate>dateTime</CreateDate>
    <Groups>string</Groups>
    <Credit>double</Credit>
    <AdditionalDate>dateTime</AdditionalDate>
    <BirthDate>dateTime</BirthDate>
    <ContactSort>int</ContactSort>
    <ContactStatus>unsignedByte</ContactStatus>
    <AdditionalText>string</AdditionalText>
  </ContactsGridList>
  <ContactsGridList>
    <ContactID>int</ContactID>
    <FirstName>string</FirstName>
    <LastName>string</LastName>
    <NickName>string</NickName>
    <Corporation>string</Corporation>
    <MobileNumbers>string</MobileNumbers>
    <FaxNumber>string</FaxNumber>
    <Email>string</Email>
    <Gender>unsignedByte</Gender>
    <Descriptions>string</Descriptions>
    <CreateDate>dateTime</CreateDate>
    <Groups>string</Groups>
    <Credit>double</Credit>
    <AdditionalDate>dateTime</AdditionalDate>
    <BirthDate>dateTime</BirthDate>
    <ContactSort>int</ContactSort>
    <ContactStatus>unsignedByte</ContactStatus>
    <AdditionalText>string</AdditionalText>
  </ContactsGridList>
</ArrayOfContactsGridList>