ارسال پیامک ساده به تمامی کاربران اپلیکیشن

تعریف پیامک ساده

این نوع پیامک ارسال محتوا (متن) به تمامی کاربران اپلیکیشن می‌باشد.

در این حالت با استفاده از شناسه اپلیکیشن (‍‍app_id) که در کنسول پوشه قابل دریافت می‌باشد می‌توانید به تمام کاربران اپلیکیشن‌تان پیامک ارسال کنید.

مشاهده راهنمای دریافت شناسه اپلیکیشن

مخاطبان پیامک

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

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

آدرس (url) ارسال پیامک

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

https://api.pushe.co/v2/messaging/sms/

کلید‌های ارسال پیامک ساده

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

• app_ids: شناسه اپلیکیشن که از نوع رشته string می‌باشد.
  این فیلد اجباری است
• data: یک دیکشنری که مقادیر (محتوای) پیامک را نگه می‌دارد.
  این فیلد اجباری است
  • content: این فیلد بیانگر متن پیامک می‌باشد و از نوع رشته string می‌باشد.
    این فیلد اجباری است

// minimum required keys
{
  "app_ids": ["YOUR_APP_ID"],
  "data": {
    "content":  "متن پیام"
  }
}

مرتب ‌سازی متن پیام

برای قرار دادن new line در متن پیامک کافیست از کاراکتر n\ همانند زیر استفاده کنید.

{
  "data":{
    "content":"سلام خسته نباشید \nاین پیامک یک تست می‌باشد"
  }
}

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

برای مشاهده تمامی کلید‌های قابل استفاده در ارسال پیامک به تمامی کلید های پیامک مراجعه کنید.

نمونه کد ارسال پیامک ساده

در نمونه کد های زیر حداقل کد مورد نیاز برای ارسال یک پیامک ساده در زبان های مختلف با متن نمایش داده شده. برای مشاهده تمامی کلید های قابل استفاده به بخش تمامی کلیدهای پیامک مراجعه کنید.

CURL

• در این نمونه کد از cURL استفاده شده است که می‌توانیدتوسط sudo apt install curl آن را نصب کنید.

curl -X POST https://api.pushe.co/v2/messaging/sms/ \
-H 'authorization: Token YOUR_TOKEN' \
-H 'content-type: application/json' \
-d '{
"app_ids": "YOUR_APP_ID", 
"data" :{"title":"عنوان اعلان", "content":"محتوای اعلان"}
}'

NODE.JS

• برای اجرای این کد باید ابتدا پکیج axios را نصب کنید ‍npm install axios

const axios = require('axios');

const YOUR_TOKEN = 'put your token here ...';
const YOUR_APP_ID = 'put your app id here ...';

const url = `https://api.pushe.co/v2/messaging/sms/`;

const options = {
    headers: {
        'Authorization': `Token ${YOUR_TOKEN}`,
        'Content-Type': 'application/json'
    }
};

const data = {
    app_ids: YOUR_APP_ID,
    data: {
        content: 'متن پیام'
    }
};

axios.post(url, data, options)
    .then(resp => console.log(resp))
    .catch(err => console.error(err));

PYTHON

• برای اجرا نیاز به پایتون ورژن ۳.۶ و به بالا می‌باشد
• برای اجرای این کد باید ابتدا پکیج requests را نصب کنید. pip install requests

import requests
import json

YOUR_TOKEN = 'put your token here ...'
YOUR_APP_ID = 'put your app id here ...'

url = f'https://api.pushe.co/v2/messaging/sms/'

headers = {
    'Authorization': f'Token {YOUR_TOKEN}',
    'Content-Type': 'application/json'
}

payload = json.dumps({
    'app_ids': YOUR_APP_ID,
    'data': {
        'content': 'متن پیام'
    }
})

r = requests.post(url, data=payload, headers=headers)

print(r.status_code)

PHP

$YOUR_TOKEN = 'put your token here ...';
$YOUR_APP_ID = 'put your app id here ...';

$ch = curl_init('https://api.pushe.co/v2/messaging/sms/');

curl_setopt_array($ch, array(
    CURLOPT_POST  => 1,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => array(
        "Content-Type: application/json",
        "Authorization: Token " . $YOUR_TOKEN,
    ),
));

curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode(array(
    'app_ids' => $YOUR_APP_ID,
    'data' => array(
        'content' => 'متن پیام'
    )
)));

$result = curl_exec($ch);
 
curl_close($ch);

echo $result;

GO

package main

import (
    "fmt"
    "bytes"
    "io/ioutil"
    "encoding/json"
    "net/http"
)

const YOUR_TOKEN = "put your token here ..."
const YOUR_APP_ID = "put your app id here ..."

func main() {
    url := "https://api.pushe.co/v2/messaging/sms/"

    payload := map[string]interface{}{
        "app_ids" : YOUR_APP_ID,
        "data": map[string]string{
            "content": "متن پیام",
        },
    }

    jsonValue, _ := json.Marshal(payload)

    req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonValue))

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Token " + YOUR_TOKEN)

    client := &http.Client{}
    resp, err := client.Do(req)

    if err != nil {
        panic(err)
    }

    defer resp.Body.Close()

    fmt.Println("response Status:", resp.Status)
    body, _ := ioutil.ReadAll(resp.Body)
    fmt.Println("response Body:", string(body))
}