Iesniegt ierakstu operatora uzziņu katalogam
Iesniedziet vārdu vai nosaukumu un adresi, ko izmantot uzziņu kataloga ierakstā piemērotam tālruņa numuram, kas jums pieder MultiTEL sistēmā. Tas ir maksas atjauninājums operatora sistēmā, nevis zvanītāja vārda uzmeklēšana, privātas adrešu grāmatas ieraksts vai portāla numuru saraksta lauka LIDB vispārīga atjaunināšana.
Iesniedziet tikai tos datus, kuru iekļaušanu uzziņu katalogā klients ir atļāvis. Pirms šī mantotā maršruta izmantošanas pārliecinieties, ka operators atbalsta attiecīgo numuru. Pārskatītais apstrādātājs nepārbauda pakalpojuma sniedzēja piemērotību vai numura starptautisko formātu; tā pieprasījums operatoram pieņem, ka tas ir Ziemeļamerikas numurs, un noņem pirmo saglabāto ciparu.
Prasības kontam un numuram
Izmantojiet iespējotu API kontu, pieslēdzoties ar HTTPS no atļautas avota IP adreses. Precīzajam numuram jāatbilst neatceltam iegādāta numura ierakstam, kas pieder šim kontam. Izmantojiet pilnu starptautisko ciparu virkni no sava numuru saraksta, piemēram, atbalstītam Ziemeļamerikas numuram izmantojiet formātu ar valsts kodu 1. Neizmantojiet tarifu plāna ID, numura UUID vai citam kontam piederošu numuru.
Veidlapas POST pieprasījums
Iestatiet NUMBER uz jums piederošo numuru. Aizstājiet izdomāto piemēru ar apstiprinātajiem uzziņu kataloga ieraksta datiem. Šis maršruts nolasa veidlapas laukus no POST pieprasījuma; tas neparsē application/json pamatdaļu.
curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--data-urlencode "lastname=EXAMPLE" \
--data-urlencode "firstname=EXAMPLE" \
--data-urlencode "streetnum=1" \
--data-urlencode "streetname=Example" \
--data-urlencode "streetpredir=N" \
--data-urlencode "streetpostdir=W" \
--data-urlencode "city=Example City" \
--data-urlencode "state=NY" \
--data-urlencode "postalcode=10001" \
"https://api.multitel.net/v3/directory/$NUMBER"| Lauks | Obligāts šajā API | Nozīme |
|---|---|---|
| lastname | Jā | Uzziņu kataloga ieraksta uzvārds vai attiecīgais ieraksta nosaukuma lauks. |
| city | Jā | Uzziņu kataloga ierakstā norādāmā pilsēta. |
| postalcode | Jā | Uzziņu kataloga ierakstā norādāmais pasta indekss. |
| state | Jā | Uzziņu kataloga ierakstā norādāmais štats vai reģions, ko pieņem atbalstītais operators. |
| streetname | Jā | Ielas nosaukums. |
| streetnum | Jā | Mājas numurs. |
| firstname | Nē | Papildu personvārda daļa. |
| streetpredir, streetpostdir | Nē | Debespuses norādes pirms un pēc ielas nosaukuma, ja tās ir piemērojamas. |
| streettype, location | Nē | Ielas veids vai papildu atrašanās vietas apraksts, ja tas ir piemērojams. |
Piemērā norādītās debespuses un adrese ir vietturi, nevis ieteicama pasta adrese. Nepievienojiet izdomātu debespuses norādi īstajiem klienta datiem. API obligāto lauku pārbaudes ir virspusējas: tās neapstiprina, ka adrese ir derīga vai operators to pieņem, un mantotajā tīmekļvietnē veidlapai bija citas prasības.
Ja neobligātā debespuses norāde nav norādīta vai ir tukša, realizācija var izvadīt brīdinājumu par trūkstošu masīva atslēgu. Ja atbilde ir nepareizi formatēta vai operators noraida adresi, saglabājiet pieprasījuma atsauci un lūdziet atbalsta dienestam apstiprināt ierakstu, nevis atkārtoti iesniedziet uz minējumiem balstītas adreses izmaiņas.
Maksas ieturēšana un atkārtota iesniegšana
Pārskatītais apstrādātājs pārbauda, vai konta atlikumā ir vismaz 10.00 konta atlikuma vienības pirms sazināšanās ar operatoru. Kad gan operators, gan numura lokālā atjaunināšana ziņo par sekmīgu izpildi, tas ietur 10.00 no konta atlikuma un reģistrē uzziņu kataloga ieraksta izveides darījumu. Šīs ir pašlaik sistēmā ieviestās summas, nevis jauns cenu piedāvājums; pirms iesniegšanas pārbaudiet piemērojamo norēķinu valūtu un atbalstīto pakalpojumu sava konta noteikumos.
Operācijai nav idempotences atslēgas, aizsardzības pret pasūtījumu dublēšanu vai vienota transakcijas ietvara iesniegšanai operatoram, lokālajai atjaunināšanai un norēķiniem. Sekmīgs atkārtots pieprasījums var izraisīt vēl vienu iesniegšanu operatoram un vēl vienu maksas ieturēšanu. Taimauts vai API kļūda nepierāda, ka operators ir noraidījis iepriekšējo pieprasījumu: pakalpojuma sniedzējs to var būt pieņēmis, pirms lokālā atjaunināšana neizdevās.
Atbilde
{
"status": {
"code": 200,
"msg": "Success"
},
"response": ""
}Parastā sekmīgas izpildes atbildē tukša virkne ir lauka response vērtība, un netiek atgriezts ieraksta ID vai informācija par pabeigšanu. Tas nozīmē, ka operatora un lokālās atjaunināšanas apstrādes ceļi ziņoja par sekmīgu izpildi; tas nepierāda publicēšanu visos ārējos uzziņu katalogos, tūlītēju izplatīšanu vai turpmāku zvanītāja identifikācijas rādīšanu.
Mantotās sistēmas kļūdas
| API kods | Nozīme |
|---|---|
| 404 | Numurs kontā netika atrasts vai kāds no obligātajiem veidlapas laukiem bija tukšs. |
| 400 | Konta atlikums ir mazāks par sistēmā ieviesto maksu. |
| 500 | Pieprasījums operatoram neizdevās vai lokālā atjaunināšana neizdevās pēc tam, kad operators, iespējams, jau bija pieņēmis pieprasījumu. |
| 200 | Ziņots par sekmīgu izpildi; atbilde nesatur publicēšanas apstiprinājumu. |
Pārbaudiet gan HTTP statusu, gan JSON laukus status.code/status.msg. Arī autentifikācija un avota IP ierobežojumi var liegt saņemt izmantojamu atbildi. Neizmantojiet GET vai vaicājuma parametrus, lai pieprasītu atjaunināšanu, tikai tāpēc, ka mantotajam apstrādātājam nav tiešas HTTP metodes pārbaudes.
Pārbaudiet pirms atkārtotas iesniegšanas
- Pirms pieprasījuma nosūtīšanas pārbaudiet jums piederošo numuru, operatora piemērotību, apstiprinātos uzziņu kataloga ieraksta datus un maksu.
- Iesniedziet vienu reizi un saglabājiet kontā saņemto rezultātu, neatklājot klienta adresi publiskos žurnālos vai analītikas datos.
- Pārbaudiet saglabāto ierakstu un darījumu vēsturi, izmantojot atbalstīto konta darbplūsmu vai atbalsta dienestu. Nogaidiet operatora apstiprināto apstrādes laiku; šis API nenosaka garantētu datu izplatīšanas termiņu.
- Ja rezultāts ir neskaidrs, pirms atkārtota mēģinājuma lūdziet atbalsta dienestam salīdzināt un saskaņot operatora pasūtījumu ar lokālajiem norēķiniem. Atkārtots pieprasījums nav idempotenta statusa pārbaude.