REST API dokumentācija
SMS & MMS REST API
Sūtiet apstiprinātus lietojumprogrammu ziņojumus un apstrādājiet pieņemšanu, piegādes notikumus, segmentēšanu un maksas.
Izvēlieties API un akreditācijas datus kopā
Apstiprināti konti kategorijās Izstrādātājiem un automatizācijai, Bizness un Sakaru pakalpojumu sniedzēji var integrēt iespējotus pakalpojumus. Individuālam izstrādātājam nav jāizliekas par uzņēmumu. Lietojumprogrammu SMS/MMS nepieciešams atbilstošs sūtīšanas apstiprinājums un reģistrācija. Pakalpojumam Privātpersonām un ģimenēm nav klientiem pieejama API ziņojumu sūtīšanas sākšanai.
| API saime | Bāzes URL | Autentifikācija un rezultāts |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Apstiprināti Basic akreditācijas dati; atbilstoši nodrošināti pilnvarojumi tikai darbībām, kas tos atbalsta. JSON status un response. |
| Reģistrācija ārkārtas zvanu pakalpojumam | https://api.multi.tel/emergency | Apstiprināti Basic akreditācijas dati vai īpaši nodrošināta bearer piekļuve. JSON code, message un data. |
| Portāla REST integrācijas | Resursdators un darbība ir norādīta jūsu konta izstrādātāju uzziņā | Izmantojiet šīs darbības dokumentētos akreditācijas datus, tvērumus un shēmu. Pārlūkprogrammas sesijas pieprasījumi ir atsevišķa saskarne. |
Pirms piemēru izmantošanas iestatiet MULTITEL_API_USERNAME un MULTITEL_API_PASSWORD, izmantojot sava servera slepeno konfigurāciju. Nekad neieguliet tos publiskā pārlūkprogrammas JavaScript kodā, URL vai pirmkoda kontrolē. Speciālie akreditācijas dati tiek pārvaldīti sadaļā API integrācijas iestatījumi.
Sagatavojiet SMS pieprasījumu
Izmantojiet apstiprinātu, SMS iespējotu sūtīšanas numuru, kas pieder kontam, un adresātu, kurš ir piekritis saņemt ziņojumu. Veiciet nepieciešamo zīmola/kampaņas (Brand/Campaign) reģistrāciju vai zvanītājam bezmaksas numura verifikāciju. Tālāk sniegtais piemērs, aizpildot to ar derīgiem akreditācijas datiem un numuriem, nosūta īstu ziņojumu; tā nav smilškaste.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
--request POST \
--header "Content-Type: application/json" \
--data '{"from":"YOUR_APPROVED_NUMBER","to":"YOUR_CONSENTED_RECIPIENT","text":"Your requested update is ready."}' \
"https://api.multitel.net/v3/sendsms"Aizstājiet sūtītāja un adresāta vietturus ar tālruņa numuriem starptautiskajā formātā, izmantojot tikai ciparus un iekļaujot valsts kodu. MMS gadījumā norādiet atbalstīto publiski izgūstamo multivides URL laukā media un vispirms pārbaudiet MMS atbilstību un cenas.
Pieņemšana nav piegāde
Pārbaudiet gan ārējo lietojumprogrammas statusu, gan atgriezto ziņojumapmaiņas rezultātu. Reģistrējiet pakalpojuma sniegto ziņojuma identifikatoru un sekojiet piegādes statusam un tīmekļa aizķeres (webhook) notikumiem. Veiksmīga iesniegšana nevar pierādīt, ka adresāta tālrunis ir saņēmis ziņojumu.
SMS norēķini tiek veikti par segmentu. Kodējums un ziņojuma garums var radīt vairākus segmentus; multivides un ar operatoru saistītās maksas var atšķirties no SMS. Pirms sūtīšanas izlasiet konta pašreizējo pārdošanas cenu. Nekad akli neatkārtojiet sūtīšanu ar noildzi: vispirms pārbaudiet tā reģistrēto iznākumu.
Apstrādājiet kļūdas un atkārtojumus
- Autentifikācijas vai atļaujas kļūme
- Pārbaudiet API akreditācijas datu iespējoto stāvokli, atļauto pakalpojumu un avota IP ierobežojumu. Portāla sesijas sīkfails nav integrācijas akreditācijas dati.
- Nepietiekams kredīts vai neizpildīts apstiprinājums
- Pirms darbības atkārtošanas sakārtojiet konta bilanci, sūtīšanas apstiprinājumu vai dokumentu prasību.
- Nav rezultāta
- Tukšu krājumu vai trūkstošu zvanītāja vārdu uzskatiet par parastu iznākumu. Nepieņemiet, ka sintaktiski derīgam numuram ir visi pakalpojumi.
- Tīkla noildze vai pakalpojuma kļūme
- Lasīšanai izmantojiet ierobežotus atkārtojumus ar aizkavi. Pirkumam, sūtīšanai vai reģistrācijai vispirms pārbaudiet darbības stāvokli; pieņemta pieprasījuma atkārtošana var dublēt apmaksājamu darbību.
Idempotences atbalsts ir atkarīgs no API saimes. Emergency API atbalsta atkārtošanas atslēgas; tas nepadara patvaļīgus v3 pieprasījumus par idempotentiem. Atbalstam saglabājiet laikspiedolus, atgrieztos ID un atbildes, no kurām izņemti sensitīvie dati.
Turpiniet ar sava konta atsauci
Pēc pierakstīšanās pieejamā dokumentācija filtrē darbības atbilstoši jūsu atļaujām un iespējotajiem pakalpojumiem. Izmantojiet tajā norādīto precīzo resursdatoru, akreditācijas datu veidu, pieprasījuma laukus un atbildes shēmu. Konsoles var veikt reālas darbības, tostarp pirkumus un ziņojumu sūtīšanu.