Izmaiņas kopš iepriekšējās versijas (0.15):

Vienkāršota ziņojumu izsūtīšana, apvienojot visas sūtīšanas pieprasījuma metodes vienotā Send metodē.
Send metodi tagad var izmantot, lai pēc kopīga šablona nosūtītu personalizētu saturu katram adresātam.
Send pievienots parametrs Transliteration, automātiskai Unicode rakstzīmju pārveidošanai uz atbilstošākajām GSM alfabēta vienībām.
No Send metodes noņemti parametri Concatenated un Unicode, jo tiem bija ierobežots pielietojums (kļūdas atgriešana noteiktos apstākļos), radīja neskaidrības attiecībā uz pieprasījumu ieviešanu un to iekļaušana Send metodē nebūtu praktiska. Ja paļāvāties uz šo funkcionalitāti, piekodinām, ka pieprasījumi, kuri šo parametru dēļ iepriekš būtu noraidīti, turpmāk tiks veiksmīgi izpildīti.
MSSID parametrs, kas norāda uz viena ziņojuma identifikatoru pieprasījumos un atbildēs, ir pārdēvēts par, vienkārši, ID.
InvalidCC kļūdas kods skaidrības labad ir pārdēvēts par InvalidCountryCode.
Piegādes atskaitēm pievienots nepiegādāto ziņojumu statuss Expired.
Autentiskuma nodrošināšanai Izmantota HMAC autentifikācija, lai parakstītu piegādes ziņojumu webhook pieprasījumus.

pēc palaišanas ieviestās “Non-breaking” izmaiņas:

Atbalsts saišu saīsināšanai API ziņojumu sūtīšanā.

Iepriekšējās versijas (0.15) lietošanas pamācība ir pieejama šeit.

Iesākumam

Informācija, kas nepieciešama jūsu konta un API piekļuves aktivizēšanai, ir:
jūsu servera IP adrese (ir iespējamas vairākas adreses, aizstājējzīmes (wildcard substitution) un apakštīkli (subnets).
HTTP adrese priekš "webhook", uz kuru pārsūtīt īsziņu piegādes pārskatus. Ja piegādes atskaites nav nepieciešamas, šo adresi var izlaist.

Pēc šīs informācijas saņemšanas mēs iedosim Jums API atslēgu, ko var izmantot SMS padošanai.

Piezīme - ja Jums ir vairākas vides, no kurām vēlaties sūtīt SMS, piemēram, izstrādes/testa vide un produkcijas vide, katrai no tām būs nepieciešams atsevišķs API konts un atsevišķa API atslēga.

Vispārīga SMS informācija

Standarta SMS garums ir 160 GSM alfabēta simboli (aprakstīts šeit - SMS saturs un garums). Garākas īsziņas ir iespējamas, sūtot tās atsevišķās daļās, kas saņēmēja galā tiek apvienotas, taču katra no šīm daļām rēķinā tiks uzrādīta kā atsevišķa SMS. Tomēr sūtot vairākdaļu īsziņu, katra atsevišķā daļa ir nedaudz īsāka nekā viena SMS - viena daļa var būt līdz 153 simbolus gara, piemēram, 160 simbolu SMS var tikt nosūtīta kā viendaļīga īsziņa, taču 170 simbolu īsziņa tiks nosūtīta divās daļās - pirmā 153 simbolus gara, otrā - 17.

Tā kā GSM alfabēts satur tikai nelielu daļu no visiem iespējamajiem simboliem, ir iespējams sūtīt arī Unicode SMS, kurās iespējami visi simboli, kas pieejami UCS-2 kodējumā, taču šajā gadījumā SMS garums Unicode īsziņas gadījumā samazināsies līdz 70 simboliem un vairākdaļu īsziņā, katra SMS daļas garums samazinās līdz 67 simboliem (katrs simbols aizņem 2 baitus).

Piezīme - GSM alfabētā ir vairāki simboli, kuri aizņem divu simbolu vietu, piemēram, eiro simbols €, kvadrātiekavas [], u.c.

Teorētiski ir iespējams sūtīt vairākdaļu īsziņas, kas sastāv pat no 255 daļām, taču dažādu operatoru, SMS kanālu un telefona aparātu savietojamības dēļ, maksimālais pieļautais vairākdaļu īsziņas garums ir 7 daļas.

Sūtītātja identifikators

Sūtot ziņojumu, izmantojot Traffic, kā sūtītāja identifikatoru varat norādīt jebkuru numuru vai tekstu (t.i., to, kas parādīsies saņēmēja tālrunī kā ziņojuma sūtītājs). Tas var būt jūsu tālruņa numurs, jūsu zīmola nosaukums vai jebkurš cits teksts, taču ir daži ierobežojumi:
Jums sūtītāja identifikators/-i mums iepriekš jāpieprasa. Pēc pieprasījuma tie tiks pievienoti jūsu kontam un tikai pēc tam varēsiet tos izmantot.
Sūtītāja identifikatora garums:
3 līdz 11 burtciparu rakstzīmes (vārdiskā numura gadījumā)
vai
3 līdz 14 ciparu tālruņu numuri (jābūt vai jāatbilst reāla tālruņa numura formātam)
GSM standartā burtu un ciparu sūtītāja identifikatorā atļauts izmantot tikai 0–9, a – z, A – Z rakstzīmes un apakšsvītra (_). Tehniski ir iespējams izmantot arī citas rakstzīmes, taču tas var izraisīt dažādas kļūdas, piemēram, problēmas ar ziņu parādīšanos, tiek uzrādīts cits sūtītāja vārds, ziņas tiek piegādātas atkārtoti, sūtītāja ID tiek parādīts nepareizi utt.
Esiet uzmanīgi un neizvēlieties sūtītāja identifikatoru, kas var tikt pārveidots kā tālruņa numurs, kad sūtītāja ID tiek transportēts saņēmējiem (piemēram, 2 = ABC, 3 = DEF utt.). Daudzi tālruņi automātiski pārveidos šos identifikatorus tālruņa numuros, ja saņēmējs mēģinās atbildēt vai piezvanīt uz šādu sūtītāja identifikatoru.

Vispārīga sistēmas informācija

Atkarībā no noslēgtās vienošanās starp jums un SIA "NESS", jūsu kontam var būt vai nu mēneša kvota SMS sūtīšanai (pēcapmaksas līgumiem) vai arī SMS apjoma limits (priekšapmaksas līgumiem) atkarībā no apmaksātā apjoma. Mēneša kvotas apmērs tiek uzstādīts abpusēji vienojoties un ir paredzēts galvenokārt drošības labad, lai nejaušu (vai arī tīšu) darbību rezultātā netiktu nosūtīts pārlieku liels SMS daudzums.
Apjoma limits priekšapmaksas kontam ir atkarīgs no apmaksātās summas.

Piegādes atskaišu saņemšana

Veicot īsziņu izsūtīšanu ir iespējams saņemt piegāžu atskaites, izmantojot "webhook".

API informācija

API adrese https://traffic.sales.lv/API:0.16/
Visi dati jāpadod HTTP POST pieprasījumos ar application/x-www-form-urlencoded satura tipu (Content-Type).

Katram pieprasījumam ir obligāti parametri (to nosaukumos obligāti jāievēro lielie burti):
APIKey: piešķirtā API atslēga.
Command: komandas nosaukums.
Pārējie parametri atkarīgi no konkrētās komandas.

No komandām atgrieztie dati tiek serializēti ar JSON.

Ja saņemtais pieprasījums ir kļūdains, atbildē tiks atgriezts parametrs Error ar kļūdas kodu.
Vispārīgie kļūdu kodi, kas attiecināmi uz visām komandām:
InvalidAPIVersion: adresē norādīta kļūdaina API versija (šai versijai jābūt 0.16).
NoAPIKey: nav norādīta API atslēga.
InvalidAPIKey: kļūdaina vai neeksistējoša API atslēga.
UnauthorizedIP: klienta IP adrese nav autorizēta.
CommandNotSpecified: nav norādīta izpildāmā komanda (Command parametrs tukšs).
CommandNotImplemented: norādītā komanda neeksistē vai nav pieejama.
SystemError: sistēmas kļūda.

Šajā API versijā ir iespējamas šīs komandas:
SMS sūtīšana
Send: nosūta vienu vai vairākas SMS ar norādītajiem parametriem. Iespējama ar dažādu īsziņas saturu, dažādiem saņēmējiem, kā arī ar personalizētu saturu vadoties pēc vienota šablona.
GetDelivery: atgriež piegādes statusu vienai vai vairākām īsziņām pēc to identifikatoriem.
GetReport: atgriež visus datus par vienu vai vairākām īsziņām pēc to identifikatoriem.

SMS melnā saraksta pārvaldība
GetBlacklist: Atgriež melnā saraksta saturu
BlacklistAdd: Pievienojiet tālruņa numuru SMS melnajam sarakstam
BlacklistDelete: Dzēst tālruņa numuru no SMS melnā saraksta

Konta informācija
GetSenders: atgriež sarakstu ar visiem jums pieejamajiem sūtītāju vārdiem (vārdiskajiem numuriem).

Komandu apraksts

Send

Nosūta vienu vai vairākas SMS ar norādītajiem parametriem.

Ievades parametri:
Recipients: saņēmēja numurs teksta veidā vai vairāki numuri JSON masīvā. Pirms numura varat ievietot valsts kodu, taču bez 00 vai + (tāpat arī starptautiskajiem numuriem). Papildus, ievadot JSON masīvu ir iespējamas vairākas metodes kā norādīt īsziņas saturu. Tās aprakstītas zemāk sadaļā Īsziņas satura variācijas.
Sender: sūtītāja adreses teksts (vārdiskais numurs), piem. zīmola nosaukums.
Content: SMS saturs UTF-8 kodējumā (gan parastajām, gan Unicode SMS).
(neobligāts) SendTime: izsūtīšanas laiks (kad sākt izsūtīšanu), Unix timestamp formātā. Nav obligāts, ja tas nav norādīts, izsūtīšana sāksies uzreiz.
(neobligāts) CC: noklusētais valsts kods, kas jāizmanto numuriem, kuriem tas nav norādīts. Nav obligāts. Noklusējums būs attiecīgi tas, kas uzstādīts jūsu kontam. Ja saņēmēja numurs saturēs valsts kodu, šis netiks izmantots.
(neobligāts) Validity: SMS derīguma termiņš (minūtēs), t.i., laiks, pēc kura mobilais operators pārtrauc atkārtotu piegādi, ja tālruņa numurs ir derīgs, bet nav uzreiz sasniedzams. Pēc noklusējuma ir 1440 (24 stundas.)
(neobligāts) Transliteration: Unicode rakstzīmju transliterācija iespējami atbilstošākajās GSM alfabēta rakstzīmēs. Noklusējumā iestatīta 0. Vairāk par transliterāciju.
(neobligāts) TransliterationFallback: Ja iespējota transliterācija (skatīt parametru Transliteration), tiek norādīts aizvietošanas simbols, kuru izmantot, lai aizvietotu Unicode simbolus, kuri nav atpazīti. Noklusējums ir " (tukša teksta virkne, kas nozīmē, ka neatpazītā rakstzīme ir vienkārši izņemta).
(neobligāts) ShortenLinks: Tiek iespējota, īsziņās ievietoto, saišu saīsināšana (0 = izslēgta, pēc noklusējuma, 1 = ieslēgta). Ja netiek aizpildīts ShortenLinksOverride parametrs, visas īsziņā iekļautās saites tiks automātiski atšķirtas no pārējā teksta un aizstātas ar to saīsinātām versijām. Saišu saīsināšana attiecas tikai uz to saturu, kas norādīts Content parametrā, taču nestrādās katram saņēmējam personalizētajā īsziņas saturā.
(neobligāts) ShortenLinksOverride: JSON masīvs, kurā ietvertas tās saites, kurām nepieciešama saīsināša. Noderīgi situācijās, kad nepieciešams īsināt tikai vienu no vairākām īsziņas saturā iekļautajām saitēm vai tad, kad satiēs izmantojiet nestandarta satura struktūru un automatizēta saišu apstrāde varētu nestrādāt. (Mūsu platfroma paredz visu veidu saišu apstrādi gadījumos kad saites ir formētas pareizi un tajās esošie speciālie simboli ir URL kodējumā. Ja saitēm nepielietojiet URL kodējumu un vēlaties, lai tās savā sākotnējā formā tiktu apstrādātas katra lietotāja pārlūkprogrammā, būs nepieciešams izmantot šo parametru.)

Atbildē tiks atgriezts JSON masīvs ar ierakstu par katru izsūtīto īsziņu, katram ierakstam saturot šādus parametrus:
ID: SMS ID, kuru jāizmanto piegādes atskaišu (delivery reports) saņemšanai.
CC: valsts kods.
Phone: saņēmēja tālruņa numurs bez valsts koda.
Content: izsūtītās īsziņas saturs.
Length: SMS garums (daļu skaits).
Unicode: Unicode kodējuma indikators (0 = sūtīšanā tiek izmantots GSM alfabēts, 1 = SMS tiek sūtīta UCS-2 kodējumā).
LongSMS: saliktās SMS indikators (0 = vienadaļīga SMS, 1 = SMS sastāv no vairākām daļām.)
Invalid: iemesls, kāpēc ziņojums var būt nederīgs.
Network: mobilais operators, kuram pieder numurs. Vairāk par to šī dokumenta beigās.
Validity: īsziņas derīguma termiņš minūtēs.
ShortenLinks: parāda vai saišu saīsināšana ir iespējota (0 = izslēgta, 1 = ieslēgta).

Gadījumā, ja bijusi problēma ar pieprasījumu, atbildē tiks atgriezts JSON masīvs ar šiem parametriem:
Error: kļūdas kods, ja bijusi vispārēja komandas izsaukuma kļūda. Ja kļūdu nav, šis parametrs tiks izlaists.

Iespējamās kļūdas:
InvalidRecipients: kļūdains saņēmēja numurs (viena saņēmēja gadījumā), vai nepareizi sastādīts masīvs, kas satur saņēmēju numurus.
InvalidSender: šāds sūtītāja vārds neeksistē vai nav pieejams.
InvalidCountryCode: kļūdains vai neatbalstīts valsts kods (ja kods ir norādīts).
ContentTooLong: garās īsziņas saturā ir vairāk par 7 daļām. Skatīt SMS saturs un garums.
QuotaExceeded: pārsniegts jūsu konta limits.
InvalidShortenLink: ShortenLinksOverride parametrā norādīta nederīga tīmekļa adrese.

GetSenders

Atgriež sarakstu ar visiem pieejamajiem sūtītāju vārdiem (vārdiskajiem numuriem), kuri piešķirti jūsu kontam.

Ievades parametri: nav

Atbildes parametri:
Senders: masīvs ar visiem piešķirtajiem sūtītāja identifikatoriem vai tukšs masīvs, ja sūtītāja ID nav piešķirts/-i.

GetDelivery

Atgriež viena vai vairāku ziņojumu piegādes atskaiti pēc to identifikatoru numuriem.

Ievades parametri:
ID: vienas īsziņas identifikators vai arī JSON masīvs ar vairākiem SMS identifikatoriem.

Atbilde satur:
asociatīvu masīvu, kurā atslēga ir SMS identifikators un vērtība ir īsziņas piegādes atskaite
vai
Error: kļūdas kods, ja bijusi vispārēja komandas izsaukuma kļūda.

Iespējamās kļūdas:
InvalidMessageID: kļūdaini norādīts vai arī nav norādīts SMS identifikators.

GetReport

Atgriež visus datus par vienu vai vairākām īsziņām pēc to identifikatoru numuriem.

Ievades parametri:
ID: Vienas īsziņas identifikators vai arī JSON masīvs ar vairākiem SMS identifikatoriem.

Atbilde satur asociatīvu masīvu, kur atslēga ir dotais SMS identifikators un vērtības, kas satur:
ID: SMS identifikators.
CC: numura valsts kods.
Phone: tālruņa numurs.
Content: SMS saturs.
Unicode: Unicode kodējuma indikators (0 = sūtīšanā tiek izmantots GSM alfabēts, 1 = SMS tiek sūtīta UCS-2 kodējumā).
LongSMS: saliktās SMS indikators (0 = vienadaļīga SMS, 1 = SMS sastāv no vairākām daļām.).
Length: SMS garums (daļu skaits).
Status: SMS piegādes statuss, viens no dokumentācijas beigās aprakstītajiem statusiem.
SendTime: nosūtīšanas laiks.
DLRTime: piegādes atskaites saņemšanas laiks. (Šis ir laiks, kad piegādes atskaite tika saņemta, nevis īsziņas piegādāšanas vai atteikšanas laiks).
Validity: SMS derīguma termiņš (minūtēs), t.i., laiks, pēc kura mobilais operators pārtrauc atkārtotu piegādi, ja tālruņa numurs ir derīgs, bet nav uzreiz sasniedzams. Pēc noklusējuma ir 1440 (24 stundas)
vai:
Error: kļūdas kods, ja bijusi vispārēja komandas izsaukuma kļūda.

Iespējamās kļūdas:
InvalidMessageID: kļūdaini norādīts vai arī nav norādīts SMS identifikators.

Ziņojuma satura variācijas

Izmantojot vienoto sūtīšans metodi Send, pastāv vairākas iespējas kā API pieprasījumos padot ziņojuma saturu.

Visvienkāršākais: viens ziņojums vienam numuram

Lai vienam numuram nosūtītu parastu īsziņu, parametrā Content ir jānorāda nepieciešamais ziņojuma saturs un parametram Recipients jāsatur saņēmēja tālruņa numurs vienkāršā teksta formā.

Identiski ziņojumi uz vairākiem numuriem

Lai nosūtītu vairākas identiskas īsziņas vairākiem saņēmējiem, parametrā Content norādiet vēlamo īsziņas saturu un parametrā Recipients ievietojiet JSON masīvu, kurā ir visi adresātu numuri, piemēram, ["37112345678", "37198765432"].

Ņemiet vērā, ka turpmāk minētie satura personalizēšanas paņēmieni neatbalsta saišu saīsināšanas funckionalitāti. Ja nepieciešams izmantot saišu saīsināšanu, tas būs iespējams tikai saturā, kurš ievietot Content parametrā. Tāpēc iespējamas situācijas, kad vienam saņēmējam nepieciešams veikt vairākus API pieprasījumus.

Dažādi ziņojumi vairākiem numuriem

Lai vienā pieprasījumā nosūtītu vairākus ziņojumus, jums būs jāizveido divdimensiju JSON masīvs parametram Recipients, kur katrs ieraksts ir masīvs, kas saturs attiecīgo saņēmēja numuru un tam paredzēto ziņojuma saturu.
Piemēram, šāds masīvs:

[
  ["37112345678", "Ziņojums viens"],
  ["37198765432", "Ziņojums divi"]
]

nosūtīs "Ziņojums viens" uz 37112345678 un "Ziņojums divi" uz 37198765432.
Ja kādam no ierakstiem nebūs definēts ziņojuma saturs, tiks izmantots Content parametrā norādītais teksts.

Personalizēts ziņojuma saturs vairākiem numuriem

Šī variācija, vienā pieprasījumā, ļauj nosūtīt personalizētās īsziņas vairākiem adresātiem, par pamatu ņemot kopīgo šablonu. Piemēram, ziņojuma tekstā iespējams norādīt vietturus [Vards] un [Laiks], kas parametrā Content tiek padoti šādi : "Labdien, [Vards]! Jūsu tikšanās ir ieplānota [Laiks]." un tiktu aizvietots ar vērtībām no saņēmēju (Recipient) masīva. Vietturu nosaukumiem obligāti jābūt kvadrātiekavās.

Lai iestatītu šīs mainīgās vērtības, nepieciešams izveidot līdzīgu masīvu, kā iepriekšējā variantā, taču tā vietā, lai kā otro masīva elementu izmantotu teksta virkni, jums nepieciešams ievietot asociatīvu masīvu ar atslēgām, kas atbilst vietturu nosaukumiem (bez kvadrātiekavām) un attiecīgajām vērtībām, kuras tiks ievietotas ziņojuma saturā. Dotajā piemērā ar "Vārds" un "Laiks" vietturiem tas izskatītos šādi:

[
  ["37112345678", {"Vards": "Andris", "Time": "9:50"}],
  ["37198765432", {"Vards": "Tonijs", "Laiks": "11:20"}]
]

Ņemiet vērā! Ja ziņojuma šablonam saturā (Content) ir vietturis, taču attiecīgā saņēmēja satura masīvā nav atbilstošas atslēgas, vietturis netiks aizstāts ar konkrēto vērtību un paliks redzams galējā īsziņas tekstā.

Kombinēti satura veidi

Visas iepriekš minētās pieejas ir iespējams apvienot un izmantot vienlaicīgi, taču pastāv lielāks risks saņemt nevēlamu rezultātu, tāpēc ieteicams to nedarīt. Šī sadaļa ir vairāk paredzēta kā ilustrācija tam, kā sistēma rīkotos ar dažādiem satura veidiem, lai palīdzētu jums dziļāk izprast šo procesu.

Izmantosim iepriekš doto satura šablona piemēru: "Sveiki, [Vārds]! Jūsu tikšanās ir ieplānota [Laiks]."

Saņēmēju (Recipient) masīvs:

[
  ["37100001111", {"Vārds": "Andris", "Laiks": "9:50"}],
  ["37100002222", {"Vārds": "Tonijs", "Laiks": "11:20"}],
  ["37100003333", "Jūsu tikšanās ir atcelta"],
  ["37100004444"],
  "37100005555", "37100006666"
]

Adresāti saņems šo saturu:

37100001111: Sveiki, Andri! Jūsu tikšanās ir paredzēta plkst. 9:50.
37100002222: Sveiki, Tonij! Jūsu tikšanās ir paredzēta plkst. 11:20.
37100003333: Jūsu tikšanās ir atcelta.
37100004444: Sveiki, [Vārds]! Jūsu tikšanās ir paredzēta [Laiks].
37100005555: Sveiki, [Vārds]! Jūsu tikšanās ir paredzēta [Laiks].
37100006666: Sveiki, [Vārds]! Jūsu tikšanās ir paredzēta [Laiks].

Ziņojuma satura transliterācija

Komandai Send ir pieejams, taču neobligāts transliterācijas (Transliteration) parametrs. kas sniedz indikāciju mūsu API par to, vai nepieciešams veikt Unicode rakstzīmju pārveidošanu uz tuvākajām GSM alfabēta vienībām. Piemēram, Ä par A, č par c, ñ kļūst par n utt.

Ņemiet vērā, ka transliterācija ir automatizēts process, un atsevišķās valodās var rasties neparedzēti rezultāti, piemēram, kad vārds radikāli maina savu nozīmi, ja tiek aizstāta viena vai vairākas diakritiskās zīmes.

Izmantojot TransliterationFallback parametru, jūs varat kontrolēt kā sistēmai apstrādāt nezināmās rakstzīmes. Pēc noklusējuma tās tiek noņemtas no ziņojuma satura, bet jums ir iespēja, kā aizstājēju, norādīt kaut ko citu, piemēram, jautājuma zīmi. Arī integrācijas testēšanas laikā ir noderīgi pārbaudīt, lai pārliecinātos, ka viss darbojas pareizi.

Nederīgi numuri

Komanda Send var atgriezt parametru Invalid, kas norāda iemeslu, kāpēc numurs ir nederīgs. Iemesli var būt:
Number: kļūdains numura formāts (piemēram, Latvijas numurs nesatur 8 ciparus).
CC: numurs satur neatļautu valsts kodu, piemēram, ja kontam ir atļauta sūtīšana uz Latvijas numuriem, numuri ar Lietuvas valsts kodu būs šādi.
MNP: numurs nav piešķirts nevienam zināmajam mobilajam operatoram.
ContentLength: īsziņām, kur saturs tiek individuāli norādīts katram saņēmējam, piemēram, sūtot ar SendMultiple, norādītais satura teksts tieši šim numuram ir pārāk garš.
Network: īsziņu sūtīšana uz tīklu, kam pieder numurs, nav iespējama. Piemēram, ja operators netiek atbalstīts vai operators nav spējīgs saņemt SMS.
Šīs īsziņas netiek ieskaitītas konta kopsummā un neietekmē konta atlikumu.

Operatoru kodi

Lai norādītu numura piederību mobilo sakaru operatoram, atbildēs uz padotajām īsziņām var tikt norādīts papildus parametrs Network, kas saturēs vienu no šiem kodiem:

Latvijā:
LMT: LMT
TELE2LV: Tele2 Latvija
BITELV: Bite Latvia

Igaunijā:
TELE2EE: Tele2 Eesti
EMT: Telia Eesti, agrāk EMT
ELISA: Elisa Eesti

Lietuvā:
TELE2LT: Tele2 Lietuva
OMNITEL: Telia Lietuva, agrāk Omnitel
BITELT: Bite Lietuva

Var rasties papildu tīkla kodi, un tie nākotnē var mainīties atkarībā no tīkla operatoriem. Tomēr šajās valstīs šie ir galvenie operatori, un tie nemainīsies.

Melnā saraksta pārvaldīšana

GetBlacklist

Atgriež melnā saraksta saturu (tālruņa numurus). Saturs tiek atgriezts lapās ar 10000 numuriem katrā, tāpēc jums būs jāveic vairāki pieprasījumi, ja jūsu melnais saraksts ir lielāks par šo.

Ievades parametri:
(neobligāts) Page: lapas numurs (vesels skaitlis).

Atbilde satur asociatīvu masīvu ar šādiem parametriem:
Page: rezultātu lapas numurs, tam ir jābūt tādam pašam kā API izsaukuma parametram, ja pieprasījumā norādījāt derīgu lapas numuru.
PageCount: kopējais melnā saraksta lapu skaits — varat to izmantot savā pieprasījuma cilpā, kad izgūstat pilnu melno sarakstu
Entries: melnā saraksta ierakstu masīvs. Katrs ieraksts ir masīvs, kas satur parametrus Number tālruņa numuram un Time, kas ir laiks, kad numurs tika pievienots melnajam sarakstam.
vai
Error: kļūdas kods, ja ir radusies problēma ar API izsaukumu.

Atbildes piemērs:

{
  "Page":0,
  "PageCount":1,
  "Entries":[
    {
      "Number":37100000000,
      "Time":"2023-09-12T15:07:47+00:00"
    }
  ]
}

Iespējamās kļūdas:
InvalidMessageID: kļūdains vai nenorādīts ziņojuma ID.

BlacklistAdd

Pievieno tālruņa numuru melnajam sarakstam

Ievades parametri:
Number: tālruņa numurs, kas jāpievieno
(neobligāts) Sender: sūtītāja ID, lai ierobežotu ierakstu melnajā sarakstā. Ja tā nav, melnā saraksta ieraksts ar šo tālruņa numuru neļaus sūtīt ziņojumus ar jebkuru no jūsu kontā esošajiem sūtītāja ID. Ja tas ir norādīts, tad norādītais tālruņa numurs nesaņems ziņas tikai no šī sūtītāja ID, bet turpinās tos saņemt no jebkura cita sūtītāja ID.

Atbilde satur asociatīvu masīvu ar šādiem parametriem:
OK: ir vienāds ar 1 no pieprasījuma, kas bija veiksmīgs
vai
Error: kļūdas kods, ja ir radusies problēma ar API izsaukumu.

Iespējamās kļūdas:
NoPhone: tālruņa numurs netika norādīts
InvalidPhone: norādītais tālruņa numurs nebija derīgs
InvalidSender: norādīts nederīgs sūtītāja ID (sūtītāja ID jūsu kontam nav pieejams)
CannotAddToBlacklist: numuru nevar pievienot melnajam sarakstam.

BlacklistDelete

Dzēš norādīto tālruņa numuru no melnā saraksta, ja tāds ir.

Ievades parametri:
Number: tālruņa numurs, kas jāpievieno

Atbilde satur asociatīvu masīvu ar šādiem parametriem:
OK: ir vienāds ar 1 no pieprasījuma, kas bija veiksmīgs
vai
Error: kļūdas kods, ja ir radusies problēma ar API izsaukumu.

Lietošanas piemēri

API izsaukumu piemēri, dažādās valodās un izmantojot dažādas tehnoloģijas ir norādīti atsevišķā rakstā:
API pieprasījumi izmantojot cURL

Atjaunināts: 01/03/2024