Submit metodu birden fazla numaraya aynı içerikli kısa mesaj gönderimi için kullanılmaktadır.
<Submit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmsApi"> <Credential> <Password>String</Password> <Username>String</Username> </Credential> <DataCoding>Default</DataCoding> <Header> <From>String</From> <ScheduledDeliveryTime>DateTime</ScheduledDeliveryTime> <ValidityPeriod>0</ValidityPeriod> </Header> <Message>String</Message> <To xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>String</d2p1:string> </To> </Submit>
{ "Credential": { "Username": "String", "Password": "String" }, "DataCoding": "Default", "Header": { "From": "String", "ValidityPeriod": 0 }, "Message": "String", "To": ["String"] }
Credential |
API'ye ulaşabilmeniz için gerekli kullanıcı doğrulamasının yapıldığı alandır.
|
||||||
DataCoding |
Mesajın kodlanma biçimidir. 2 değer alabilir. Bunlar; - Default (http://en.wikipedia.org/wiki/GSM_03.38) - UCS2 (http://en.wikipedia.org/wiki/GSM_03.38#UCS-2_Encoding) |
||||||
Header |
Kısa mesaj başlık bilgilerinin barındırıldığı yapıdır.
|
||||||
Message |
Kısa mesaj içeriği.
Önemli Default (DataCoding = Default) kodlama biçiminde 1 kısa mesaj 160 karakter olabilir. Eğer uzun mesaj gönderilecek ise her parça 153 karakter olacak şekilde gönderim yapılır. Maksimum 612 karakter (4 x 153) uzunluğunda mesaj gönderilebilir. UCS2 (DataCoding = UCS2) kodlama biçiminde ise 1 kısa mesaj 70 karakter olabilir. Eğer uzun mesaj gönderilecek ise her parça 67 karakter olacak şekilde gönderim yapılır. Maksimum 268 karakter (4 x 67) uzunluğunda mesaj gönderilebilir. - Default (http://en.wikipedia.org/wiki/GSM_03.38) - UCS2 (http://en.wikipedia.org/wiki/GSM_03.38#UCS-2_Encoding) |
||||||
To |
Kısa mesajı göndermek istediğiniz numaraları belirttiğiniz alandır.
Cep telefonu numarasını bu alana yazmanız gerekemektedir.Birden fazla numaraya gönderim yapılmak isteniyorsa virgüllerle ayrılmalıdır.
"To": ["905320000001","905420000002","905550000003"] |
<SubmitResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmsApi"> <Response> <MessageId>0</MessageId> <Status> <Code>0</Code> <Description>String</Description> </Status> </Response> </SubmitResponse>
{ "Response": { "MessageId": 0, "Status": { "Code": 0, "Description": "String" } } }
MessageId |
Sisteme gönderdiğiniz mesajın mesaj numarasıdır. Rapor sorgulamanız için bu numara gerekmektedir. |
||||
Status |
İşlemin başarılı olup olmadığı bilgisidir.
|
SubmitMulti metodu birden fazla numaraya farklı içerikli kısa mesaj gönderimi için kullanılmaktadır.
<SubmitMulti xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmsApi"> <Credential> <Password>String</Password> <Username>String</Username> </Credential> <DataCoding>Default</DataCoding> <Envelopes> <Envelope> <Message>String</Message> <To>String</To> </Envelope> </Envelopes> <Header> <From>String</From> <ScheduledDeliveryTime>DateTime</ScheduledDeliveryTime> <ValidityPeriod>0</ValidityPeriod> </Header> </SubmitMulti>
{ "Credential": { "Username": "String", "Password": "String" }, "Envelopes":[{ "Message":"String", "To":"String" }], "Header": { "From": "String", "ValidityPeriod": 0 }, "DataCoding": "Default" }
Credential |
API'ye ulaşabilmeniz için gerekli kullanıcı doğrulamasının yapıldığı alandır.
|
||||||||||
DataCoding |
Mesajın kodlanma biçimidir. 2 değer alabilir. Bunlar; - Default (http://en.wikipedia.org/wiki/GSM_03.38) - UCS2 (http://en.wikipedia.org/wiki/GSM_03.38#UCS-2_Encoding) |
||||||||||
Header |
Kısa mesaj başlık bilgilerinin barındırıldığı yapıdır.
|
||||||||||
Envelopes |
Kısa mesajı göndermek istediğiniz numaraları ve her bir numaraya gidecek mesajı belirttiğiniz alandır.
Birden fazla numaraya gönderim yapılmak isteniyorsa virgüllerle ayrılmalıdır.
"Envelopes":[ { "Message":"Numara 1 icin mesaj", "To":"905320000001" }, { "Message":"Numara 2 icin mesaj", "To":"905320000002" } ],
|
<SubmitResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmsApi"> <Response> <MessageId>0</MessageId> <Status> <Code>0</Code> <Description>String</Description> </Status> </Response> </SubmitResponse>
{ "Response": { "MessageId": 0, "Status": { "Code": 0, "Description": "String" } } }
MessageId |
Sisteme gönderdiğiniz mesajın mesaj numarasıdır. Rapor sorgulamanız için bu numara gerekmektedir. |
||||
Status |
İşlemin başarılı olup olmadığı bilgisidir.
|
Query gönderilerinizin raporlarını almanızı sağlayan servistir.
<Query xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmsApi"> <Credential> <Password>String</Password> <Username>String</Username> </Credential> <MSISDN>String</MSISDN> <MessageId>0</MessageId> </Query>
{ "Credential": { "Username": "String", "Password": "String" }, "MessageId": 0, "MSISDN": "String" }
Credential |
API'ye ulaşabilmeniz için gerekli kullanıcı doğrulamasının yapıldığı alandır.
|
||||
MessageId | Mesaj gönderdiğinizde dönen paket numarasıdır. | ||||
MSISDN | Toplu gönderimlerde paket içerisinde birçok telefon numarası olabilir. Tüm paket içerisindeki veriler alınmak isteniyorsa MSISDN boş gönderilmelidir. Paket içerisinde herhangi bir telefon numarası aranmak isteniyorsa MessageId ile beraber MSISDN gönderilmesi gerekir. |
<QueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmsApi"> <Response> <ReportDetail> <List> <ReportDetailItem> <Payload>String</Payload> <Xser>String</Xser> <Cost>0</Cost> <ErrorCode>0</ErrorCode> <Id>0</Id> <LastUpdated>0001-01-01T00:00:00</LastUpdated> <MSISDN>String</MSISDN> <Network>0</Network> <Sequence>0</Sequence> <State>Scheduled</State> <Submitted>0001-01-01T00:00:00</Submitted> </ReportDetailItem> </List> </ReportDetail> <Status> <Code>0</Code> <Description>String</Description> </Status> </Response> </QueryResponse>
{ "Response": { "ReportDetail": { "List": [{ "Id": 0, "Network": 0, "MSISDN": "String", "Cost": 0, "Submitted": "0001-01-01T00:00:00.0000000", "LastUpdated": "0001-01-01T00:00:00.0000000", "State": "Scheduled", "Sequence": 0, "ErrorCode": 0, "Payload": "String", "Xser": "String" }] }, "Status": { "Code": 0, "Description": "String" } } }
Payload | Mesaj içeriği. | ||||
Xser | UCP XSER değeri veya UDH SMPP değeri. | ||||
Cost | Mesaj ücreti. | ||||
ErrorCode | Hata kodu. Mesaj gönderiminde problem olursa bu alanda hata kodu döner. | ||||
Id | Bir pakette birden fazla veya tek mesaj bulunabilir. Mesajın paket içerisindeki Id numarasıdır. | ||||
LastUpdated | Durum güncellemesinin yapıldığı son tarih. (UTC Time Zone) | ||||
MSISDN | Gönderilen telefon numarası. | ||||
Network | Mesajın gönderildiği operatör Id'si. | ||||
Sequence | Uzun/Birleşik mesajlarda burada her mesajın içeriği listelenir. | ||||
State | Mesaj durumu. Mesaj Durumları | ||||
Submitted | Mesajın sisteme teslim edilme zamanıdır. (UTC Time Zone) | ||||
Status |
İşlemin başarılı olup olmadığı bilgisidir.
|
QueryMulti paket raporlarınızı tarih aralığına göre almanızı sağlar.
<QueryMulti xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmsApi"> <Credential> <Password>String</Password> <Username>String</Username> </Credential> <Range> <Begin>0001-01-01T00:00:00</Begin> <End>0001-01-01T00:00:00</End> </Range> </QueryMulti>
{ "Credential": { "Username": "String", "Password": "String" }, "Range": { "Begin": "0001-01-01T00:00:00.0000000", "End": "0001-01-01T00:00:00.0000000" } }
Credential |
API'ye ulaşabilmeniz için gerekli kullanıcı doğrulamasının yapıldığı alandır.
|
||||
Range |
Tarih aralığını belirtir.
|
<QueryMultiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmsApi"> <Response> <Report> <List> <ReportItem> <Coding>Default</Coding> <Cost>0</Cost> <Count>0</Count> <DeliveredCount>0</DeliveredCount> <Id>0</Id> <Message>String</Message> <Received>0001-01-01T00:00:00</Received> <Sender>String</Sender> <Sent>0001-01-01T00:00:00</Sent> <State>Queued</State> <UndeliveredCount>0</UndeliveredCount> </ReportItem> </List> </Report> <Status> <Code>0</Code> <Description>String</Description> </Status> </Response> </QueryMultiResponse>
{ "Response": { "Report": { "List": [{ "Id": 0, "Received": "0001-01-01T00:00:00.0000000", "Sent": "0001-01-01T00:00:00.0000000", "State": "Queued", "Sender": "String", "Cost": 0, "Message": "String", "Coding": "Default", "DeliveredCount": 0, "Count": 0, "UndeliveredCount": 0 }] }, "Status": { "Code": 0, "Description": "String" } } }
Coding |
Mesajın kodlanma biçimidir. 2 değer alabilir. Bunlar; - Default (http://en.wikipedia.org/wiki/GSM_03.38) - UCS2 (http://en.wikipedia.org/wiki/GSM_03.38#UCS-2_Encoding) |
||||
Cost | Mesaj ücreti. | ||||
Count | Toplam mesaj sayısı. | ||||
DeliveredCount | Teslim edilen mesaj sayısı. | ||||
UndeliveredCount | Teslim edilemeyen mesaj sayısı. | ||||
Id | Mesaj paket numarasıdır. | ||||
Message | Mesaj içeriği. | ||||
Received | Sistemin mesajı aldığı tarih. (UTC Time Zone) | ||||
Sender | Mesajı gönderen alfanumerik isim. | ||||
Sent | Mesajı gönderilme tarihi. (UTC Time Zone) | ||||
State | Mesaj paketinin durumu. Mesaj Paket Durumları | ||||
Status |
İşlemin başarılı olup olmadığı bilgisidir.
|
QueryStats yıllık ve aylık gönderim raporu almanızı sağlar.
<QueryStats xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmsApi"> <Credential> <Password>String</Password> <Username>String</Username> </Credential> </QueryStats>
{ "Credential": { "Username": "String", "Password": "String" } }
Credential |
API'ye ulaşabilmeniz için gerekli kullanıcı doğrulamasının yapıldığı alandır.
|
<QueryStatsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmsApi"> <Response> <Report> <List> <ReportStatsItem> <Count>0</Count> <Delivered>0</Delivered> <Month>0</Month> <Undelivered>0</Undelivered> <Year>0</Year> </ReportStatsItem> </List> </Report> <Status> <Code>0</Code> <Description>String</Description> </Status> </Response> </QueryStatsResponse>
{ "Response": { "Report": { "List": [{ "Year": 0, "Month": 0, "Delivered": 0, "Undelivered": 0, "Count": 0 }] }, "Status": { "Code": 0, "Description": "String" } } }
Count | Toplam gönderilen mesaj sayısı. | ||||
Delivered | Teslim edilen mesaj sayısı. | ||||
UndeliveredCount | Teslim edilemeyen mesaj sayısı. | ||||
Month | Rapor ay bilgisi. | ||||
Year | Rapor yıl bilgisi. | ||||
Status |
İşlemin başarılı olup olmadığı bilgisidir.
|
GetBalance kredi adetinizi öğrenmenizi sağlar.
<GetBalance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmsApi"> <Credential> <Password>String</Password> <Username>String</Username> </Credential> </GetBalance>
{ "Credential": { "Username": "String", "Password": "String" } }
Credential |
API'ye ulaşabilmeniz için gerekli kullanıcı doğrulamasının yapıldığı alandır.
|
<GetBalanceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmsApi"> <Response> <Balance> <Limit>0</Limit> <Main>0</Main> </Balance> <Status> <Code>0</Code> <Description>String</Description> </Status> </Response> </GetBalanceResponse>
{ "Response": { "Balance": { "Limit": 0, "Main": 0 }, "Status": { "Code": 0, "Description": "String" } } }
Balance |
Kredi durumunuz bu alanda döner. Gönderebileceğiniz toplam mesaj sayısı Limit ve Main alanlarının toplamı kadardır.
|
||||
Status |
İşlemin başarılı olup olmadığı bilgisidir.
|
GetSettings hesabınız ile ilgili bilgileri almanızı sağlar.
<GetSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmsApi"> <Credential> <Password>String</Password> <Username>String</Username> </Credential> </GetSettings>
{ "Credential": { "Username": "String", "Password": "String" } }
Credential |
API'ye ulaşabilmeniz için gerekli kullanıcı doğrulamasının yapıldığı alandır.
|
<GetSettingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="SmsApi"> <Response> <Settings> <Balance> <Limit>0</Limit> <Main>0</Main> </Balance> <Keywords> <Keyword> <ServiceNumber>String</ServiceNumber> <Timestamp>0001-01-01T00:00:00</Timestamp> <Validity>0</Validity> <Value>String</Value> </Keyword> </Keywords> <OperatorSettings> <Account>Postpaid</Account> <MSISDN>String</MSISDN> <ServiceId>String</ServiceId> <UnitPrice>0</UnitPrice> <VariantId>String</VariantId> </OperatorSettings> <Senders> <Sender> <Default>false</Default> <Value>String</Value> </Sender> </Senders> </Settings> <Status> <Code>0</Code> <Description>String</Description> </Status> </Response> </GetSettingsResponse>
{ "Response": { "Settings": { "Balance": { "Limit": 0, "Main": 0 }, "Senders": [{ "Value": "String", "Default": false }], "Keywords": [{ "ServiceNumber": "String", "Value": "String", "Timestamp": "0001-01-01T00:00:00.0000000", "Validity": 0 }], "OperatorSettings": { "Account": "Postpaid", "MSISDN": "String", "VariantId": "String", "ServiceId": "String", "UnitPrice": 0 } }, "Status": { "Code": 0, "Description": "String" } } }
Balance |
Kredi durumunuz bu alanda döner. Gönderebileceğiniz toplam mesaj sayısı Limit ve Main alanlarının toplamı kadardır.
|
||||||||||
Keyword |
Çift yönlü mesaj sisteminde kullanan kullanıcılarda döner. Anahtar kelimeler ile ilgili bilgiler yer alır.
|
||||||||||
OperatorSettings |
Hesabınız ile ilgili operatör bilgileri yer alır.
|
||||||||||
Sender |
Hesabınıza tanımlanmış gönderen başlıkları bu alanda gelir.
|
||||||||||
Status |
İşlemin başarılı olup olmadığı bilgisidir.
|