ملی پیامک مستندات وب‌سرویس پیامک
سفارش آنلاین
ملی پیامک مستندات وب‌سرویس پیامک
ملی پیامک مستندات وب‌سرویس پیامک

ویرایش گروه دفترچه تلفن

آخرین به‌روزرسانی: 20 آبان 1405

آدرس وب سرویس

متد ChangeGroup

از این متد برای ویرایش مشخصات گروه دفترچه تلفن سامانه استفاده کنید. متد ChangeGroup اطلاعات گروه دفترچه تلفن شامل نام، توضیحات، وضعیت فعال‌بودن و نحوۀ نمایش گروه به زیرمجموعه‌ها را ویرایش و به‌روزرسانی می‌کند.

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

نام پارامترنوع پارامترتوضیحات
username String اجباری نام کاربری پنل پیامکی شما در سامانه
password String اجباری مقدار API Key شما در سامانه
groupId Int اجباری شناسۀ گروه دفترچه تلفن
groupName String اجباری نام جدید گروه دفترچه تلفن
Descriptions String اختیاری توضیحات گروه دفترچه تلفن
showToChilds Bool اجباری نمایش گروه برای زیرمجموعه‌های شما
groupStatus  Byte اجباری وضعیت گروه دفترچه تلفن

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

نام پارامترنوع پارامترتوضیحات
ReturnValue Int 1: عملیات ویرایش گروه با موفقیت انجام شد.
2: گروه موردنظر متعلق به حساب کاربری نیست یا یافت نشد.
0: اطلاعات ورود نامعتبر است.

ویرایش مشخصات گروه دفترچه تلفن از طریق URL:

https://api.payamak-panel.com/post/contacts.asmx/ChangeGroup?username=&password=&groupId=&groupName=&Descriptions=&showToChilds=&groupStatus=

ChangeGroup
PHP
PHPNodejsJavaC#PythonJavaEEgo
کد ورودیخروجی
$client = new SoapClient('https://api.payamak-panel.com/post/contacts.asmx?wsdl', ['encoding' => 'UTF-8', 'exceptions' => true]);
$params = [
    'username' => 'YOUR_USERNAME',
    'password' => 'YOUR_API_KEY',
    'groupId' => 10,
    'groupName' => 'مشتریان',
    'Descriptions' => 'توضیحات گروه',
    'showToChilds' => true,
    'groupStatus' => 1,
];
$result = $client->__soapCall('ChangeGroup', [$params]);
var_dump($result);
import soap from "soap";
const [client] = await soap.createClientAsync("https://api.payamak-panel.com/post/contacts.asmx?wsdl");
const [result] = await client.ChangeGroupAsync({
  username: "YOUR_USERNAME",
  password: "YOUR_API_KEY",
  groupId: 10,
  groupName: "مشتریان",
  Descriptions: "توضیحات گروه",
  showToChilds: true,
  groupStatus: 1,
});
console.log(result);
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var requestBody = """

               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  
    
      YOUR_USERNAME
      YOUR_API_KEY
      10
      مشتریان
      توضیحات گروه
      true
      1
    
  

""";
var request = HttpRequest.newBuilder().uri(URI.create("https://api.payamak-panel.com/post/contacts.asmx"))
    .header("Content-Type", "text/xml; charset=utf-8")
    .header("SOAPAction", "\"http://tempuri.org/ChangeGroup\"")
    .POST(HttpRequest.BodyPublishers.ofString(requestBody)).build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
// Add https://api.payamak-panel.com/post/contacts.asmx?wsdl as a Connected Service before using the generated proxy.
var client = new ContactsSoapClient(ContactsSoapClient.EndpointConfiguration.ContactsSoap);
var request = new ChangeGroupRequest
{
    username = "YOUR_USERNAME",
    password = "YOUR_API_KEY",
    groupId = 10,
    groupName = "مشتریان",
    Descriptions = "توضیحات گروه",
    showToChilds = true,
    groupStatus = 1,
};
var result = await client.ChangeGroupAsync(request);
Console.WriteLine(result);
from zeep import Client
client = Client("https://api.payamak-panel.com/post/contacts.asmx?wsdl")
result = client.service.ChangeGroup(
    username="YOUR_USERNAME",
    password="YOUR_API_KEY",
    groupId=10,
    groupName="مشتریان",
    Descriptions="توضیحات گروه",
    showToChilds=True,
    groupStatus=1,
)
print(result)
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var requestBody = """

               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  
    
      YOUR_USERNAME
      YOUR_API_KEY
      10
      مشتریان
      توضیحات گروه
      true
      1
    
  

""";
var request = HttpRequest.newBuilder().uri(URI.create("https://api.payamak-panel.com/post/contacts.asmx"))
    .header("Content-Type", "text/xml; charset=utf-8")
    .header("SOAPAction", "\"http://tempuri.org/ChangeGroup\"")
    .POST(HttpRequest.BodyPublishers.ofString(requestBody)).build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
package main
import ("fmt"; "io"; "net/http"; "strings")
func main() {
  requestBody := `
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  
    
      YOUR_USERNAME
      YOUR_API_KEY
      10
      مشتریان
      توضیحات گروه
      true
      1
    
  
`
  request, err := http.NewRequest(http.MethodPost, "https://api.payamak-panel.com/post/contacts.asmx", strings.NewReader(requestBody)); if err != nil { panic(err) }
  request.Header.Set("Content-Type", "text/xml; charset=utf-8")
  request.Header.Set("SOAPAction", "\"http://tempuri.org/ChangeGroup\"")
  response, err := http.DefaultClient.Do(request); if err != nil { panic(err) }; defer response.Body.Close()
  body, err := io.ReadAll(response.Body); if err != nil { panic(err) }; fmt.Println(string(body))
}
//SOAP پاسخ موفق
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ChangeGroupResponse xmlns="http://tempuri.org/">
      <ChangeGroupResult>1</ChangeGroupResult>
    </ChangeGroupResponse>
  </soap:Body>
</soap:Envelope>

//SOAP خطا
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <ChangeGroupResponse xmlns="http://tempuri.org/">
      <ChangeGroupResult>0</ChangeGroupResult>
    </ChangeGroupResponse>
  </soap:Body>
</soap:Envelope>