مقادیر

وب‌سرویس‌های کاربری

برای دریافت اعتبار کاربر از مقدار operation برابر با GetUserCredit استفاده کرده و به همراه نام کاربری و رمز عبور در یک ساختار XML ارسال کنید.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
  <SOAP-ENV:Body>
    <ideh:GetUserCredit soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <username xsi:type="xsd:string">...</username>
      <password xsi:type="xsd:string">...</password>
    </ideh:GetUserCredit>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
            

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <status xsi:type="xsd:int">...</status>
      <value xsi:type="xsd:decimal">...</value>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

کلید status اولیه مشخص می‌کند که مقدار value برگردانده شده معتبر است یا خیر. در صورتی که status مساوی صفر باشد یعنی مقدار valueمعتبر و به اندازه‌ی اعتبار کاربر است. در غیر این صورت مقدار valueمعتبر نیست.

برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
        <faultcode xsi:type="xsd:string">...</faultcode>
        <faultactor xsi:type="xsd:string">...</faultactor>
        <faultstring xsi:type="xsd:string">...</faultstring>
        <detail xsi:type="xsd:string">...</detail>
      </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

جهت دریافت جزئیات حساب کاربری، مانند کد ملی از این وب‌سرویس استفاده می‌شود. برای درخواست این وب‌سرویس از مقدار operation برابر با GetUserDetails استفاده کرده و همراه با نام کاربری و رمز عبور در یک ساختار XML به صورت زیر ارسال کنید.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
  <SOAP-ENV:Body>
    <ideh:GetUserDetails soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <username xsi:type="xsd:string">...</username>
      <password xsi:type="xsd:string">...</password>
    </ideh:GetUserDetails>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <ns1:GetUserDetailsResponse xmlns:ns1="idehpayam-api">
        <return xsi:type="tns:UserDetailsResponse">
          <status xsi:type="xsd:int">...</status>
          <details xsi:type="tns:UserDetails">
            <fullname xsi:type="xsd:string">...</fullname>
            <date xsi:type="xsd:string">...</date>
            <fax xsi:type="xsd:string">...</fax>
            <mellicode xsi:type="xsd:string">...</mellicode>
            <shenasname xsi:type="xsd:string">...</shenasname>
            <addr xsi:type="xsd:string">...</addr>
            <postcode xsi:type="xsd:string">...</postcode>
          </details>
        </return>
      </ns1:GetUserDetailsResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

کلید status اولیه مشخص می‌کند که مقدار مشخص شده در کلید details معتبر است یا خیر. کلید status یا صفر است (به معنای معتبر بدون مقدار کلید details) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار details را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
        <faultcode xsi:type="xsd:string">...</faultcode>
        <faultactor xsi:type="xsd:string">...</faultactor>
        <faultstring xsi:type="xsd:string">...</faultstring>
        <detail xsi:type="xsd:string">...</detail>
      </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

برای ثبت کاربر جدید از operation برابر با RegisterUser استفاده کرده و به همراه نام کاربری و رمز عبور در یک ساختار XML ارسال کنید.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
  <SOAP-ENV:Body>
    <api:RegisterUser soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:api="SoapAPI">
      <username xsi:type="xsd:string">...</username>
      <password xsi:type="xsd:string">...</password>
      <repeatPassword xsi:type="xsd:string">...</repeatPassword>
      <firstName xsi:type="xsd:string">...</firstName>
      <lastName xsi:type="xsd:string">...</lastName>
      <name xsi:type="xsd:string">...</name>
      <melliCode xsi:type="xsd:string">...</melliCode>
      <shShenasname xsi:type="xsd:string">...</shShenasname>
      <postalCode xsi:type="xsd:string">...</postalCode>
      <phoneNumber xsi:type="xsd:string">...</phoneNumber>
      <mobileNumber xsi:type="xsd:string">...</mobileNumber>
      <email xsi:type="xsd:string">...</email>
      <addres xsi:type="xsd:string">...</addres>
      <modir xsi:type="xsd:string">...</modir>
      <package xsi:type="xsd:integer">...</package>
    </api:RegisterUser>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <ns1:RegisterUserResponse xmlns:ns1="API">
        <return xsi:type="xsd:integer">...</return>
      </ns1:RegisterUserResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

مقدار کلید return اولیه یا صفر است (به معنای موفقیت عملیات ساخت کاربر) و یا غیر صفر است که خطای پیش آمده در مورد ساخت کاربر را نشان می‌دهد. برای اطلاع از خطای پیش آمده مقدار بازگشتی return را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
        <faultcode xsi:type="xsd:string">...</faultcode>
        <faultactor xsi:type="xsd:string">...</faultactor>
        <faultstring xsi:type="xsd:string">...</faultstring>
        <detail xsi:type="xsd:string">...</detail>
      </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

وب‌سرویس‌های ارسال پیامک

برای ارسال پیامک از operation برابر با SendSms همراه با نام کاربری و رمز عبور به شکل زیر استفاده کنید.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
  <SOAP-ENV:Body>
    <api:SendSms soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:api="API">
      <username xsi:type="xsd:string">...</username>
      <password xsi:type="xsd:string">...</password>
      <from xsi:type="xsd:string">...</from>
      <recipients xsi:type="urn:stringArray" SOAP-ENC:arrayType="xsd:string[]" xmlns:urn="urn:Soap">
        <value>...</value>
        <value>...</value>
      </recipients>
      <message xsi:type="xsd:string">...</message>
      <type xsi:type="xsd:integer">...</type>
    </api:SendSms>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <ns1:SendSmsResponse xmlns:ns1="API">
        <return xsi:type="tns:SendSmsResponse">
          <status xsi:type="xsd:int">...</status>
          <id xsi:type="xsd:int">...</id>
        </return>
      </ns1:SendSmsResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

کلید status یا صفر است (به معنای معتبر بدون مقدار کلید id و ارسال موفقیت‌آمیز پیامک) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار id را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
        <faultcode xsi:type="xsd:string">...</faultcode>
        <faultactor xsi:type="xsd:string">...</faultactor>
        <faultstring xsi:type="xsd:string">...</faultstring>
        <detail xsi:type="xsd:string">...</detail>
      </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

برای دریافت اطلاعات آخرین پیام ارسال شده از operation برابر با GetLatestSmsDetails همراه با نام کاربری و رمز عبور به شکل زیر استفاده کنید.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
  <SOAP-ENV:Body>
    <ideh:GetLatestSmsDetails soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <username xsi:type="xsd:string">...</username>
      <password xsi:type="xsd:string">...</password>
    </ideh:GetLatestSmsDetails>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <ns1:GetLatestSmsDetailsResponse xmlns:ns1="idehpayam-api">
        <return xsi:type="tns:SmsReportResponse">
          <status xsi:type="xsd:int">...</status>
          <details xsi:type="tns:SmsReport">
            <id xsi:type="xsd:integer">...</id>
            <message xsi:type="xsd:string">...</message>
            <recipients xsi:type="xsd:integer">...</recipients>
            <from xsi:type="xsd:string">...</from>
            <state xsi:type="xsd:string">...</state>
            <now xsi:type="xsd:string">...</now>
            <time xsi:type="xsd:string">...</time>
          </details>
        </return>
      </ns1:GetLatestSmsDetailsResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

کلید status یا صفر است (به معنای معتبر بدون مقدار کلید details) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار details را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
        <faultcode xsi:type="xsd:string">...</faultcode>
        <faultactor xsi:type="xsd:string">...</faultactor>
        <faultstring xsi:type="xsd:string">...</faultstring>
        <detail xsi:type="xsd:string">...</detail>
      </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

هنگامی که پیامک توسط وب‌سرویس ارسال می‌کنید، در صورت موفقیت‌آمیز بودن ارسال، یک شناسه به ازای هر پیامک به شما برگردانده می‌شود
برای دریافت اطلاعات پیام مشخص از مقدار operation برابر با GetSmsStatus همراه با نام کاربری و رمز عبور به شکل زیر استفاده کنید.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
  <SOAP-ENV:Body>
    <ideh:GetSmsStatus soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <username xsi:type="xsd:string">...</username>
      <password xsi:type="xsd:string">...</password>
      <idArray xsi:type="urn:intArray" SOAP-ENC:arrayType="xsd:integer[]" xmlns:urn="urn:Soap">
        <value>...</value>
        <value>...</value>
      </idArray>
    </ideh:GetSmsStatus>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <ns1:GetSmsStatusResponse xmlns:ns1="idehpayam-api">
        <return xsi:type="tns:SmsStatusResponse">
          <status xsi:type="xsd:int">...</status>
          <result xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:SmsStatusItem[2]">
            <item xsi:type="tns:SmsStatusItem">
              <unique_id xsi:type="xsd:string">...</unique_id>
              <state xsi:type="xsd:int">...</state>
            </item>
            <item xsi:type="tns:SmsStatusItem">
              <unique_id xsi:type="xsd:string">...</unique_id>
              <state xsi:type="xsd:int">...</state>
            </item>
          </result>
        </return>
      </ns1:GetSmsStatusResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

کلید status یا صفر است (به معنای معتبر بدون مقدار کلید result) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار result را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت صفر بودن کلید status و معتبر بودن مقدار result، مقدار آن یک آرایه از مقادیر item است که هر item نیز خود دو کلید unique_id و state دارد. unique_id شناسه‌ی یکتای پیامک است و state وضعیت پیامک را مشخص می‌کند.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
        <faultcode xsi:type="xsd:string">...</faultcode>
        <faultactor xsi:type="xsd:string">...</faultactor>
        <faultstring xsi:type="xsd:string">...</faultstring>
        <detail xsi:type="xsd:string">...</detail>
      </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

برای ارسال پیامک در آینده از مقدار operation برابر با FutureSendSms همراه با نام کاربری و رمز عبور به شکل زیر استفاده کنید.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
  <SOAP-ENV:Body>
    <api:SendSms soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:api="API">
      <username xsi:type="xsd:string">...</username>
      <password xsi:type="xsd:string">...</password>
      <from xsi:type="xsd:string">...</from>
      <recipients xsi:type="urn:stringArray" SOAP-ENC:arrayType="xsd:string[]" xmlns:urn="urn:Soap">
        <value>...</value>
        <value>...</value>
      </recipients>
      <message xsi:type="xsd:string">...</message>
      <sendDate xsi:type="xsd:string">...</sendDate>
      <prtrys xsi:type="xsd:string">...</prtrys>
      <sentPeriod xsi:type="xsd:string">...</sentPeriod>
    </api:SendSms>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <ns1:SendSmsResponse xmlns:ns1="API">
        <return xsi:type="tns:SendSmsResponse">
          <status xsi:type="xsd:int">...</status>
          <id xsi:type="xsd:int">...</id>
        </return>
      </ns1:SendSmsResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

کلید status یا صفر است (به معنای معتبر بدون مقدار کلید id و ارسال موفقیت‌آمیز پیامک) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار id را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
        <faultcode xsi:type="xsd:string">...</faultcode>
        <faultactor xsi:type="xsd:string">...</faultactor>
        <faultstring xsi:type="xsd:string">...</faultstring>
        <detail xsi:type="xsd:string">...</detail>
      </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

برای ارسال پیامک مبتنی بر الگو از مقدار operation برابر با SendSmsByPattern همراه با نام کاربری و رمز عبور به شکل زیر استفاده کنید.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
  <SOAP-ENV:Body>
    <api:SendSms soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:api="API">
      <username xsi:type="xsd:string">...</username>
      <password xsi:type="xsd:string">...</password>
      <from xsi:type="xsd:string">...</from>
      <recipients xsi:type="urn:stringArray" SOAP-ENC:arrayType="xsd:string[]" xmlns:urn="urn:Soap">
        <value>...</value>
        <value>...</value>
      </recipients>
      <message xsi:type="xsd:string">...</message>
      <patternId xsi:type="xsd:integer">...</patternId>
      <type xsi:type="xsd:integer">...</type>
    </api:SendSms>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <ns1:SendSmsResponse xmlns:ns1="API">
        <return xsi:type="tns:SendSmsResponse">
          <status xsi:type="xsd:int">...</status>
          <id xsi:type="xsd:int">...</id>
        </return>
      </ns1:SendSmsResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

کلید status یا صفر است (به معنای معتبر بدون مقدار کلید id و ارسال موفقیت‌آمیز پیامک) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار id را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
        <faultcode xsi:type="xsd:string">...</faultcode>
        <faultactor xsi:type="xsd:string">...</faultactor>
        <faultstring xsi:type="xsd:string">...</faultstring>
        <detail xsi:type="xsd:string">...</detail>
      </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

برای ارسال پیامک به شماره‌های دفترچه تلفن از مقدار operation برابر با SendSmsToPhoneBook همراه با نام کاربری و رمز عبور به شکل زیر استفاده کنید.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
  <SOAP-ENV:Body>
    <api:SendSms soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:api="API">
      <username xsi:type="xsd:string">...</username>
      <password xsi:type="xsd:string">...</password>
      <from xsi:type="xsd:string">...</from>
      <recipients xsi:type="urn:stringArray" SOAP-ENC:arrayType="xsd:string[]" xmlns:urn="urn:Soap">
        <value>...</value>
        <value>...</value>
      </recipients>
      <bookId xsi:type="xsd:integer">...</bookId>
      <message xsi:type="xsd:string">...</message>
      <type xsi:type="xsd:integer">...</type>
    </api:SendSms>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <ns1:SendSmsResponse xmlns:ns1="API">
        <return xsi:type="tns:SendSmsResponse">
          <status xsi:type="xsd:int">...</status>
          <id xsi:type="xsd:int">...</id>
        </return>
      </ns1:SendSmsResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

کلید status یا صفر است (به معنای معتبر بدون مقدار کلید id و ارسال موفقیت‌آمیز پیامک) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار id را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
        <faultcode xsi:type="xsd:string">...</faultcode>
        <faultactor xsi:type="xsd:string">...</faultactor>
        <faultstring xsi:type="xsd:string">...</faultstring>
        <detail xsi:type="xsd:string">...</detail>
      </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

در صورتی که مایل هستید پیامک‌هایی را برای شماره‌هایی ارسال کنید و متن پیامک‌ها مختلف است می‌توانید از این وب‌سرویس استفاده کنید.
برای این کار از مقدار operation برابر با SendMultiSms همراه با نام کاربری و رمز عبور به شکل زیر استفاده کنید.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
  <SOAP-ENV:Body>
    <ideh:SendMultiSms soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <username xsi:type="xsd:string">...</username>
      <password xsi:type="xsd:string">...</password>
      <fromArray xsi:type="urn:stringArray" SOAP-ENC:arrayType="xsd:string[]" xmlns:urn="urn:Soap">
        <item xsi:type="xsd:string">...</item>
      </fromArray>
      <recipients xsi:type="urn:stringArray" SOAP-ENC:arrayType="xsd:string[]" xmlns:urn="urn:Soap">
        <item xsi:type="xsd:string">...</item>
      </recipients>
      <messageArray xsi:type="urn:stringArray" SOAP-ENC:arrayType="xsd:string[]" xmlns:urn="urn:Soap">
        <item xsi:type="xsd:string">...</item>
      </messageArray>
      <typeArray xsi:type="urn:intArray" SOAP-ENC:arrayType="xsd:integer[]" xmlns:urn="urn:Soap">
        <item xsi:type="xsd:integer">...</item>
      </typeArray>
    </ideh:SendMultiSms>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

نکته‌ی مهم در استفاده از این وب‌سرویس این است که تعداد آرایه‌های مختلف ارسال شده باید برابر باشد. مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <ns1:SendMultiSmsResponse xmlns:ns1="idehpayam-api">
        <return xsi:type="tns:SendMultiSmsResponse">
          <status xsi:type="xsd:int">...</status>
          <result xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:MultiSmsItem[1]">
            <item xsi:type="tns:MultiSmsItem">
              <status xsi:type="xsd:integer">...</status>
              <id xsi:type="xsd:integer">...</id>
            </item>
            <item xsi:type="tns:MultiSmsItem">
              <status xsi:type="xsd:integer">...</status>
              <id xsi:type="xsd:integer">...</id>
            </item>
          </result>
        </return>
      </ns1:SendMultiSmsResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

کلید status اولیه مشخص می‌کند که ادامه‌ی ساختار XML برگردانده شده مطابق انتظار یک ساختار پاسخ صحیح است. کلید result مقادیری را مشخص می‌کند که به عنوان پاسخ این وب‌سرویس دریافت کرده‌اید

مقدار result نیز خود حاوی یک آرایه است که در مولفه‌ی آن دارای دو کلید است. کلید status که یا صفر است (به معنای معتبر بدون مقدار کلید id و ارسال موفقیت‌آمیز پیامک) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار id را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
        <faultcode xsi:type="xsd:string">...</faultcode>
        <faultactor xsi:type="xsd:string">...</faultactor>
        <faultstring xsi:type="xsd:string">...</faultstring>
        <detail xsi:type="xsd:string">...</detail>
      </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

وب‌سرویس‌های دفترچه تلفن

برای استفاده از این وب‌سرویس از مقدار operation برابر با GetPhonebookList همراه با نام کاربری و رمز عبور به شکل زیر استفاده کنید.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
  <SOAP-ENV:Body>
    <ideh:GetPhonebookList soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <username xsi:type="xsd:string">...</username>
      <password xsi:type="xsd:string">...</password>
      <name xsi:type="xsd:string">...</name>
    </ideh:GetPhonebookList>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

مقدار name اختیاری است و در صورتی که ارسال شود، فقط جزئیات مربوط به دفترچه‌ی تلفن با آن نام نشان داده می‌شود. مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <ns1:GetPhonebookListResponse xmlns:ns1="idehpayam-api">
        <return xsi:type="tns:PhoneBookListResponse">
          <status xsi:type="xsd:int">...</status>
          <result xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:PhonebookItem[2]">
            <item xsi:type="tns:PhonebookItem">
              <book_id xsi:type="xsd:int">...</book_id>
              <uname xsi:type="xsd:string">...</uname>
              <title xsi:type="xsd:string">...</title>
              <count xsi:type="xsd:int">...</count>
            </item>
            <item xsi:type="tns:PhonebookItem">
              <book_id xsi:type="xsd:int">...</book_id>
              <uname xsi:type="xsd:string">...</uname>
              <title xsi:type="xsd:string">...</title>
              <count xsi:type="xsd:int">...</count>
            </item>
          </result>
        </return>
      </ns1:GetPhonebookListResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

کلید status اولیه مشخص می‌کند که مثدار آمده در result معتبر است یا خیر. در صورتی که status برابر با صفر باشد مقدار result معتبر است و حاوی آرایه‌ای از اطلاعات دفترچه‌های ایجاد شده است. در صورتی که status صفر نباشد، یعنی result مقدار معتبر ندارد و خطایی رخ داده است. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
        <faultcode xsi:type="xsd:string">...</faultcode>
        <faultactor xsi:type="xsd:string">...</faultactor>
        <faultstring xsi:type="xsd:string">...</faultstring>
        <detail xsi:type="xsd:string">...</detail>
      </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

برای استفاده از این وب‌سرویس از مقدار operation برابر با NewPhonebook همراه با نام کاربری و رمز عبور به شکل زیر استفاده کنید.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
  <SOAP-ENV:Body>
    <ideh:NewPhonebook soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <username xsi:type="xsd:string">...</username>
      <password xsi:type="xsd:string">...</password>
      <name xsi:type="xsd:string">...</name>
      <numbers xsi:type="urn:stringArray" SOAP-ENC:arrayType="xsd:string[]" xmlns:urn="urn:Soap">
        <value>...</value>
        <value>...</value>
      </numbers>
      <flag xsi:type="xsd:string">...</flag>
    </ideh:NewPhonebook>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <ns1:NewPhonebookResponse xmlns:ns1="idehpayam-api">
        <return xsi:type="tns:NewPhonebookResponse">
          <status xsi:type="xsd:int">...</status>
          <result xsi:type="xsd:int">...</result>
        </return>
      </ns1:NewPhonebookResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

کلید status یا صفر است (به معنای معتبر بدون مقدار کلید result و ساخته شدن دفترچه تلفن) و یا غیر صفر است که خطای پیش آمده در مورد نامعتبر بودن مقدار id را روشن می‌کند. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید. در صورتی که مقدار result معتبر باشد برابر شناسه‌ی دفترچه تلفن ایجاد شده است.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
        <faultcode xsi:type="xsd:string">...</faultcode>
        <faultactor xsi:type="xsd:string">...</faultactor>
        <faultstring xsi:type="xsd:string">...</faultstring>
        <detail xsi:type="xsd:string">...</detail>
      </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

برای استفاده از این وب‌سرویس از مقدار operation برابر با DeletePhonebook همراه با نام کاربری و رمز عبور به شکل زیر استفاده کنید.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
  <SOAP-ENV:Body>
    <ideh:DeletePhonebook soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <username xsi:type="xsd:string">...</username>
      <password xsi:type="xsd:string">...</password>
      <bookId xsi:type="xsd:integer">...</bookId>
    </ideh:DeletePhonebook>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <ns1:DeletePhonebookResponse xmlns:ns1="idehpayam-api">
        <return xsi:type="xsd:integer">...</return>
      </ns1:DeletePhonebookResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

مقدار کلید return اولیه یا صفر است (به معنای حذف شدن دفترچه تلفن) و یا غیر صفر است که خطای پیش آمده در هنگام انجام عملیات را نشان می‌دهد. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
        <faultcode xsi:type="xsd:string">...</faultcode>
        <faultactor xsi:type="xsd:string">...</faultactor>
        <faultstring xsi:type="xsd:string">...</faultstring>
        <detail xsi:type="xsd:string">...</detail>
      </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

برای استفاده از این وب‌سرویس از مقدار operation برابر با GetPhonebookNumbers همراه با نام کاربری و رمز عبور به شکل زیر استفاده کنید.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
  <SOAP-ENV:Body>
    <ideh:GetPhonebookNumbers soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <username xsi:type="xsd:string">...</username>
      <password xsi:type="xsd:string">...</password>
      <bookId xsi:type="xsd:integer">...</bookId>
    </ideh:GetPhonebookNumbers>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <ns1:GetPhonebookNumbersResponse xmlns:ns1="idehpayam-api">
        <return xsi:type="tns:PhonebookNumberResponse">
          <status xsi:type="xsd:int">...</status>
          <result xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:PhonebookNumberItem[2]">
            <item xsi:type="tns:PhonebookNumberItem">
              <number_id xsi:type="xsd:integer">...</number_id>
              <number xsi:type="xsd:string">...</number>
            </item>
            <item xsi:type="tns:PhonebookNumberItem">
              <number_id xsi:type="xsd:integer">...</number_id>
              <number xsi:type="xsd:string">...</number>
            </item>
          </result>
        </return>
      </ns1:GetPhonebookNumbersResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

کلید status اولیه یا صفر است (به معنای معتبر بودن مقادیر result) و یا غیر صفر است که نامعتبر بودن result و خطای پیش آمده در هنگام انجام عملیات را نشان می‌دهد. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورتی که status مقدار صفر داشته باشد و result معتبر باشد، مقدار آن یک آرایه از item هاست و هر item نیز دو کلید number_id (شناسه‌ی شماره تلفن) و number (شماره تلفن) دارد.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
        <faultcode xsi:type="xsd:string">...</faultcode>
        <faultactor xsi:type="xsd:string">...</faultactor>
        <faultstring xsi:type="xsd:string">...</faultstring>
        <detail xsi:type="xsd:string">...</detail>
      </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

برای استفاده از این وب‌سرویس از مقدار operation برابر با AddNumbersToPhonebook همراه با نام کاربری و رمز عبور به شکل زیر استفاده کنید.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
  <SOAP-ENV:Body>
    <ideh:AddNumbersToPhonebook soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <username xsi:type="xsd:string">...</username>
      <password xsi:type="xsd:string">...</password>
      <bookId xsi:type="xsd:integer">...</bookId>
      <numbers xsi:type="urn:stringArray" SOAP-ENC:arrayType="xsd:string[]" xmlns:urn="urn:Soap">
        <value>...</value>
        <value>...</value>
      </numbers>
      <flag xsi:type="xsd:string">...</flag>
    </ideh:AddNumbersToPhonebook>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <ns1:AddNumbersToPhonebookResponse xmlns:ns1="idehpayam-api">
        <return xsi:type="xsd:integer">...</return>
      </ns1:AddNumbersToPhonebookResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

کلید return یا صفر است (به معنای موفقیت عملیات) و یا غیر صفر است که خطای پیش آمده در هنگام انجام عملیات را نشان می‌دهد. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
        <faultcode xsi:type="xsd:string">...</faultcode>
        <faultactor xsi:type="xsd:string">...</faultactor>
        <faultstring xsi:type="xsd:string">...</faultstring>
        <detail xsi:type="xsd:string">...</detail>
      </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

برای استفاده از این وب‌سرویس از مقدار operation برابر با RemoveNumbersFromPhonebook همراه با نام کاربری و رمز عبور به شکل زیر استفاده کنید.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
  <SOAP-ENV:Body>
    <ideh:RemoveNumbersFromPhonebook soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
      <username xsi:type="xsd:string">...</username>
      <password xsi:type="xsd:string">...</password>
      <bookId xsi:type="xsd:integer">...</bookId>
      <numbers xsi:type="urn:stringArray" SOAP-ENC:arrayType="xsd:string[]" xmlns:urn="urn:Soap">
          <value>...</value>
          <value>...</value>
      </numbers>
      <flag xsi:type="xsd:string"></flag>
    </ideh:RemoveNumbersFromPhonebook>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

مقدار برگشتی در صورت موفقیت به شکل زیر خواهد بود.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <ns1:RemoveNumbersFromPhonebookResponse xmlns:ns1="idehpayam-api">
        <return xsi:type="xsd:integer">...</return>
      </ns1:RemoveNumbersFromPhonebookResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

کلید return یا صفر است (به معنای موفقیت عملیات) و یا غیر صفر است که خطای پیش آمده در هنگام انجام عملیات را نشان می‌دهد. برای اطلاع از خطای پیش آمده مقدار بازگشتی status را با مقادیری که در بخش قبل توضیح داده شد مقایسه کنید.

در صورت عدم موفقیت، پاسخ برگشت داده شده به صورت زیر است

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope
  SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:tns="urn:Soap">
    <SOAP-ENV:Body>
      <SOAP-ENV:Fault>
        <faultcode xsi:type="xsd:string">...</faultcode>
        <faultactor xsi:type="xsd:string">...</faultactor>
        <faultstring xsi:type="xsd:string">...</faultstring>
        <detail xsi:type="xsd:string">...</detail>
      </SOAP-ENV:Fault>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
          

نمونه کدها