Navigace:  MobilChange™ - Dokumentace > Administrace a funkčnost MobilChange™ > Administrátorské nástroje > Popis MobilChange > Serverové části > Základní serverové části > Knihovny > MxWebServices > Webové služby MobilChange > Referenční popis > Metody > SendSMS

Funkce SendSMS posílá SMS do MobilChange. Nabízí mnoho parametrů jak ovlivnit odeslání a vlastnosti SMS.

Vstupní parametry:

Výstupní parametr:

•ServiceResult

Tato funkce může vrátit pouze následující hodnoty:

•ServiceResult.OK

•ServiceResult.Exception

•ServiceResult.PhoneNumberInvalidFormat

Další aplikační logika:

Zpráva poslaná touto funkcí má následující příznaky:

•Odesílací systém bude nastaven jako IP adresa klienta.

•Subject zprávy bude prázdný.

•Nebudou se přidávat hlavičky do textu SMS.

 

Popis vstupních parametrů a jejich hodnoty

<soap:Body>

 <SendSMS xmlns="Datasys.Ums.MobilChange.WebServices">

  <FromNumber>string</FromNumber>

  <ToNumber>string</ToNumber>

  <MessageType>TextMessage or Binary or MMS or Undefined</MessageType>

  <MessageText>string</MessageText>

<ReportLevel>NoReports or SendError or SendInformation or SendAndDeliveryInformation</ReportLevel>

  <Priority>Default or Low or Normal or High or UltraHigh</Priority>

  <ViaLine>string</ViaLine>

  <AllowReroute>boolean</AllowReroute>

  <DisplayOnly>boolean</DisplayOnly>

  <Schedule>dateTime</Schedule>

  <Expiration>int</Expiration>

  <UserAppId>string</UserAppId>

  <MaxLength>int</MaxLength>

  </SendSMS>

</soap:Body>

 

<FromNumber>

Hodnota From number říká, pod jakým číslem/identifikátorem bude SMS odeslána. Pokud necháte hodnotu prázdnou <FromNumber></FromNumber> použije se výchozí hodnota linky. Pokud zvolíte například <FromNumber>Datasys</FromNumber> říkáte lince, aby odeslala SMS jako identifikátor Datasys.

Upozornění:

Textový identifikátor musí být povolen u operátora a v licenci MobilChange.

V případě přeroutování na linku, která nemá povolen identifikátor nedojde k odeslání tímto identifikátorem. Pokud má záložní linka navíc povoleno nahrazení výchozího identifikátoru a identifikátor není u operátora povolen, dojde k chybě a neodeslání SMS.

 

<ToNumber>

Hodnota To number říká, na jaké číslo bude SMS odeslána. Hodnota může nabývat hodnot

<ToNumber>+420603280016</ToNumber>

<ToNumber>603280016</ToNumber>

<ToNumber>00420603280016</ToNumber>

 

Hodnota ToNumber je povinná

<MessageType>

Hodnota Message type říká, jaký formát bude mít SMS. Přípustné jsou volby TextMessage or Binary or MMS or Undefined. Pro Standardní SMS doporučuji výhradně <MessageType>TextMessage</MessageType>

Hodnota MessageType je povinná

Upozornění:

Pokud zvolíte hodnotu MessageType=Binary, pak v poli <MessageText> (text zprávy) musí být plně formátované PDU

 

<MessageText>

Text zprávy. U binární odchozí zprávy je zde PDU. Délka jednoho textu zprávy může být maximálně 1600 znaků pro <MessageType>TextMessage Text je možné psát s diakritikou. Pokud není povoleno a nastaveno odesílání s podporou unicode, pak bude v odesílané SMS diakritika odstraněna. Například: <MessageText>Žluťoučký kůň</MessageText> přijde na telefon jako Zlutoucky Kun
Hodnota MessageText je povinná

 

 

<ReportLevel>

Hodnota ReportLevel určuje, jaké budou návratové informace.

•NoReports = žádné reporty 

•SendError = Jen reporty o chybách

•SendInformation = informace o odeslání/neodeslání SMS

•SendAndDeliveryInformation = = informace o odeslání/neodeslání SMS a o doručení/nedoručení SMS (vyžádá si od sítě delivery report)

 

Hodnota ReportLevel je povinná

<Priority>

Hodnota Priority určuje jakou bude mít SMS prioritu v odesílání, čím vyšší priorita, tím rychleji SMS odejde.
Základní hodnota je Default. Tato hodnota nechává prioritu na nastavení systému a nastavení uživatele.

Lze také každé s SMS přiřadit vlastní prioritu, a to Low – nízká, Medium – střední High – vysoká a UltraHigh – velmi vysoká.

Upozornění:

Hodnota Priority nesmí být prázdná, vždy musí obsahovat jednu ze čtyř popsaných voleb. Například <Priority>Default</Priority>

<ViaLine> + <AllowReroute>

Hodnota ViaLine říká, jaká bude použitá linka pro odeslání SMS. Zadává se ve formátu <ViaLine>%jméno linky%</ViaLine>. Linku lze také nechat prázdnou (NULL) <ViaLine></ViaLine>, v tomto případ se použije linka dle routovacích pravidel aplikace MobilChange.

Hodnota AllowReroute říká, zda může u SMSky dojít k routování na jinou linku. Zadává se s parametry False, nebo True ve tvaru <AllowReroute>false</AllowReroute>

Upozornění:          Pokud posíláte na konkrétní linku a nechcete přeroutovat na jinou linku, pak

                                                       <ViaLine>%jméno linky%</ViaLine>

                                                       <AllowReroute>false</AllowReroute>

                         Pokud chcete odeslat SMS konkrétní linkou, ale pokud routovací pravidla, nebo chyba linky nedovolí SMS odeslat touto cestou, použij jinou cestu, pak

                                                       <ViaLine>%jméno linky%</ViaLine>

                                                       <AllowReroute>true</AllowReroute>

                         Pokud odesíláte SMS a nechcete volit linku. Necháte vše na routingu, pak

                                                       <ViaLine></ViaLine>

                                                       <AllowReroute>true</AllowReroute>

                         Použití kombinace

                                                       <ViaLine></ViaLine>

                                                       <AllowReroute>false</AllowReroute>

                         Je chybné a odeslání SMS bude ukončeno chybou „has not been routed. No rule found.“

<DisplayOnly>

Hodnota DisplayOnly říká,
<DisplayOnly>False</DisplayOnly>        SMS se uloží do telefonu jako klasická SMS
<DisplayOnly>True</DisplayOnly> SMS se zobrazí pouze na display mobilního telefonu

Upozornění:   Hodnota Priority nesmí být prázdná, vždy musí obsahovat buď False, nebo True

<Schedule>

Hodnota Shedule říká, kdy bude SMS odeslána. Pokud necháte hodnotu prázdnou, <Schedule></Schedule> odešle se SMS hned. Pokud zadáte budoucí čas <Schedule>2017-11-07T17:30:00.000+01:00</Schedule> SMS se začne odesílat ve zvolený čas. Pokud zadáte minulý čas výsledek bude shodný s prázdnou hodnotou.

Upozornění:   Plánované odesílání zadávejte pouze v tomto formátu 2016-11-07T17:30:00.000+01:00

<Expiration>

Hodnota Expiration říká, jakou bude mít SMSka životnost. Pokud zvolíte <Expiration>10</Expiration> SMS se zruší po 10ti vteřinách její existence a to v kterékoli fázi přenosu. Lze také zadat hodnotu NULL <Expiration></Expiration> a v tomto případě se použije expirace zprávy dle nastavení aplikace MobilChange.

 

<UserAppId>

ID SMS zprávy v systémech odesilatele, bude vracena v reportech. Toto pole je výhradně v péči zákazníka a slouží většinou ke spárování SMS se smlouvami, zakázkami, nebo incidenty. Toto pole může být NULL <UserAppId></UserAppId>

 

<MaxLength>

Hodnota MaxLenght říká jaký je maximální počet dílků SMS zpráv, na který se může text rozdělit. Zadává se číselnou hodnotou. Pokud zadáte <MaxLength>0</MaxLength>, pak se přebere hodnota dle nastavení aplikace MobilChange.

Upozornění:   Hodnota Priority nesmí být prázdná a vždy musí obsahovat číselnou hodnotu.