Հաղորդագրության փոփոխականներ
Օգտագործեք փոփոխականներ՝ անհատականացնելու կասկադային հաղորդագրությունները դինամիկ բովանդակությամբ, ինչպիսիք են անունները, URL-ները և հատուկ արժեքները:
Տեսություն
Փոփոխականները հնարավորություն են տալիս.
- Անհատականացում. Տեղադրեք ստացողների անունները, հաշվի համարները
- Դինամիկ URL. Ներառեք եզակի հղումներ յուրաքանչյուր ստացողի համար
- URL Shortening. Ավտոմատ կրճատել երկար URL-ները
- Կաղապարի կրկնակի օգտագործման հնարավորություն. Մեկ ձևանմուշ, բազմաթիվ անհատականացված հաղորդագրություններ
Փոփոխական տեսակներ
| Տեսակ | Շարահյուսություն | Նպատակը | Օրինակ |
|---|---|---|---|
| «անուն» | «%name=id%» | Տեքստային փոփոխականներ | Անուններ, ծածկագրեր, գումարներ |
| «url» | «%url=id%» | Ամբողջական URL-ներ | Հղումներ, հետևող URL-ներ |
| «short_url» | «%short_url=id%» | Կարճացված URL-ներ | Կոմպակտ հղումներ |
Փոփոխական շարահյուսություն
Փոփոխականներն օգտագործում են «%type=id%» ձևաչափը
- տեսակ. Փոփոխական տեսակ (
անուն,url, "short_url`) - id. եզակի նույնացուցիչ (ամբողջ թիվ)
Օրինակներ
Օգտագործելով փոփոխականներ
Քայլ 1. Վերբեռնեք փոփոխական արժեքներ
Հաղորդագրություններ ուղարկելուց առաջ վերբեռնեք փոփոխական արժեքներ API-ում.
Վերջնակետ:
** Հարցում: **
{
"variables": [
{
"id": 1,
"type": "name",
"value": "John"
},
{
"id": 2,
"type": "name",
"value": "12345"
},
{
"id": 3,
"type": "url",
"value": "https://example.com/products"
},
{
"id": 4,
"type": "short_url",
"value": "https://example.com/very-long-url-that-needs-shortening"
}
]
}
Քայլ 2. Ուղարկեք հաղորդագրություն փոփոխականներով
Ձեր հաղորդագրության մեջ օգտագործեք վերբեռնված փոփոխական ID-ներ.
{
"id": "msg-001",
"fromName": "YourStore",
"toPhone": "+380XXXXXXXXX",
"messageType": "transaction",
"text": "Hello %name=1%! Your verification code is %name=2%. Visit: %short_url=4%"
}
Արդյունք:
Ամբողջական օրինակ
Վերբեռնման փոփոխականներ
curl -X POST https://restapi.smsbat.com/api/items \
-H "Content-Type: application/json" \
-H "X-Authorization-Key: your-api-key" \
-d '{
"variables": [
{
"id": 1,
"type": "name",
"value": "Sarah"
},
{
"id": 2,
"type": "name",
"value": "ORD-789"
},
{
"id": 3,
"type": "url",
"value": "https://example.com/track/ORD-789"
}
]
}'
Ուղարկել հաղորդագրություն
curl -X POST https://restapi.smsbat.com/api/CascadeMessage/send_message/async \
-H "Content-Type: application/json" \
-H "X-Authorization-Key: your-api-key" \
-d '[
{
"id": "order-notification",
"fromName": "YourStore",
"toPhone": "+380XXXXXXXXX",
"messageType": "transaction",
"text": "Hi %name=1%! Order %name=2% shipped. Track: %url=3%"
}
]'
Առաքված հաղորդագրություն.
Օգտագործման դեպքեր
Պատվերի հաստատում
// Variables
{
"variables": [
{"id": 1, "type": "name", "value": "John"},
{"id": 2, "type": "name", "value": "12345"},
{"id": 3, "type": "name", "value": "$99.99"},
{"id": 4, "type": "url", "value": "https://store.com/order/12345"}
]
}
// Message
{
"text": "Hi %name=1%! Order #%name=2% for %name=3% confirmed. Details: %url=4%"
}
// Result
"Hi John! Order #12345 for $99.99 confirmed. Details: https://store.com/order/12345"
Գաղտնաբառի վերականգնում
// Variables
{
"variables": [
{"id": 1, "type": "name", "value": "Mike"},
{"id": 2, "type": "short_url", "value": "https://app.example.com/reset?token=abc123def456"}
]
}
// Message
{
"text": "Hi %name=1%, reset your password: %short_url=2% (valid 30 min)"
}
// Result
"Hi Mike, reset your password: https://sho.rt/xyz789 (valid 30 min)"
Գովազդային արշավ
// Variables
{
"variables": [
{"id": 1, "type": "name", "value": "VIP20"},
{"id": 2, "type": "short_url", "value": "https://store.com/sale?utm_source=sms&utm_campaign=summer"}
]
}
// Message
{
"text": "Summer Sale! Use code %name=1% for 20% off: %short_url=2%"
}
// Result
"Summer Sale! Use code VIP20 for 20% off: https://sho.rt/abc"
Հաշվի ստուգում
// Variables
{
"variables": [
{"id": 1, "type": "name", "value": "789456"},
{"id": 2, "type": "name", "value": "10"}
]
}
// Message
{
"text": "Your verification code: %name=1%. Valid for %name=2% minutes."
}
// Result
"Your verification code: 789456. Valid for 10 minutes."
Իրականացման օրինակներ
Python
import requests
class CascadeVariables:
def __init__(self, api_key):
self.base_url = 'https://restapi.smsbat.com'
self.headers = {
'Content-Type': 'application/json',
'X-Authorization-Key': api_key
}
def upload_variables(self, variables):
"""Upload variable values"""
response = requests.post(
f'{self.base_url}/api/items',
headers=self.headers,
json={'variables': variables}
)
response.raise_for_status()
return response.json()
def send_with_variables(self, tracking_id, from_name, to_phone,
message_type, text, variables):
"""Upload variables and send message"""
# Upload variables first
self.upload_variables(variables)
# Send message
message = {
'id': tracking_id,
'fromName': from_name,
'toPhone': to_phone,
'messageType': message_type,
'text': text
}
response = requests.post(
f'{self.base_url}/api/CascadeMessage/send_message/async',
headers=self.headers,
json=[message]
)
response.raise_for_status()
return response.json()[0]
# Usage
cascade = CascadeVariables('your-api-key')
# Define variables
variables = [
{'id': 1, 'type': 'name', 'value': 'John'},
{'id': 2, 'type': 'name', 'value': 'ORD-12345'},
{'id': 3, 'type': 'url', 'value': 'https://example.com/track/ORD-12345'}
]
# Send message with variables
result = cascade.send_with_variables(
tracking_id='order-notification',
from_name='YourStore',
to_phone='+380XXXXXXXXX',
message_type='transaction',
text='Hi %name=1%! Order %name=2% shipped. Track: %url=3%',
variables=variables
)
print(f"Message sent: {result['messageId']}")
JavaScript (Node.js)
const axios = require('axios');
class CascadeVariables {
constructor(apiKey) {
this.baseUrl = 'https://restapi.smsbat.com';
this.headers = {
'Content-Type': 'application/json',
'X-Authorization-Key': apiKey
};
}
async uploadVariables(variables) {
const response = await axios.post(
`${this.baseUrl}/api/items`,
{ variables },
{ headers: this.headers }
);
return response.data;
}
async sendWithVariables({ id, fromName, toPhone, messageType, text, variables }) {
// Upload variables first
await this.uploadVariables(variables);
// Send message
const response = await axios.post(
`${this.baseUrl}/api/CascadeMessage/send_message/async`,
[{
id,
fromName,
toPhone,
messageType,
text
}],
{ headers: this.headers }
);
return response.data[0];
}
}
// Usage
const cascade = new CascadeVariables('your-api-key');
const result = await cascade.sendWithVariables({
id: 'order-notification',
fromName: 'YourStore',
toPhone: '+380XXXXXXXXX',
messageType: 'transaction',
text: 'Hi %name=1%! Order %name=2% shipped. Track: %url=3%',
variables: [
{ id: 1, type: 'name', value: 'John' },
{ id: 2, type: 'name', value: 'ORD-12345' },
{ id: 3, type: 'url', value: 'https://example.com/track/ORD-12345' }
]
});
console.log('Message sent:', result.messageId);
PHP
<?php
class CascadeVariables {
private $baseUrl = 'https://restapi.smsbat.com';
private $apiKey;
public function __construct($apiKey) {
$this->apiKey = $apiKey;
}
public function uploadVariables($variables) {
$ch = curl_init($this->baseUrl . '/api/items');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Content-Type: application/json',
'X-Authorization-Key: ' . $this->apiKey
]);
curl_setopt($ch, CURLOPT_POSTFIELDS,
json_encode(['variables' => $variables]));
$response = curl_exec($ch);
curl_close($ch);
return json_decode($response, true);
}
public function sendWithVariables($id, $fromName, $toPhone,
$messageType, $text, $variables) {
// Upload variables
$this->uploadVariables($variables);
// Send message
$message = [
'id' => $id,
'fromName' => $fromName,
'toPhone' => $toPhone,
'messageType' => $messageType,
'text' => $text
];
$ch = curl_init(
$this->baseUrl . '/api/CascadeMessage/send_message/async'
);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Content-Type: application/json',
'X-Authorization-Key: ' . $this->apiKey
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([$message]));
$response = curl_exec($ch);
curl_close($ch);
$result = json_decode($response, true);
return $result[0];
}
}
// Usage
$cascade = new CascadeVariables('your-api-key');
$variables = [
['id' => 1, 'type' => 'name', 'value' => 'John'],
['id' => 2, 'type' => 'name', 'value' => 'ORD-12345'],
['id' => 3, 'type' => 'url', 'value' => 'https://example.com/track/ORD-12345']
];
$result = $cascade->sendWithVariables(
'order-notification',
'YourStore',
'+380XXXXXXXXX',
'transaction',
'Hi %name=1%! Order %name=2% shipped. Track: %url=3%',
$variables
);
echo "Message sent: " . $result['messageId'] . "\n";
Լավագույն պրակտիկա
Փոփոխական ID-ներ
- ✅ Օգտագործեք հաջորդական ID-ներ (1, 2, 3, ...)
- ✅ Նույն փոփոխականներով զանգվածային հաղորդագրությունների համար նորից օգտագործեք ID-ները
- ✅ Փաստաթղթի փոփոխական ID-ի քարտեզագրում
- ❌ Մի օգտագործեք պատահական ID-ներ
- ❌ Մի շրջանցեք ID համարները
Փոփոխական արժեքներ
- ✅ Վերբեռնելուց առաջ վավերացրեք արժեքները
- ✅ Հատուկ նիշերի հետ ճիշտ վարվել
- ✅ Փորձարկում եզրային պատյաններով
- ❌ Մի ներառեք HTML անվան փոփոխականների մեջ
- ❌ Մի գերազանցեք ողջամիտ երկարության սահմանները
URL փոփոխականներ
- ✅ Օգտագործեք «short_url» երկար URL-ների համար
- ✅ Ներառել հետևելու պարամետրերը
- ✅ Օգտագործեք HTTPS
- ❌ Մի օգտագործեք կասկածելի տեսք ունեցող URL-ներ
- ❌ Մի ներառեք զգայուն տվյալներ URL-ներում
Կատարում
- Վերբեռնեք փոփոխականները մեկ անգամ, ուղարկեք բազմաթիվ հաղորդագրություններ
- Փոփոխական խմբաքանակի վերբեռնումներ
- Cache սովորաբար օգտագործվող փոփոխականները
- Պարբերաբար մաքրեք հին փոփոխականները
Ընդլայնված նախշեր
Զանգվածային անհատականացում
async function sendBulkPersonalized(recipients) {
const messages = [];
const variables = [];
let varId = 1;
recipients.forEach((recipient, index) => {
// Variables for this recipient
const nameVarId = varId++;
const orderVarId = varId++;
const urlVarId = varId++;
variables.push(
{ id: nameVarId, type: 'name', value: recipient.name },
{ id: orderVarId, type: 'name', value: recipient.orderId },
{ id: urlVarId, type: 'url', value: recipient.trackingUrl }
);
messages.push({
id: `order-${recipient.orderId}`,
fromName: 'YourStore',
toPhone: recipient.phone,
messageType: 'transaction',
text: `Hi %name=${nameVarId}%! Order %name=${orderVarId}% shipped. Track: %url=${urlVarId}%`
});
});
// Upload all variables
await uploadVariables(variables);
// Send all messages
return await sendBulk(messages);
}
Կաղապարային համակարգ
class MessageTemplate {
constructor(template) {
this.template = template;
this.varIdCounter = 1;
}
create(data) {
const variables = [];
let text = this.template;
// Replace placeholders with variable syntax
Object.entries(data).forEach(([key, value]) => {
const varId = this.varIdCounter++;
variables.push({
id: varId,
type: this.getVarType(value),
value: value
});
text = text.replace(`{{${key}}}`, `%${this.getVarType(value)}=${varId}%`);
});
return { text, variables };
}
getVarType(value) {
if (value.startsWith('http')) return 'url';
return 'name';
}
}
// Usage
const template = new MessageTemplate(
'Hi {{name}}! Order {{orderId}} shipped. Track: {{trackUrl}}'
);
const { text, variables } = template.create({
name: 'John',
orderId: 'ORD-123',
trackUrl: 'https://example.com/track/ORD-123'
});
await sendWithVariables({ text, variables });
Անսարքությունների վերացում
Փոփոխականները չեն փոխարինվել
- Ստուգեք, որ փոփոխականները վերբեռնվել են ուղարկելուց առաջ
- Ստուգեք փոփոխական ID-ի համընկնումները տեքստում և վերբեռնում
- Համոզվեք, որ ճիշտ շարահյուսություն՝ «%type=id%»:
- Վավերացնել փոփոխականի տեսակը համապատասխանում է արժեքին
URL-ի կրճատումը ձախողվեց
- Ստուգեք URL-ի վավերականությունը և հասանելիությունը
- Ստուգեք, որ URL-ը սկսվում է http:// կամ https://-ով
- Համոզվեք, որ URL-ն արդեն կրճատված չէ
- Փորձեք օգտագործել «url»-ը՝ «short_url»-ի փոխարեն
Փոփոխական սահմանաչափը գերազանցվել է
- Կապվեք աջակցության հետ փոփոխական սահմանների համար
- Հնարավորության դեպքում վերօգտագործեք փոփոխական ID-ները
- Մաքրել հին փոփոխականները
- Օպտիմալացնել փոփոխականների օգտագործումը
Հաջորդ քայլերը
- Ուղարկել հաղորդագրություններ - Ուղարկել կասկադային հաղորդագրություններ
- Հաղորդագրության տեսակները - Ուսումնասիրեք հաղորդագրությունների տեսակները
- SMSBAT API - Իմացեք SMSBAT API-ի մասին