לינק מאָביליטי ימפּלעמענטאַטיאָן גייד REST API SMS באַניצער גייד

לינק מאָביליטי ימפּלעמענטאַטיאָן גייד REST API SMS

LINK מאָביליטי גיט אַ דינסט פֿאַר אָנזאָג עקספּרעס, מיקראָ פּיימאַנץ און אָרט-באזירט באַדינונגס. די פּלאַטפאָרמע אקטן ווי אַ טראַנספּעראַנט, ווייַס-פירמע אינהאַלט קונה און טראַנסאַקטיאָן ראַוטער צווישן סערוויס פּראַוויידערז און אָפּערייטערז.

LINK מאָביליטי גיט אַ RESTful API וואָס קענען זיין געוויינט צו אַקסעס LINK מאָביליטי באַדינונגס אַזאַ ווי שיקן SMS. דער אַפּי איז דיזיינד צו זיין גרינג צו נוצן און קאַמפּאַטאַבאַל מיט אַלע מאָדערן שפּראַכן און פראַמעוואָרקס. ניצן די שפּראַך פון דיין ברירה דיין אַפּלאַקיישאַן קענען נוצן די Link Mobility REST API צו ינסטרומענט שטאַרק מעסידזשינג און צאָלונג קייפּאַבילאַטיז

© LINK מאָביליטי, 10 מערץ 2021

לעגאַל אינפֿאָרמאַציע

די אינפֿאָרמאַציע סאַפּלייד אין דעם דאָקומענט איז די איינציקע פאַרמאָג און קאַפּירייט פון Netsize. עס איז קאַנפאַדענשאַל און בדעה פֿאַר שטרענג ינפאָרמאַטיוו נוצן. עס איז נישט ביינדינג און קען זיין אונטערטעניק צו ענדערונגען אָן באַמערקן. קיין אַנאָטערייזד אַנטפּלעקונג אָדער נוצן וועט זיין גערעכנט ווי אַנלאָפאַל.

Netsize ™ און linkmobility ™ זענען פּראָטעקטעד דורך פראנצויזיש, עעק און אינטערנאַציאָנאַלע אינטעלעקטואַל פאַרמאָג געזעצן.

אַלע אנדערע ציטירטע טריידמאַרקס זענען די איינציקע פאַרמאָג פון זייער ריספּעקטיוו אָונערז.

גאָרנישט קאַנטיינד דאָ וועט זיין קאַנסטרוד ווי קאַנפערינג קיין דערלויבעניש אָדער רעכט אונטער Netsize פּאַטענט, קאַפּירייט אָדער טריידמאַרק.

NETSIZE
סאָסיעט é אַנאָנימע אָו קאַפּיטאַל דע 5 478 070 עוראָס
Siège social :62, אַוועניו Emile Zola 92100 Boulogne - פֿראַנקרייַך
418 712 477 RCS Nanterre
http://www.LinkMobility.com
http://www.linkmobility.com

פאַרנעם פון דאָקומענט

דער דאָקומענט באשרייבט ווי די סערוויס פּראַוויידער ניצט די LINK Mobility REST API פֿאַר SMS. עס איז בדעה פֿאַר טעכניש אַרקאַטעקץ און דיזיינערז וואָס ינסטרומענט די סערוויסעס פון די סערוויס פּראַוויידער.

1. יקערדיק באַניץ

עס איז זייער גרינג צו שיקן אַ SMS. איר שיקן אַ הטטפּ בעטן צו LINK מאָביליטי וואָס קענען זיין אַטשיווד מיט בלויז אַ web בלעטערער.

2. פאַנגקשאַנאַל איבערview

די LINK מאָביליטי סיסטעם גיט די פאלגענדע יקערדיק פאַנגקשאַנאַליטי פֿאַר SMS אַרטיקלען:
שיקט מאָביל טערמינאַטעד (מט) SMS אַרטיקלען, אַזאַ ווי טעקסט אָדער ביינערי (למשל וואַפּ פּוש) פּרעמיע און נאָרמאַל קורס אַרטיקלען.

באַקומען עקספּרעס ריפּאָרץ פֿאַר דערלאנגט MT אַרטיקלען.

באַקומען רירעוודיק אָריגינאַטעד (מאָ) SMS אַרטיקלען, פּרעמיע און נאָרמאַל קורס.
די SMS REST API איז דעדאַקייטאַד צו שיקן נאָרמאַל MT SMS אַרטיקלען.

די אַפּי סענדז אַלע SMS אַרטיקלען ייסינגקראַנאַסלי, וואָס אַלאַוז פֿעיִקייטן אַזאַ ווי:

"פייער-און-פאַרגעסן" - דער סערוויס פּראַוויידער וויל צו האָבן מער פּרידיקטאַבאַל ענטפער צייט און וויל נישט וואַרטן פֿאַר די רעזולטאַט פון די אָפּעראַטאָר.

פרובירט פאַנגקשאַנאַליטי - LINK מאָביליטי וועט שיקן דעם אָנזאָג ווידער אויב דער אָפּעראַטאָר האט צייטווייליגע פראבלעמען.

2.1 שיקן אַ SMS אָנזאָג

                                       
סערוויס פּראַוויידער Netsize Consumer

1. שיקן MT אָנזאָג
2. צוריקקומען אָנזאָג שייַן
3. פאָרלייגן SMS אָנזאָג
4. צושטעלן עקספּרעס באַריכט
5. שיקן עקספּרעס באַריכט

די יקערדיק לויפן פֿאַר שיקט SMS אַרטיקלען איז דיסקרייבד ווי גייט:

די סערוויס פּראַוויידער מאכט אַ בקשה צו שיקן אַ SMS אָנזאָג צו אַ באַקומער דורך די LINK מאָביליטי סיסטעם.

א אָנזאָג שייַן איז אומגעקערט צו די סערוויס פּראַוויידער. דעם שייַן קענען זיין געניצט פֿאַר למשל קאָראַלייטינג די אָנזאָג מיט די ריכטיק עקספּרעס באַריכט.

LINK מאָביליטי כאַנדאַלז רוטינג און דיליווערז די SMS אָנזאָג צו די אַדרעסד קאָנסומער.
א עקספּרעס באַריכט איז טריגערד, למשל ווען די SMS אָנזאָג איז איבערגעגעבן צו די קאַנסומער ס מיטל.

דער עקספּרעס באַריכט איז געשיקט צו די סערוויס פּראַוויידער. דער באַריכט כּולל די זעלבע אָנזאָג שייַן ווי אומגעקערט אין שריט 2.

אַלטערנאַטיווע לויפן: פאַרקריפּלט בעטן

אויב די סאַפּלייד פּאַראַמעטערס אָדער באַניצער קראַדענטשאַלז אין די בעטן זענען פאַרקריפּלט, אַ טעות איז אומגעקערט צו די סערוויס פּראַוויידער. דער טעות ינדיקייץ די סיבה פֿאַר די רידזשעקשאַן און די לויפן ענדס. קיין אָנזאָג IDs זענען אומגעקערט.

3. ענדפּוינט

די SMS מיטל איז אַקסעסט מיט דעם דרך:
/restapi/v1/sms
Example URL
https://europe.ipx.com/restapi/v1/sms
פֿאַר קשר זיכערהייט, די LINK Mobility REST API איז בלויז צוטריטלעך איבער הטטפּס.
די לינק מאָביליטי סערווער באַווייַזן איז געחתמעט דורך Thawte Server CA.

4. אָפּעראַטיאָנס

די SMS סערוויס גיט די פאלגענדע אַפּעריישאַנז:

נאָמען	דרך
שיקן	/restapi/v1/sms/send

4.1 שיקן

די שיקן אָפּעראַציע איז געניצט צו שיקן אַ SMS צו אַ איין באַקומער.

די אָפּעראַציע איז בדעה פֿאַר ביידע יקערדיק און אַוואַנסירטע ניצערס. אין די סימפּלאַסט פאַל, בלויז דעסטיניישאַן אַדרעס און די אָנזאָג טעקסט זענען פארלאנגט צו צושטעלן אַ SMS. LINK מאָביליטי וועט דעטעקט די דאַטאַ קאָודינג סקים און דורכפירן אָטאַמאַטיק קאַנקאַטאַניישאַן פון אַ אָנזאָג אין קייפל אָנזאָג פּאַרץ אויב נייטיק.

פֿאַר אַוואַנסירטע באַניץ, די סערוויס פּראַוויידער קענען נוצן אַפּשאַנאַל פּאַראַמעטערס פֿאַר גאַנץ קאָנטראָל פון די אָנזאָג פאָרמאַטטינג אַרייַנגערעכנט די באַניצער דאַטן כעדער.

די סערוויס פּראַוויידער קענען שיקן קאַנקאַטאַנייטאַד אַרטיקלען, אָבער דער צוגרייטונג פון די באַניצער דאַטן און באַניצער דאַטן כעדער מוזן זיין געמאכט דורך די סערוויס פּראַוויידער און דער אָנזאָג מוזן זיין געשיקט דורך קייפל שיקן ריקוועס צו LINK מאָביליטי.

5. אָטענטאַקיישאַן

נאמען און שפּריכוואָרט זענען דערלאנגט אין יעדער בקשה ניצן HTTP Basic Authentication Scheme.

https://www.w3.org/Protocols/HTTP/1.0/spec.html#BasicAA

קראַדענטשאַלז זענען געשיקט אין אַ דערלויבעניש כעדער אין די הטטפּ בעטן. דער קליענט קאַנסטראַקט די כעדער פעלד ווי דיסקרייבד דאָ:

https://en.wikipedia.org/wiki/Basic_access_authentication#Client_side

פֿאַר עקסampאויב דער נאמען איז John און Changeme איז די פּאַראָל, די ריזאַלטינג אַוטהאָריזאַטיאָן כעדער איז:

דערלויבעניש: יקערדיק am9objpjaGFuZ2VtZSA=

ווי אַ פאַל-צוריק די נאמען און פּאַראָל קענען זיין דערלאנגט ווי בעטן פּאַראַמעטערס. דאָס איז בלויז רעקאַמענדיד פֿאַר קלייאַנץ וואָס טאָן ניט שטיצן באַסיק אַוטה.

6. פאָרלייגן אַ בקשה

6.1 אָנפֿרעג שטריקל

בעטן פּאַראַמעטערס זענען דערלאנגט ווי אַ אָנפֿרעג שטריקל מיט נאָמען / ווערט פּערז. די אָנפֿרעג שטריקל איז ענקאָודיד ניצן פּראָצענט קאָדירונג (URL קאָדירונג).

http://www.w3schools.com/tags/ref_urlencode.asp

פֿאַר עקסampהעלא וועלט! איז קאָדעד ווי העלא + וועלט% 21.

6.2 מאַנדאַטאָרי בעטן פּאַראַמעטערס

נאָמען	מאַקסימום לענג	באַשרייַבונג
דעסטיניישאַן אַדרעס	40	די MSISDN צו וואָס די SMS אָנזאָג זאָל זיין געשיקט, סטאַרטינג מיט לאַנד קאָד. עקסampפֿאַר: 46123456789. פֿאַר עטלעכע מארקפלעצער (ווו די קאָנסומער MSISDN מוזן זיין אַבפוסקייטיד) דעם ווערט קענען אויך זיין אַן אַלפאַנומעריק אַליאַס, פּרעפיקסעד מיט "#".
אָנזאָג טעקסט	1600	די אינהאַלט פון די SMS אָנזאָג.

6.3 אָפּטיאָנאַל בעטן פּאַראַמעטערס (פֿאַר אַוואַנסירטע באַניץ)

נאָמען	מאַקסימום לענג	באַשרייַבונג
אָריגינעל אַדרעס	16	דער אָריגינעל אַדרעס פֿאַר די אַוטגאָוינג SMS אָנזאָג. טיפּ פון ערידזשאַנייטינג אַדרעס איז דיפיינד דורך די אָריגינאַטאָרטאָן פּאַראַמעטער. קורץ נומער מאַקס לענג איז 16. אַלף נומעריק סענדער איז לימיטעד צו GSM פעליקייַט אַלפאַבעט מיט מאַקסימום לענג 11 אותיות. MSISDN סענדער מאַקס לענג איז 15 (ניצן די זעלבע פֿאָרמאַט ווי די דעסטיניישאַן אַדרעס עלעמענט). קענען זיין איבערגעהיפּערט ווען ערידזשאַנייטינג אַדרעס און ערידזשאַנייטינג TON זענען אויסגעקליבן דורך די סיסטעם. דעם פֿונקציע איז אָפענגיק אויף מאַרק און קאַנפיגיעריישאַן. אָפּפירונג קען בייַטן מיט אָפּעראַטאָר ינטאַגריישאַנז.
originatorTON	1	די טיפּ פון נומער פון דער אָריגינעל אַדרעס (TON): 0 - קורץ נומער 1 - אַלף נומעריק (מאַקסימום לענג 11) 2 - MSISDN קענען זיין איבערגעהיפּערט ווען ערידזשאַנייטינג אַדרעס און ערידזשאַנייטינג TON וועט זיין אויסגעקליבן דורך די סיסטעם. דעם פֿונקציע איז אָפענגיק אויף מאַרק און קאַנפיגיעריישאַן. אָפּפירונג קען בייַטן מיט אָפּעראַטאָר ינטאַגריישאַנז.
userDataHeader	280	באַניצער דאַטאַ כעדער צוזאַמען מיט די באַניצער דאַטאַ קענען אַנטהאַלטן אַרויף צו 140, הייסט 280, ווען העקס קאָדעד, אָקטעץ. דער פּאַראַמעטער איז שטענדיק העקס-ענקאָודעד.
דקס	3	דאַטאַ קאָדירונג סכעמע. אָפּפירונג קען בייַטן מיט אָפּעראַטאָר ינטאַגריישאַנז.
PID	3	פּראָטאָקאָל שייַן. אָפּפירונג קען בייַטן מיט אָפּעראַטאָר ינטאַגריישאַנז.
relative ValidityTime	6	רעלאַטיוו גילטיקייַט צייט אין סעקונדעס (רעלאַטיוו צו די צייט פֿאַר סאַבמישאַן צו LINK מאָביליטי). די מאַקסימום ווערט איז 604800 (7 טעג) און די פעליקייַט איז 48 שעה. אָפּפירונג קען בייַטן מיט אָפּעראַטאָר ינטאַגריישאַנז.
עקספּרעס צייט	20	צייטamp ווען SMS אָנזאָג זאָל זיין איבערגעגעבן (דילייד עקספּרעס צייט). זען אָפּטיילונג אויף דאַטע צייט פֿאָרמאַט.
statusReportFlags	1	צושטעלן באַריכט בעטן: 0 - קיין עקספּרעס באַריכט (פעליקייַט) 1 - עקספּרעס באַריכט געבעטן 9 - סערווירער עקספּרעס באַריכט געבעטן (לינק מאָביליטי טאָן ניט פֿאָרווערטס דעם באַריכט צו די סערוויס פּראַוויידער אָבער מאכט עס בנימצא אין ריפּאָרץ עטק.)
campaignName	50	די LINK מאָביליטי טראַנזאַקשאַנז זענען tagמיט דעם נאָמען. עס איז געניצט צו גרופּע טראַנזאַקשאַנז אין לינק מאָביליטי ריפּאָרץ.
maxConcatenatedMessages	1	א ווערט צווישן 1 און 10 וואָס דיפיינז ווי פילע קאַנקאַטאַנייטאַד אַרטיקלען וואָס זענען ערלויבט. פעליקייַט איז 3.
correlationId	100	שייַן צוגעשטעלט דורך סערוויס פּראַוויידער וואָס וועט זיין עקאָוד אין עקספּרעס באריכט.
נאמען	100	צוגעשטעלט ווי אַן אָלטערנאַטיוו צו הטטפּ באַסיק אָטענטאַקיישאַן.
פּאַראָל	100	צוגעשטעלט ווי אַן אָלטערנאַטיוו צו הטטפּ באַסיק אָטענטאַקיישאַן.

6.4 הטטפּ בעטן מעטהאָדס

פֿאַר מאַקסימום ינטעראָפּעראַביליטי, די API שטיצט ביידע HTTP GET און POST בעטן מעטהאָדס. קיין אנדערע הטטפּ מעטהאָדס זענען ערלויבט.

6.4.1 באַקומען

די ענקאָודיד אָנפֿרעג שטריקל איז אַפּפּענדעד צו די URL.

באַקומען
https://europe.ipx.com/restapi/v1/sms/send?destinationAddress=461234
56789&messageText=העלא+וועלט%21
דערלויבעניש: יקערדיק am9objpjaGFuZ2VtZSA=

6.4.2 פּאָסטן

די ענקאָודיד אָנפֿרעג שטריקל איז דערלאנגט אין די HTTP בעטן אָנזאָג גוף. אינהאַלט-טיפּ איז אַפּלאַקיישאַן / x-www-form-urlקאָדעד.

POST https://europe.ipx.com/restapi/v1/sms/send
האָסט: europe.ipx.com
אינהאַלט טיפּ: אַפּלאַקיישאַן / x-www-form-urlקאָדעד
דערלויבעניש: יקערדיק am9objpjaGFuZ2VtZSA=
אינהאַלט-לענג: 57

דעסטיניישאַן אַדרעס = 46123456789 & אָנזאָג טעקסט = העלא + וועלט% 21

6.5 דאַטע און צייט

פּאַראַמעטערס אין די REST API רעפּריזענטינג דאַטע און צייט זענען שטענדיק אין UTC צייט זאָנע (קאָאָרדינאַטעד וניווערסאַל צייט). צייטamps זענען רעפּריזענטיד ווי אַ שטריקל מיט דעם פּינטלעך פֿאָרמאַט:
2017-04-25T23:20:50Z
דאָס רעפּראַזענץ 20 מינוט און 50 סעקונדעס נאָך די 23 שעה פון אפריל 25, 2017 אין UTC.

7. ענטפער אָנזאָג

נאָך ריסיווינג און ינטערפּרעטינג אַ בעטן אָנזאָג, די API ריספּאַנדז מיט אַ הטטפּ ענטפער אָנזאָג.

7.1 הטטפּ סטאַטוס קאָד

די REST API שטענדיק קערט HTTP סטאַטוס קאָד 200 גוט פֿאַר פּראַסעסט ריקוועס. דער אָנזאָג גוף כּולל אַ פּאַראַמעטער רעספּאָנסעקאָדע וואָס איז געניצט צו באַשטימען די פּינטלעך רעזולטאַט.

7.2 אָנזאָג גוף

דער אָנזאָג גוף באשטייט פון JSON דיסקרייבינג די אַוטקאַם פון די בקשה.
http://json.org/
לינק מאָביליטי דזשסאָן קאַמפּלייז מיט די Google JSON סטייל גייד.
https://google.github.io/styleguide/jsoncstyleguide.xml

7.3 ענטפער פּאַראַמעטערס

נאָמען	מאַקסימום לענג	באַשרייַבונג
ענטפער קאָד	3	0 ינדיקייץ מצליח טראַנסאַקטיאָן.
ענטפער אָנזאָג	255	ענטפער טעקסט באַשרייַבונג, למשל טעות טעקסט.
צייטamp	20	טאָג און צייט ווען LINK מאָביליטי פּראַסעסט די בקשה. (אָפּשיקן צו דאַטע / צייט פֿאָרמאַט אָפּטיילונג).
traceId	36	לינק מאָביליטי ינערלעך ידענטיפיער. געניצט פֿאַר שטיצן און טראָובלעשאָאָטינג.
messageIds	10 X 36	מענגע פון ​​LINK מאָביליטי יינציק אָנזאָג IDs פֿאַר יעדער געראָטן אָנזאָג (קייפל אָנזאָג IDs זענען אומגעקערט אויב דער אָנזאָג איז קאַנקאַטאַנייטאַד). איבערגעהיפּערט אין פאַל פון דורכפאַל.

7.4 עקסampדי רעספּאָנסעס

הצלחה

הטטפּ/1.1 200 גוט
אינהאַלט-טיפּ: אַפּלאַקיישאַן/דזשסאָן
אינהאַלט-לענג: 144
טאָג: Thu, 15 Sep 2016 13:20:31 GMT
{"responseCode":0,"responseMessage":"סאַקסעס","טיימעסטamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}

דאָ איז דער זעלביקער JSON פאָרמאַטטעד פֿאַר לייענען:

{
"ענטפער קאָד":0,
"ענטפער אָנזאָג":"הצלחה",
"צייטamp“:”2016-0915T13:20:31Z”,
"traceId“:”f678d30879fd4adc25f2”,
"messageIds“:[“1-4850879008”]
}

דורכפאַל

הטטפּ/1.1 200 גוט
אינהאַלט-טיפּ: אַפּלאַקיישאַן/דזשסאָן
אינהאַלט-לענג: 148
טאָג: Thu, 15 Sep 2016 13:20:31 GMT
{"responseCode":1,"responseMessage":" אומגילטיק לאָגין אָדער ניט-אָטערייזד אַפּי באַניץ","timestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}

הצלחה

הטטפּ/1.1 200 גוט
אינהאַלט-טיפּ: אַפּלאַקיישאַן/דזשסאָן
אינהאַלט-לענג: 144
טאָג: Thu, 15 Sep 2016 13:20:31 GMT
{"responseCode":0,"responseMessage":"סאַקסעס","טיימעסטamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}

דאָ איז דער זעלביקער JSON פאָרמאַטטעד פֿאַר לייענען:

{
"ענטפער קאָד":0,
"ענטפער אָנזאָג":"הצלחה",
"צייטamp“:”2016-0915T13:20:31Z”,
"traceId“:”f678d30879fd4adc25f2”,
"messageIds“:[“1-4850879008”]
}

דורכפאַל

הטטפּ/1.1 200 גוט
אינהאַלט-טיפּ: אַפּלאַקיישאַן/דזשסאָן
אינהאַלט-לענג: 148
טאָג: Thu, 15 Sep 2016 13:20:31 GMT
{"responseCode":1,"responseMessage":" אומגילטיק לאָגין אָדער ניט-אָטערייזד אַפּי באַניץ","timestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}

7.5 ענטפער קאָודז

די פאלגענדע ענטפער קאָודז קענען זיין אומגעקערט אין די שיקן ענטפער:

קאָד	טעקסט	באַשרייַבונג
0	הצלחה	הצלחה עקסאַקיוטאַד.
1	פאַרקריפּלט לאָגין אָדער ניט-אָטערייזד אַפּי באַניץ	פאַלש נאמען אָדער פּאַראָל אָדער סערוויס פּראַוויידער איז באַרד דורך LINK מאָביליטי.
2	קאָנסומער איז אפגעשטעלט דורך לינק מאָביליטי	דער קאָנסומער איז אפגעשטעלט דורך LINK מאָביליטי.
3	אָפּעראַציע איז נישט פּראַוויזיד דורך LINK מאָביליטי	די אָפּעראַציע איז אפגעשטעלט פֿאַר די סערוויס פּראַוויידער.
4	דער קאַנסומער איז אומבאַקאַנט צו LINK מאָביליטי	דער קאָנסומער איז אומבאַקאַנט צו LINK מאָביליטי. אָדער אויב אַליאַס איז געניצט אין דער בקשה; אַליאַס ניט געפונען.
5	קאָנסומער האט אפגעשטעלט דעם דינסט אין LINK מאָביליטי	דער קאָנסומער האט אפגעשטעלט דעם דינסט אין LINK מאָביליטי.
6	די אָריגינעל אַדרעס איז נישט געשטיצט	די אָריגינעל אַדרעס איז נישט געשטיצט.
7	אַלף-אָריגינינג אַדרעס איז נישט געשטיצט דורך חשבון	די אַלף ערידזשאַנייטינג אַדרעס איז נישט געשטיצט דורך חשבון.
8	די MSISDN-אָריגינינג אַדרעס איז נישט געשטיצט	די MSISDN ערידזשאַנייטינג אַדרעס איז נישט געשטיצט.
9	GSM עקסטענדעד ניט געשטיצט	GSM עקסטענדעד ניט געשטיצט.
10	אוניקאָד ניט געשטיצט	אוניקאָד ניט געשטיצט.
11	סטאַטוס באַריכט ניט געשטיצט	סטאַטוס באַריכט ניט געשטיצט.
12	פארלאנגט פיייקייט ניט געשטיצט	די פארלאנגט פיייקייט (אנדערע ווי די אויבן) פֿאַר שיקן דעם אָנזאָג איז נישט געשטיצט.
13	די מאַקסימום גערגל קורס פון אינהאַלט שפּייַזער איז יקסידיד	די סערוויס פּראַוויידער שיקט די SMS אַרטיקלען צו LINK מאָביליטי צו שנעל.
14	פּראָטאָקאָל שייַן איז נישט געשטיצט דורך חשבון	פּראָטאָקאָל שייַן ניט געשטיצט.
15	אָנזאָג קאַנקאַטאַניישאַן לימיט יקסידיד	די נומער פון קאַנקאַטאַנייטאַד אַרטיקלען יקסידז די מאַקסימום נומער געבעטן.
16	ניט געקענט צו מאַרשרוט אָנזאָג.	LINK מאָביליטי קען נישט רוץ דעם אָנזאָג.
17	פּראָוכיבאַטאַד צייַט צייַט	ניט ערלויבט צו שיקן אָנזאָג בעשאַס צייט
18	צו נידעריק וואָג אויף סערוויס שפּייַזער חשבון	סערוויס פּראַוויידער איז אפגעשטעלט רעכט צו צו נידעריק וואָג
50	טייל הצלחה	טייל הצלחה ווען שיקט אַ SMS אָנזאָג צו קייפל ריסיפּיאַנץ.
99	אינערלעכער סערווער טעות	אנדערע לינק מאָביליטי טעות, קאָנטאַקט LINK מאָביליטי שטיצן פֿאַר מער אינפֿאָרמאַציע.
100	אומגילטיק דעסטיניישאַן אַדרעס	די דעסטיניישאַן אַדרעס (MSISDN, אָדער אַליאַס) איז פאַרקריפּלט.
102	אומגילטיק רעפעראַנסט (לינגקט) ID	די רעפֿערענץ שייַן איז פאַרקריפּלט, אפֿשר די רעפֿערענץ שייַן איז שוין געניצט, צו אַלט אָדער אומבאַקאַנט.
103	אומגילטיק אקאונט נאמען	דער אקאונט נאמען איז אומגילטיק.
105	ומגליד דינסט מעטאַ דאַטן	די דינסט מעטאַ דאַטן איז פאַרקריפּלט.
106	אומגילטיק אָריגינעל אַדרעס	די אָריגינעל אַדרעס איז פאַרקריפּלט.
107	אומגילטיק אַלפאַנומעריק אָריגינס אַדרעס	די אַלפאַנומעריק אָריגינעל אַדרעס איז פאַרקריפּלט.
108	אומגילטיקייט צייט	די גילטיקייט צייט איז פאַרקריפּלט.
109	פאַרקריפּלט עקספּרעס צייַט	די עקספּרעס צייט איז פאַרקריפּלט.
110	אומגילטיק אָנזאָג אינהאַלט / באַניצער דאַטן	דער באַניצער דאַטן, ד"ה די SMS אָנזאָג, איז פאַרקריפּלט.
111	אומגילטיק אָנזאָג לענג	די SMS אָנזאָג לענג איז פאַרקריפּלט.
112	אומגילטיק באַניצער דאַטן כעדער	דער באַניצער דאַטן כעדער איז פאַרקריפּלט.
113	פאַרקריפּלט דאַטן קאָדירונג סכעמע	די DCS איז פאַרקריפּלט.
114	אומגילטיק פּראָטאָקאָל שײַן	די PID איז פאַרקריפּלט.
115	אומגילטיגע סטאטוס באריכט פלאַגס	די סטאַטוס באַריכט פלאַגס זענען פאַרקריפּלט.
116	אומגילטיק TON	דער אָריגינעל TON איז פאַרקריפּלט.
117	פסול גampרייט נאָמען	די קampדער נאָמען פון דער נאָמען איז פאַרקריפּלט.
120	אומגילטיק שיעור פֿאַר מאַקסימום נומער פון קאַנקאַטאַנייטאַד אַרטיקלען	די מאַקסימום נומער פון קאַנקאַטאַנייטאַד אַרטיקלען איז פאַרקריפּלט.
121	אומגילטיק מיסיסדן אָריגינס אַדרעס	די MSISDN ערידזשאַנייטינג אַדרעס איז פאַרקריפּלט.
122	אומגילטיק קאָראַליישאַן שייַן	די קאָראַליישאַן שייַן איז פאַרקריפּלט.

8. אָפּטיאָנאַל פֿעיִקייטן

8.1 מסיסדן קערעקשאַן

MSISDN קערעקשאַן איז אַן אַפּשאַנאַל שטריך וואָס קענען זיין ענייבאַלד דורך LINK מאָביליטי שטיצן אויב געבעטן.

דער שטריך וועט ריכטיק דעסטיניישאַן אַדרעסעס און ייַנרייען זיי צו די פארלאנגט E.164 פֿאָרמאַט. אין אַדישאַן פון פֿאָרמאַט קערעקשאַן, די סיסטעם קען אויך דורכפירן מאַרק ספּעציפיש פאַנגקשאַנאַליטי אַזאַ ווי איבערזעצן אינטערנאַציאָנאַלע פראנצויזיש נומערן צו ריכטיק DOM-TOM (départements et territoires d'outre-mer) נומערן ווען אָנווענדלעך.

ונטער זענען אַ נומער פון עקסampלערן פון קערעקשאַנז:

דערלאנגט דעסטיניישאַן אַדרעס	קערעקטאַד דעסטיניישאַן אַדרעס
+46(0)702233445	46702233445
(0046)72233445	46702233445
+460702233445	46702233445
46(0)702233445	46702233445
46070-2233445	46702233445
0046702233445	46702233445
+46(0)702233445אַאַ	46702233445
336005199999	2626005199999 (פראנצויזיש נומער איבערגעזעצט צו אַ DOM-TOM נומער)

דערצו, עס איז מעגלעך צו לאָזן נאציאנאלע טעלעפאָן נומערן פֿאַר אַ אויסגעקליבן מאַרק. ווען דעם שטריך איז ענייבאַלד, קיין אינטערנאַציאָנאַלע נומערן פֿאַר אנדערע מארקפלעצער מוזן זיין געשיקט מיט אַן ערשט '+' צייכן צו ויסטיילן זיי פון די אויסגעקליבן מאַרק.

ונטער זענען עטלעכע עקסampליי פון קערעקשאַנז געטאן ווען ניצן שוועדן (לאַנד קאָד 46) ווי פעליקייַט מאַרק פֿאַר נאציאנאלע נומערן.

דערלאנגט דעסטיניישאַן אַדרעס	קערעקטאַד דעסטיניישאַן אַדרעס
0702233445	46702233445
070-2233 445	46702233445
070.2233.4455	46702233445
460702233445	46702233445
+460702233445	46702233445
+458022334455	458022334455
45802233445	ניט גילטיק זינט די '+' צייכן איז פעלנדיק

באַמערקונג אַז די קערעקטאַד MSISDN וועט זיין געוויינט דורך LINK מאָביליטי און עס וועט זיין אומגעקערט אין די עקספּרעס ריפּאָרץ.

ביטע קאָנטאַקט LINK מאָביליטי שטיצן פֿאַר מער אינפֿאָרמאַציע.

8.2 טשאַראַקטער פאַרבייַט

כאַראַקטער פאַרבייַט איז אַן אַפּשאַנאַל שטריך וואָס קענען זיין ענייבאַלד דורך LINK מאָביליטי שטיצן אויב געבעטן.

דער שטריך וועט איבערזעצן ניט-גסם אלפאבעט אותיות אין די באַניצער דאַטן (SMS טעקסט) צו עקוויוואַלענט GSM אלפאבעט אותיות ווען די DCS איז באַשטימט צו "GSM" (17). פֿאַר עקסampדי "Sequüência de teste em Português" וועט זיין איבערגעזעצט צו "Sequüencia de teste em Português".

9. עקספּרעס ריפּאָרץ

די סערוויס פּראַוויידערז קענען, אויב פּראַוויזשאַנד, בעטן SMS אָנזאָג עקספּרעס ריפּאָרץ אָדער עקספּרעס נאָוטאַפאַקיישאַנז פֿאַר די געשיקט MT אַרטיקלען. די ריפּאָרץ זענען טריגערד אין די אָפּעראַטאָר SMSC ווען די MT אָנזאָג איז אָדער איבערגעגעבן צו די טאַרגעטעד קאָנסומער אָדער אויסגעמעקט, למשל, אויסגעגאנגען אָדער, פֿאַר עטלעכע סיבה, נישט ראָוטאַבאַל.

בלויז די לעצט סטאַטוס פון די SMS אָנזאָג איז רעפּאָרטעד צו די סערוויס פּראַוויידער, דאָס הייסט, איבערגעגעבן אָדער אויסגעמעקט. בלויז איין באַריכט פּער מט אָנזאָג איז דזשענערייטאַד. מיט די אויסגעמעקט סטאַטוס, אַ סיבה קאָד קען צולייגן. דער סיבה קאָד ספּעציפיצירט די סיבה פֿאַר די SMS אָנזאָג איז נישט איבערגעגעבן.

די ריפּאָרץ זענען ראַוטיד דורך LINK מאָביליטי און געשיקט צו די סערוויס פּראַוויידערז ניצן די הטטפּ פּראָטאָקאָל.

צו באַקומען ריפּאָרץ, די סערוויס פּראַוויידערז מוזן ינסטרומענט פֿאַר עקסampאַ Java Servlet אָדער אַ ASP.NET בלאַט. ביידע באַקומען HTTP GET אָדער POST ריקוועס.

פּאַראַמעטערס

דער בקשה כולל די פאלגענדע פּאַראַמעטערס:

פּאַראַמעטער	טיפּ	M/O/I*	פעליקייַט ווערט	מאַקסימום לענג	באַשרייַבונג
MessageId	שטריקל	M	–	22	דער אָנזאָג שייַן פון די MT אָנזאָג וואָס דער באַריכט קאָראַספּאַנדז צו.
דעסטינאַטיאָן אַדרעס	שטריקל	M	–	40	די קאָנסומער ס MSISDN, הייסט די דעסטיניישאַן אַדרעס פון דער אָריגינעל מט אָנזאָג.
סטאַטוס קאָד	גאַנץ נומער	M		1	סטאַטוס קאָד ינדיקייץ די סטאַטוס פון די MT אָנזאָג. אָנווענדלעך סטאַטוס קאָודז זענען: 0 - איבערגעגעבן 2 - אויסגעמעקט (סיבה קאָד אַפּלייז)
TimeStamp	שטריקל	M	–	20	צייט וואָס ינדיקייץ ווען די עקספּרעס באַריכט איז באקומען דורך LINK מאָביליטי. די צייט זאָנע פון ​​די צייטamp איז CET אָדער CEST (מיט זומער צייט ווי דיפיינד פֿאַר די אי.יו.). פֿאָרמאַט: yyyyMMdd HH:mm:ss.
אָפּעראַטאָר	שטריקל	M	–	100	דער נאָמען פון דער אָפּעראַטאָר געניצט ווען שיקט די SMS אָנזאָג אָדער די חשבון נאָמען געניצט ווען שיקט די SMS אָנזאָג. א רשימה פון פאַראַנען אָפּערייטערז איז צוגעשטעלט דורך LINK מאָביליטי שטיצן.
ReasonCode	גאַנץ נומער	O	–	3	סיבה קאָד ינדיקייץ וואָס די אָנזאָג ענדיקט זיך אין די אויסגעמעקט סטאַטוס. אָנווענדלעך סיבה קאָודז זענען: 100 - אויסגעגאנגען 101 – אפגעווארפן 102 - פֿאָרמאַט טעות 103 - אנדערע טעות 110 - אַבאָנענט אומבאַקאַנט 111 - אַבאָנענט באַרד 112 - אַבאָנענט ניט פּראַוויזשאַנד 113 - אַבאָנענט אַנאַוויילאַבאַל 120 - SMSC דורכפאַל 121 - SMSC קאַנדזשעסטשאַן 122 - SMSC ראָומינג 130 - כאַנדסעט טעות 131 - כאַנדסעט זכּרון יקסידיד אָפּפירונג קען בייַטן מיט אָפּעראַטאָר ינטאַגריישאַנז.
OperatorTimeStamp	שטריקל	O	–	20	צייט וואָס ינדיקייץ ווען דער באַריכט איז טריגערד אין די SMSC פון די אָפּעראַטאָר (אויב צוגעשטעלט דורך די אָפּעראַטאָר). די צייט זאָנע פון ​​די צייטamp איז CET אָדער CEST (מיט זומער צייט ווי דיפיינד פֿאַר די אי.יו.). פֿאָרמאַט: yyyyMMdd HH:mm:ss.
סטאַטוס טעקסט	שטריקל	O	–	255	אָרטהאָלדער פֿאַר נאָך אינפֿאָרמאַציע פון ​​די אָפּעראַטאָר, למשל קלאָר טעקסט באַשרייַבונג פון די סטאַטוס / סיבה. אָפּפירונג קען בייַטן מיט אָפּעראַטאָר ינטאַגריישאַנז.
CorrelationId	שטריקל	O	–	100	די קאָראַליישאַן שייַן צוגעשטעלט אין די SendRequest אָדער SendTextRequest.
אָפּעראַטאָר נעץ קאָד	גאַנץ נומער	O	–	6	די מאָביל נעטוואָרק קאָוד (MCC + MNC) פון די אָפּעראַטאָר.

* מ = מאַנדאַטאָרי, אָ = אַפּשאַנאַל, איך = איגנאָרירט.
די סערוויס פּראַוויידערז מוזן צושטעלן LINK מאָביליטי מיט דעם ציל URL פֿאַר עקספּרעס ריפּאָרץ (אַפּשאַנאַל אַרייַנגערעכנט קראַדענטשאַלז פֿאַר הטטפּ יקערדיק אָטענטאַקיישאַן). דער סערוויס פּראַוויידער קענען קלייַבן וואָס בילכער HTTP אופֿן צו נוצן:
HTTP POST (רעקאַמענדיד)
הטטפּ באַקומען.

Exampניצן HTTP GET (סוקסעספוללי איבערגעגעבן):
https://user:password@www.serviceprovider.com/receivereport?%20MessageId=122&DestinationAddress=46762050312&Operator=Vodafone&TimeStamp=20100401%2007%3A47%3A44&StatusCode=0

Exampניצן HTTP GET (ניט איבערגעגעבן, דער אָפּעראַטאָר האט צוגעשטעלט די צייטamp פֿאַר די געשעעניש):

https://user:password@www.serviceprovider.com/receivereport?MessageId=123&DestinationAddress=46762050312&Operator=Vodafone&OperatorTimeStamp=20100401%2007%3A47%3A59&TimeStamp=20100401%2007%3A47%3A51&StatusCode=2&StatusText=Delivery%20failed&ReasonCode=10

די פּאַראַמעטערס זענען URL קאָדעדי.

כאַראַקטער קאָדירונג:
דער סערוויס פּראַוויידער קענען קלייַבן וואָס בילכער כאַראַקטער קאָדירונג צו נוצן:
UTF-8 (רעקאַמענדיד)
ISO-8859-1.

9.1 דערקענטעניש פון סערוויס פּראַוויידערז

דער סערוויס פּראַוויידער זאָל באַשטעטיקן יעדער עקספּרעס באַריכט. די דערקענטעניש קענען זיין positive, ד"ה עקספּרעס באַריכט הצלחה באקומען, אָדער נעגאַטיוו, הייסט דורכפאַל.

ביטע טאָן: LINK מאָביליטי האט אַ לייענען טיימאַוט פֿאַר 30 סעקונדעס פֿאַר עקספּרעס ריפּאָרץ. א טיימאַוט וועט צינגל אַ עקספּרעס ווידער (אויב ווידער פּרובירן ענייבאַלד) אָדער אַ קאַנסאַליישאַן פון די עקספּרעס (אויב ווידער פּרובירן פאַרקריפּלט). דעם מיטל אַז די סערוויס פּראַוויידער אַפּלאַקיישאַן מוזן ענשור שנעל ענטפער צייט, ספּעציעל בעשאַס הויך מאַסע.

עס איז העכסט רעקאַמענדיד צו באַשטעטיקן די עקספּרעס באַריכט צו LINK מאָביליטי איידער פּראַסעסינג עס.

די הערשן פֿאַר positive און נעגאַטיוו דערקענטעניש איז דיסקרייבד ווי גייט:

Positive דערקענטעניש, ACK, עקספּרעס באַריכט איבערגעגעבן:
HTTP 200 קייט ענטפער קאָד אין קאָמבינאַציע מיט די פאלגענדע קסמל פאָרמאַטטעד אינהאַלט:

נעגאַטיוו דערקענטעניש, NAK, עקספּרעס באַריכט איז נישט איבערגעגעבן:
קיין ענטפער אנדערע ווי positive דערקענטעניש, למשלampליי, אַ נעגאַטיוו דערקענטעניש איז טריגערד דורך קיין הטטפּ טעות קאָד אָדער די פאלגענדע קסמל אינהאַלט:

די קסמל אינהאַלט קענען זיין געוויינט פֿאַר קאַנטראָולינג די LINK מאָביליטי ריטריי מעקאַניזאַם. א NAK וועט פאַרשאַפן פּרווון ווידער, אויב ענייבאַלד. פֿאַר סערוויס פּראַוויידערז וואָס זענען נישט קאַנפיגיערד פֿאַר די ריטריי מעקאַניזאַם, די קסמל אינהאַלט איז אַפּשאַנאַל.

ונטער איז אַן HTTP POST בעטן און ענטפער עקסampפון אַ עקספּרעס באַריכט איבערגעגעבן צו אַ סערוויס פּראַוויידער:

הטטפּ בעטן:

POST / קאָנטעקסט / אַפּ הטטפּ / 1.1
אינהאַלט טיפּ: אַפּלאַקיישאַן / x-www-form-urlקאָדעד; טשאַרסעט = וטף-8
באַלעבאָס: סערווער: פּאָרט
אינהאַלט-לענג: קסנומקס

MessageId=213123213&DestinationAddress=46762050312&Operator=Telia& OperatorTimeStamp=20130607%2010%3A45%3A00&TimeStamp=20130607%2010%3A 45%3A02&StatusCode=0

הטטפּ ענטפער:

הטטפּ/1.1 200 גוט
אינהאַלט-טיפּ: טעקסט / קלאָר

9.2 פּרובירן ווידער

די LINK מאָביליטי סיסטעם קענען דורכפירן ריטריווינג פרווון פֿאַר דורכפאַל, ד"ה ניט יקנאַלידזשד, עקספּרעס מעלדונג דעליווערי. די סערוויס פּראַוויידערז קענען קלייַבן די בילכער אָפּפירונג:

ניט ווידער (פעליקייַט) - דער אָנזאָג וועט זיין דיסקאַרדיד אויב קשר פּרווון פיילז, לייענען צייט-אויס אָדער פֿאַר קיין HTTP טעות קאָד.

פרובירט ווידער - דער אָנזאָג וועט זיין דערשראָקן פֿאַר יעדער טיפּ פון קשר פּראָבלעם, לייענען טיימאַוט אָדער נעגאַטיוו דערקענטעניש.

ווען ריטריי פֿאַר NAK איז ענייבאַלד, עס איז וויכטיק צו פֿאַרשטיין וואָס סינעריאָוז וואָס וועט דזשענערייט אַ ריטריי פּרווון פֿון LINK מאָביליטי און ווי די ריטריי אַרבעט. יעדער סערוויס פּראַוויידער האט זיין אייגענע ריי פון ריטריי, ווו אַרטיקלען זענען אָרדערד לויט די אָנזאָג צייטamp. לינק מאָביליטי שטענדיק פרוווט צו באַפרייַען עלטערע אַרטיקלען ערשטער, כאָטש די יחיד סדר פון אַרטיקלען איבערגעגעבן צו די סערוויס פּראַוויידער איז נישט געראַנטיד. די הויפּט סיבה פֿאַר אַרטיקלען וואָס זענען אַוועקגענומען פון די ריטריי ריי איז איינער פון צוויי סיבות: אָדער דער אָנזאָג TTL יקספּייערז אָדער (טהעאָרעטיקאַללי) די ריטריי ריי ווערט פול. די TTL איז אָפּעראַטאָר און חשבון אָפענגיק, ד"ה, קענען בייַטן דיפּענדינג אויף אָפּעראַטאָר און אָדער אָנזאָג טיפּ, למשל, פּרעמיע SMS אָדער נאָרמאַל קורס SMS אָנזאָג.

א סערוויס פּראַוויידערז מיט ריטריי ענייבאַלד מוזן קאָנטראָלירן די יינציק שייַן פון די MT אָנזאָג צו זיכער אַז דער אָנזאָג איז נישט שוין באקומען.

עס איז וויכטיק פֿאַר די סערוויס פּראַוויידערז צו נאָכקומען מיט די פּשוט כּללים ווען אַ טעות אַקערז בעשאַס די פּראַסעסינג פון אַ עקספּרעס באַריכט אויב די סיבה פֿאַר די טעות איז: צייטווייליגע, למשל דאַטאַבייס ניט בנימצא, אַ NAK זאָל זיין אומגעקערט. LINK מאָביליטי וועט ווידער שיקן דעם אָנזאָג.

פּערמאַנענט און אַ ריטריי פּרווון זענען מסתּמא צו פאַרשאַפן די זעלבע מין פון פּראָבלעם, אַ ACK זאָל זיין אומגעקערט. פֿאַר עקסample, ווען דער אָנזאָג קען נישט זיין פּאַרסעד ריכטיק אָדער געפֿירט אַן אומגעריכט רונטימע טעות.

אַקטינג אַקאָרדינגלי וועט ענשור אַז קיין בלאַקינג אָדער דורכפירונג דערנידעריקונג איז געפֿירט ווייַל פון אַ עקספּרעס באַריכט ריפּיטידלי פאַרדריסן.

10. ימפּלעמענטאַטיאָן עצות

1. עס איז מעגלעך צו נוצן דיין web בלעטערער צו פאָרלייגן ריקוועס צו די API. דאָס מאכט עס זייער גרינג צו ויספאָרשן און אָפּשאַצן די סערוויסעס אָן אַנטוויקלונג מכשירים.

2. קראָום אָדער פירעפאָקס זענען רעקאַמענדיד צוזאַמען מיט אַ פאַרלענגערונג אַזאַ ווי JSONView צו ווייַזן שיין-פאָרמאַטייטיד JSON.

3. מיר האָבן געוויינט SoapUI פֿאַר טעסטינג POST, באַסיק אָטענטאַקיישאַן און פֿאַר ינספּעקטינג די רוי הטטפּ בעטן און ענטפער אַרטיקלען.

https://www.soapui.org/

4. די קURL די געצייַג איז נוציק פֿאַר סאַבמיטינג POST ריקוועס מיט באַסיק אָטענטאַקיישאַן. זען עקסample אונטן.

https://curl.haxx.se/

curl פּאָסטן \
-ה "אינהאַלט-טיפּ: אַפּלאַקיישאַן / x-www-form-urlקאָדעד" \
-ה "אַוטהאָריזאַטיאָן: יקערדיק am9objpjaGFuZ2VtZSA =" \
https://europe.ipx.com/restapi/v1/sms/send \
– דאַטן "דעסטינאַטיאָן אַדרעס = 46123456789 & אָנזאָג טעקסט = העלא + וועלט% 21"

_______________

יבערמאַכן פערזענליכען קאָמוניקאַציע