REST API dokumentācija
Tālruņa numuru REST API
Atrodiet pieejamās valstis un numurus, pārskatiet pilnu piedāvājumu un pārvaldiet jums piederošos numurus.
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.
Nolasiet pieejamo valstu katalogu
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getcountries"v3 atbilde satur status un response masīvu. Valstu ieraksti ietver isocode, name, countrycode, iespēju informāciju un next_function. Pieejamība ir atkarīga no konta un krājumiem; valsts nenozīmē solījumu, ka katrs prefikss vai numura veids ir noliktavā.
{
"status": {
"code": 200,
"msg": "Results: 1"
},
"response": [
{
"countrycode": "1",
"name": "United States",
"description": "United States",
"isocode": "US",
"is_mobile": 0,
"sms_coverage": 1,
"latitude": "37.0902",
"longitude": "-95.7129",
"next_function": "v3/getareas/US"
}
]
}No atklāšanas līdz aktivizēšanai
- Izvēlieties valsti, nepieciešamības gadījumā administratīvo vienību, apgabalu un numura veidu, izmantojot atbilstošās ģeogrāfijas darbības.
- Nolasiet izvēlētā numura uzstādīšanas, ikmēneša un lietojuma cenas, kanālus, pieļaujamo apjomu un reģistrācijas prasības.
- Iesniedziet nepieciešamos galalietotāja dokumentus un pārskatiet to statusu. Numurs var palikt gaidīšanas stāvoklī līdz apstiprinājumam.
- Pasūtiet vienu reizi ar precīzu krājumu/cenu atlasi. Ja atbilde ir nenoteikta, pirms cita pasūtījuma iesniegšanas pārbaudiet savu krājumu.
- Konfigurējiet balss maršrutēšanu un ziņojumu piegādi neatkarīgi, pēc tam pārbaudiet pilnu paredzēto maršrutu.
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.