PostSMS Service
Transactional (Tekil) SMS Web Service Metodları
Transactional (Tekil) SMS web servisini kullanarak, şifre hatırlatma, üyelik aktivasyonu, siparişiniz kargoda, gibi bilgilendirme amaçlı SMS mesajları gönderebilir ve analiz için bunların sonuçlarını çekebilirsiniz.
Aşağıdaki tabloda Transactional SMS Web Servisine ait metodlar ve kısa açıklamaları listelenmektedir. Detaylı bilgi için metod isimlerine tıklayabilirsiniz.
Geliştiricinin her hangi bir web servis ile etkileşime geçebilmesi için, öncelikle Login
metodunu kullanarak bir SERVICE TICKET alması gerekir. Diğer web servis ve metodlarına yaratmış olduğu bu değer ile istekte bulunabilir.
Dakikada gönderilebilecek en fazla istek sayısı 1000'dir.
Metod | Açıklama |
---|---|
GetSmsBulkResult | İki tarih aralığında gönderilen tekli SMS lerin durumunu sorgular. |
ReportSingleShotSms | GSM numarasına yapılan OTP (One Time Password) gönderimini raporlar. |
ReportSmsWithPacketId | Gönderilen tekil SMS’in durumunu sorgulamayı sağlar. |
SendBulkSms | Birden fazla GSM numarasına bilgilendirme SMS’i gönderilmesini sağlar. |
SendBulkSmsWithTypeAndKeyID | Birden fazla GSM numarasına bilgilendirme SMS’i gönderilmesini sağlar. |
SendPersonalSms | Tekli bir SMS gönderimi yapılmasını sağlar. |
SendPersonalSmsWithTypeAndKeyID | Type ve KeyID değerleriyle birlikte tekli bir SMS gönderimi yapılmasını sağlar. |
SingleShotSms | Bir GSM numarasına OTP (One Time Password) gönderimi yapılmasını sağlar. |
SingleShotSmsWithTypeAndKeyID | Type ve KeyID değerleriyle birlikte tek seferlik SMS gönderimi yapılmasını sağlar. |
SendPersonalSmsToAMember | Kayıtlı kullanıcılara kişisel SMS gönderimi sağlar. |
SingleShotSms
URL | LIVE: https://api.relateddigital.com/resta/api/PostSms/SingleShotSms ECOMM: https://api.relateddigital.com/reste/api/PostSms/SingleShotSms LIVEB: https://api.relateddigital.com/liveb_rest/api/PostSms/SingleShotSms LIVEM: https://api.relateddigital.com/restm/api/PostSms/SingleShotSms |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successfull login |
Body | Originator (string), NumberMessagePair (KeyValue []) { Key (string), Value (string) } BeginTime (DateTime) |
Sample Body | { "Originator": "EUROMSG", "NumberMessagePair": [{ "Key": "905373737373", "Value": "SHORT MESSAGE SERVICE WISHES GOOD DAYS :)" }], "BeginTime": "2016-10-19 00:00:00" } |
Sample Response | { "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
SendBulkSmsWithTypeAndKeyId
URL | LIVE: https://api.relateddigital.com/resta/api/postsms/SendBulkSmsWithTypeAndKeyId ECOMM: https://api.relateddigital.com/reste/api/postsms/SendBulkSmsWithTypeAndKeyId LIVEB: https://api.relateddigital.com/liveb_rest/api/postsms/SendBulkSmsWithTypeAndKeyId LIVEM: https://api.relateddigital.com/restm/api/postsms/SendBulkSmsWithTypeAndKeyId |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | Originator(string): Message(string): GsmNumbers (string []): KeyIds (string []): PostType(string): BeginTime(string): EndTime(string):
|
Sample Body | { "Originator": null, "Message": null, "GsmNumbers": [], "KeyIds": [], "PostType": null, "BeginTime": null, "EndTime": null } |
Sample Response | { "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", "PacketStatus": null, "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
SendPersonalSmsWithTypeAndKeyId
URL | LIVE: https://api.relateddigital.com/resta/api/PostSms/SendPersonalSmsWithTypeAndKeyId ECOMM: https://api.relateddigital.com/reste/api/PostSms/SendPersonalSmsWithTypeAndKeyId LIVEB: https://api.relateddigital.com/liveb_rest/api/PostSms/SendPersonalSmsWithTypeAndKeyId LIVEM: https://api.relateddigital.com/restm/api/PostSms/SendPersonalSmsWithTypeAndKeyId |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | Originator (string): NumberMessagePair (KeyValue []) : { Key (string): Value (string): } , KeyIds (string []): PostType(string[]): BeginTime(string): EndTime(string): |
Sample Body | { "Originator": "EUROMSG", "NumberMessagePair": [{ "Key": "905373737373", "Value": "SHORT MESSAGE SERVICE WISHES GOOD DAYS :)" }], "KeyIds": [], "PostTypes": [], "BeginTime": null, "EndTime": null } |
Sample Response | { "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", "PacketStatus": null, "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
SingleShotSmsWithTypeAndKeyId
URL | LIVE: https://api.relateddigital.com/resta/api/PostSms/SendPersonalSmsWithTypeAndKeyId ECOMM: https://api.relateddigital.com/reste/api/PostSms/SendPersonalSmsWithTypeAndKeyId LIVEB: https://api.relateddigital.com/liveb_rest/api/PostSms/SendPersonalSmsWithTypeAndKeyId LIVEM: https://api.relateddigital.com/restm/api/PostSms/SendPersonalSmsWithTypeAndKeyId |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | Originator(string): GsmNumber(string): Message(string): KeyId(string): PostType(string): BeginTime(string): |
Sample Body | { "Originator": null, "GsmNumber": null, "Message": null, "KeyId": null, "PostType": null, "BeginTime": null } |
Sample Response | { "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
SendBulkSms
URL | LIVE: https://api.relateddigital.com/resta/api/PostSms/SendBulkSms ECOMM: https://api.relateddigital.com/reste/api/PostSms/SendBulkSms LIVEB: https://api.relateddigital.com/liveb_rest/api/PostSms/SendBulkSms LIVEM: https://api.relateddigital.com/restm/api/PostSms/SendBulkSms |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | Originator(string), Message(string), GsmNumbers (string []): BeginTime(string), EndTime(string)
|
Sample Body | { "Originator": null, "Message": null, "GsmNumbers": [], "BeginTime": null, "EndTime": null } |
Sample Response | { "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
SendPersonalSms
URL | LIVE: https://api.relateddigital.com/resta/api/PostSms/SendPersonalSms ECOMM: https://api.relateddigital.com/reste/api/PostSms/SendPersonalSms LIVEB: https://api.relateddigital.com/liveb_rest/api/PostSms/SendPersonalSms LIVEM: https://api.relateddigital.com/restm/api/PostSms/SendPersonalSms |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | Originator (string), NumberMessagePair (KeyValue []) { Key (string), Value (string) } BeginTime (string), EndTime(string) *BeginTime ile EndTime arasındaki süre minimum 1 saat olmalıdır. |
Sample Body | { "Originator": "EUROMSG", "NumberMessagePair": [{ "Key": "905373737373", "Value": "SHORT MESSAGE SERVICE WISHES GOOD DAYS :)" }], "BeginTime": "2016-10-19 00:00:00", "EndTime": "2016-10-20 00:00:00" } |
Sample Response | { "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
SendPersonalSmsToAMember
URL | LIVE: https://api.relateddigital.com/resta/api/PostSms/SendPersonalSmsToAMember ECOMM: https://api.relateddigital.com/reste/api/PostSms/SendPersonalSmsToAMember LIVEB: https://api.relateddigital.com/liveb_rest/api/PostSms/SendPersonalSmsToAMember LIVEM: https://api.relateddigital.com/restm/api/PostSms/SendPersonalSmsToAMember |
---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body | Originator(string): Key(string): Value(string): Message(string): BeginTime(string): EndTime(string): |
Sample Body | { "Originator": null, "Key": null, "Value": null, "Message": null, "BeginTime": null, "EndTime": null } |
Sample Response | { "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
ReportSmsWithPacketId
URL | LIVE: https://api.relateddigital.com/resta/api/postsms/ReportSmsWithPacketIdPacketId=B8B8101D6369462 ECOMM: https://api.relateddigital.com/reste/api/postsms/ReportSmsWithPacketIdPacketId=B8B8101D6369462 LIVEB: https://api.relateddigital.com/liveb_rest/api/postsms/ReportSmsWithPacketIdPacketId=B8B8101D6369462 LIVEM: https://api.relateddigital.com/restm/api/postsms/ReportSmsWithPacketIdPacketId=B8B8101D6369462 |
---|---|
Http verb | GET |
Parameters | PacketId(string) |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
|
Sample Body | |
Sample Response | { "PacketId": null, "DeliveryResults":[ { "GsmNumber": null, "DeliveryResult": null, "DeliveryDetail": null, "DeliveryTime": null, "DeliveredMessage": null, "PostType": null, "KeyID": null, "SendDate": null } ], "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
GetSmsBulkResult
URL | |
---|---|
Http verb | GET |
Parameters | BeginDate(string),EndDate(string) |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
|
Sample Body | |
Sample Response | { "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", "BulkReport":[ { "PacketId": null, "GsmNumber": null, "DeliveryStatus": null, "SendDate": null, "DeliveryDate": null, "DeliveryDetail": null, "KeyId": null, "PostType": null } ], "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
ReportSingleShotSms
URL | LIVE: https://api.relateddigital.com/resta/api/PostSms/ReportSingleShotSms?PacketId=B8B8101D6369462 ECOMM: https://api.relateddigital.com/reste/api/PostSms/ReportSingleShotSms?PacketId=B8B8101D6369462 LIVEB: https://api.relateddigital.com/liveb_rest/api/PostSms/ReportSingleShotSms?PacketId=B8B8101D6369462 LIVEM: https://api.relateddigital.com/restm/api/PostSms/ReportSingleShotSms?PacketId=B8B8101D6369462 |
---|---|
Http verb | GET |
Parameters | PacketId(string) |
Header | Content-Type: application/json Authorization: The ticket given by the system after successful login |
Body |
|
Sample Body | |
Sample Response | { "PacketId": "B8B8101D6369462B973D35FAFB9EB00D", "PacketStatus": null, "DeliveryResults":[ { "GsmNumber": null, "DeliveryResult": null, "DeliveryDetail": null, "DeliveryTime": null, "DeliveredMessage": null, "PostType": null, "KeyID": null, "SendDate": null } ], "Success": true, "Errors": [], "DetailedMessage": "", "TransactionId": "3171959BB3054915A81643D80A81AED3" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code |
Ana Sayfa: RMC REST API
Copyright 2020 Related Digital