Toegang tot die rekening en projek
Gebruik 'n geaktiveerde API-rekening oor HTTPS vanaf 'n toegelate IP-adres. Die projek moet aan daardie rekening behoort en mag nie geskrap wees nie. Gebruik die projek se unieke identifiseerder uit die werkvloei vir nommeroordragbestellings, nie die numeriese databasisidentifiseerder of 'n telefoonnommer nie. Pas URL-kodering op die projekidentifiseerder toe wanneer jy 'n versoek saamstel.
Berei die byvoeging voor
Hierdie bewerking verander 'n bestaande nommeroordragprojek. Bevestig eers die nommers en die kliënt se magtiging deur jou werkvloei vir nommeroordragbestellings. Skryf elke nommer as die volledige internasionale syferreeks, verwyder self duplikate en kontroleer die projek se bestaande nommerlys. Moenie hierdie eindpunt gebruik om willekeurige nommers te toets nie.
Die huidige portaal valideer en normaliseer nommers voordat dit hierdie roete aanroep. Die onverwerkte verouderde eindpunt bied nie dieselfde voorsorgmaatreëls nie: dit verwyder spasies aan die begin en einde van invoer, maar kontroleer nie die telefoonnommerformaat, landkode, duplikate of die projek se werkvloeistatus nie.
POST-versoek
Skep 'n plaaslike numbers.json met die volgende struktuur. Die nommers is denkbeeldig; vervang hulle met gemagtigde nommers vir die gekose projek.
{
"numbers": [
"12025550123",
"12025550124"
],
"isocode": "US"
}curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
--header "Content-Type: application/json" \
--data-binary @numbers.json \
"https://api.multitel.net/v3/lnp/project/$PROJECT_ID/addnumbers"| Veld | Betekenis |
|---|---|
| numbers | 'n Vereiste, nieleë skikking van nommers as stringe, of 'n string met een nommer per reël. Leë inskrywings word weggegooi en spasies aan die begin en einde word verwyder. Kommageskeide teks word nie in afsonderlike nommers verdeel nie. |
| isocode | 'n Opsionele landkode vir die bygevoegde rye. As dit weggelaat word of leeg is, word die projekligging gebruik. Die hanteerder verwyder spasies aan die begin en einde van 'n verskafte waarde, maar skakel dit nie na hoofletters om of valideer dit nie. Verskaf self die korrekte landkode in hoofletters. |
Gebruik POST met application/json vir hierdie voorbeeld. Vorminvoer via POST word ook gelees. Die metode definieer nie 'n idempotensiesleutel of 'n eindpuntspesifieke waarborg vir 'n veilige bondelgrootte nie; vergelyk en kontroleer die resultate van hanteerbare bondels eerder as om op 'n geraaide limiet staat te maak.
Gerapporteerde resultaat
Denkbeeldige voorbeeld van 'n antwoord.
{
"status": {
"code": 200,
"msg": "Success add numbers"
},
"response": {
"uniqueid": "PROJECT_EXAMPLE",
"count": 2,
"numbers": [
{
"id": 21,
"number": "12025550123",
"status": 0,
"status_str": "Pending",
"isocode": "US"
},
{
"id": 22,
"number": "12025550124",
"status": 0,
"status_str": "Pending",
"isocode": "US"
}
]
}
}Die antwoord merk byvoegings wat gepoog is as Pending. Dit verifieer nie die resultaat van elke databasisinvoeging voordat dit daaroor rapporteer nie. 'n Telling of teruggestuurde identifiseerder alleen is dus nie bewys dat elke ry gestoor is nie. 'n Byvoeging met die status Pending beteken nie aanvaarding deur die operateur, 'n geskeduleerde oordrag of voltooide aktivering nie.
Kontroleer die gegewens voordat jy weer probeer
- Lees die projek se nommerlys voordat jy nommers byvoeg en bewaar die beoogde byvoeging in jou eie versoekrekords.
- Stuur die byvoeging een keer.
- Lees die projek se nommerlys weer en vergelyk elke beoogde nommer. Kontroleer vir duplikate en gaan elke nommer se status na.
- As die versoek se wagtyd verstryk, dit 'n fout terugstuur of 'n dubbelsinnige resultaat rapporteer, lees die gegewens terug voordat jy weer probeer. Sommige byvoegings kan reeds bestaan.
- Los ontbrekende of gedupliseerde rye deur die werkvloei vir nommeroordragbestellings of met hulp van ondersteuning op, eerder as om die volledige versoek blindelings te herhaal.
Die hanteerder voeg inskrywings een op 'n slag in, sonder 'n transaksie of beskerming teen duplikate. 'n Onderbreking kan vroeëre skryfbewerkings behoue laat; 'n mislukte invoeging wat false terugstuur, kan steeds by die gerapporteerde telling ingesluit word. Die herhaling van 'n versoek kan duplikaatrye byvoeg. Die hanteerder teken nie self 'n gebeurtenis aan of voltooi 'n oordrag deur die operateur nie.
Foute van die verouderde stelsel
'n Ander metode as POST stuur API-kode 403 terug. 'n Projek wat ontbreek, geskrap is of nie aan die rekening behoort nie, stuur API-kode 404 terug. Leë nommerinvoer stuur ook API-kode 404 terug. Verifikasie en beperkings op die bron-IP-adres geld. Hierdie kodes van die verouderde stelsel bewys nie dat geen vroeëre invoeging plaasgevind het nadat verwerking begin het nie.
Omvang van fakturering en oordrag
Die hanteerder wat nagegaan is, voeg rye vir projeknommers in en bevat geen direkte rekeningdebitering of indiening by 'n operateur nie. Dit maak nie die algehele nommeroordragdiens gratis of stel ooreengekome nommeroordragfooie tersyde nie. Voldoen aan die projek se vereistes vir magtiging, dokumente en hersiening voordat jy 'n oordrag verwag.