ملی پیامک

مستندات وب‌سرویس پیامک

ملی پیامک

مستندات وب‌سرویس پیامک

ملی پیامک

مستندات وب‌سرویس پیامک

دریافت اطلاعات دفترچه تلفن

آخرین به روز رسانی: 6 سپتامبر 2022

متد GetContacts

از این متد جهت دریافت اطلاعات دفترچه تلفن استفاده می‌شود

پارامتر های ورودی

نام پارامترنوع پارامترتوضیحات
Username String نام کاربری مربوط به حساب شما در سامانه
Password String کلمه عبور مربوط به حساب شما در سامانه
GroupId Int آی دی مربوط به گروه موردنظر
Keyword String واژه یا شماره موردنظر جهت جستجو
From Int شماره ردیف
Count Int تعداد درخواستی

مقدار بازگشتی

نام پارامترنوع پارامترتوضیحات
ReturnValue GridList[] خروجی لیستی از کلاس contacts می‌باشد که اطلاعات مربوط به واژه جستجو شده را نمایش می‌دهد
GetContacts
$username = 'username';
$password = 'password';
$api = new MelipayamakApi($username,$password);
$sms = $api->contacts();
$sms->get($groupId,$keyword,$from,$count);
const username = 'username';
const password = 'password';
const api = new MelipayamakApi(username,password);
const sms = api.contacts();
sms.get(groupId,keyword,from,count);
final String username = "username";
final String password = "password";
SoapClient soapClient = new SoapClient(username, password);
soapClient.GetContacts(groupId, keyword, count);
const string username = "username";
const string password = "password";
ContactsSoapClient soapClient = new ContactsSoapClient();
soapClient.GetContacts(username, password, groupId, keyword, count);
Const  username As String = "username"
Const  password As String = "password"
Dim soapClient As New ContactsSoapClient()
soapClient.GetContacts(username, password, groupId, keyword, count)
let username: String = "username"
let password: String = "password"
var soapClient = SoapClient(user: username, pass: password)
soapClient.GetContacts(id: groupId, keyword: keyword, cnt: count)
NSString *username = @"username";
NSString *password = @"password";
SoapClient *soapClient = [[SoapClient alloc] initCred:username password:password];
[soapClient GetContacts:groupId keyword:keyword count:cnt];
username = 'username'
password = 'password'
api = Api(username,password)
sms = api.contacts()
sms.get(group_id,keyword,from,count)
final String username = "username";
final String password = "password";
SoapClient soapClient = new SoapClient(username, password);
soapClient.GetContacts(groupId, keyword, count);
username = 'username'
password = 'password'
api = Melipayamakapi.new(username,password)
sms = api.contacts
sms.get(group_id,keyword,from,count)
my $username = "username";
my $password = "password";
my $soapClient = new SoapClient($username, $password);
$soapClient->GetContacts($groupId, $keyword, $count);
local username = "username";
local password = "password";
GetContacts(username, password, groupId, keyword, count);
username := "username";
password := "password";
GetContacts(username, password, groupId, keyword, count);
val username = "username"
val password = "password"
val soapClient = SoapClient(username, password)
soapClient.GetContacts(groupId, keyword, count)
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>