وضعیت پیام
دریافت وضعیت یک یا چند پیام
آدرس فراخوانی :
پارامترهای ورودی :
# | فیلد | نام | validations |
1 | ids[] | شناسه پیامها | آرایه ای از شناسه پیامهای کاربر |
برای مثال ۲ حالت ارسال در زیر بیان شده است:
json :
{
"ids":[12345,12346]
}
form-data :
ids[0] = 12345
ids[1] = 12346
پاسخ:
json :
{
"success": true,
"data": [
{
"id": 12345,
"message": "متن پیام ارسالی",
"status": "2",
"cost": 4,
"time": 1538896812,
"from": "+98simcard",
"receipts": [
{
"number": "+989...",
"time": 1538896812,
"status": "3"
},
{
"number": "+989...",
"time": 1538896812,
"status": "5"
}
]
},
{
"id": 12346,
"message": "متن پیام ارسالی",
"status": "2",
"cost": 4,
"time": 1538896812,
"from": "+9850004344",
"receipts": [
{
"number": "+989...",
"time": 1538896812,
"status": "3"
}
]
}
]
}
success
در صورتی که مقدار آن true باشد پاسخ درخواست شما موفقیت آمیز بوده است.
data
حاوی اطلاعات پیامهای ارسالی است
# | فیلد | نام |
1 | ids | شناسه پیامها |
۲ | message | متن پیام |
۳ | status | وضعیت پیام |
۴ | time | زمان ثبت |
۵ | from | شماره فرستنده |
۶ | receipts | لیست گیرندگان |
status
# | فیلد | نام |
1 | ۱ | منتظر تایید |
۲ | ۲ | تایید شده |
۳ | ۳ | رد شده |
۴ | ۴ | در حال ارسال |
۵ | ۵ | بروز خطا |
receipts
# | فیلد | نام |
1 | number | گیرنده |
۲ | time | آخرین زمان بروزرسانی وضعیت |
۳ | status | وضعیت پیام ها |
وضعیت پیام ها
# | فیلد | نام |
1 | ۱ | آماده ارسال وضعیت پیام ها |
۲ | ۲ | در حال ارسال |
۳ | ۳ | ارسال شده به مخابرات |
۴ | ۴ | نرسیده به مخابرات |
۵ | ۵ | رسیده به مخابرات |
۶ | ۶ | رسیده به گوشی |
۷ | ۷ | نرسیده به گوشی |
۸ | ۸ | برگشتی |
۹ | ۹ | خطای مخابراتی |
نمونه کد
curl –location –request GET ‘http://panel.signalads.com/core/rest/api/v1/message/status.json’ \
–header ‘Accept: application/json’ \
–header ‘Content-Type: application/json’ \
–header ‘Authorization: Bearer TOKEN’ \
–data ‘{
“ids”: [
15421430
]
}’
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => ‘http://panel.signalads.com/core/rest/api/v1/message/status.json’,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => ”,
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => ‘GET’,
CURLOPT_POSTFIELDS =>'{
“ids”: [
15421430
]
}’,
CURLOPT_HTTPHEADER => array(
‘Accept: application/json’,
‘Content-Type: application/json’,
‘Authorization: Bearer TOKEN’
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
import http.client
import json
conn = http.client.HTTPSConnection(“panel.signalads.com”)
payload = json.dumps({
“ids”: [
15421430
]
})
headers = {
‘Accept’: ‘application/json’,
‘Content-Type’: ‘application/json’,
‘Authorization’: ‘Bearer TOKEN’
}
conn.request(“GET”, “/core/rest/api/v1/message/status.json”, payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode(“utf-8”))
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, “http://panel.signalads.com/core/rest/api/v1/message/status.json”);
request.Headers.Add(“Accept”, “application/json”);
request.Headers.Add(“Authorization”, “Bearer TOKEN”);
var content = new StringContent(“{\n \”ids\”: [\n 15421430\n ]\n}”, null, “application/json”);
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
var request = require(‘request’);
var options = {
‘method’: ‘GET’,
‘url’: ‘http://panel.signalads.com/core/rest/api/v1/message/status.json’,
‘headers’: {
‘Accept’: ‘application/json’,
‘Content-Type’: ‘application/json’,
‘Authorization’: ‘Bearer TOKEN’
},
body: JSON.stringify({
“ids”: [
15421430
]
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse(“application/json”);
RequestBody body = RequestBody.create(mediaType, “{\n \”ids\”: [\n 15421430\n ]\n}”);
Request request = new Request.Builder()
.url(“https://panel.signalads.com/core/rest/api/v1/message/status.json”)
.method(“GET”, body)
.addHeader(“Accept”, “application/json”)
.addHeader(“Content-Type”, “application/json”)
.addHeader(“Authorization”, “Bearer TOKEN”)
.build();
Response response = client.newCall(request).execute();