Fejlesztők

POST/v3/lnp/project/{uniqueid}/addnumbers

Számok hozzáadása meglévő számhordozási projekthez

Adjon hozzá számsorokat, majd egy bizonytalan kimenetelű kérés újrapróbálása előtt egyeztesse a projekt adatait.

Ezen az oldalon
  1. Hozzáférés a fiókhoz és a projekthez
  2. A hozzáadás előkészítése
  3. POST-kérés
  4. Jelentett eredmény
  5. Egyeztetés újrapróbálás előtt
  6. A régi végpont hibái
  7. A számlázás és a számhordozás hatóköre

Hozzáférés a fiókhoz és a projekthez

Használjon engedélyezett API-fiókot HTTPS-kapcsolaton keresztül, engedélyezett IP-címről. A projektnek ehhez a fiókhoz kell tartoznia, és nem lehet törölt. A számhordozási megrendelés munkafolyamatából származó egyedi projektazonosítót használja, ne a projekt numerikus adatbázis-azonosítóját vagy egy telefonszámot. A kérés összeállításakor alkalmazzon URL-kódolást a projektazonosítóra.

A hozzáadás előkészítése

Ez a művelet egy meglévő számhordozási projektet módosít. Először a számhordozási megrendelés munkafolyamatában erősítse meg a számokat és az ügyfél felhatalmazását. Minden számot teljes nemzetközi formátumban, kizárólag számjegyekkel adjon meg, távolítsa el saját maga az ismétlődéseket, és ellenőrizze a projekt meglévő számlistáját. Ne használja ezt a végpontot tetszőleges számok tesztelésére.

A jelenlegi portál az útvonal meghívása előtt ellenőrzi és egységes formátumra hozza a számokat. A közvetlenül elért régi végpont nem biztosítja ugyanezeket a védelmeket: eltávolítja a bemenet eleji és végi szóközöket, de nem ellenőrzi a telefonszám formátumát, az országkódot, az ismétlődéseket vagy a projekt munkafolyamatbeli állapotát.

POST-kérés

Hozzon létre egy helyi numbers.json fájlt az alábbi szerkezettel. A számok kitaláltak; cserélje le őket a kiválasztott projekthez engedélyezett számokra.

{
  "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"
A számhozzáadási kérés mezői
MezőJelentés
numbersKötelező, nem üres tömb, amely a számokat karakterláncként tartalmazza, vagy egy karakterlánc, amelyben minden szám külön sorban szerepel. Az üres bejegyzéseket a rendszer elhagyja, az eleji és végi szóközöket eltávolítja. A vesszővel elválasztott szöveget nem bontja külön számokra.
isocodeA hozzáadott sorokhoz tartozó opcionális országkód. Ha nincs megadva vagy üres, a rendszer a projekt helyét használja. A kezelő eltávolítja a megadott érték eleji és végi szóközeit, de nem alakítja nagybetűssé és nem ellenőrzi az értéket. A helyes, nagybetűs országkódot Önnek kell megadnia.

Ebben a példában használja a POST metódust application/json tartalomtípussal. A rendszer az űrlapként küldött POST-bemenetet is beolvassa. A metódus nem határoz meg idempotenciakulcsot vagy a végpontra vonatkozó, garantáltan biztonságos kötegméretet; becsült korlát helyett kezelhető méretű kötegek adatait egyeztesse.

Jelentett eredmény

Kitalált válaszpélda.

{
  "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"
      }
    ]
  }
}

A válasz a megkísérelt hozzáadásokat Pending állapotúnak jelöli. Az eredmény jelentése előtt nem ellenőrzi az egyes adatbázis-beszúrások sikerességét. Ezért önmagában egy darabszám vagy visszaadott azonosító nem bizonyítja, hogy minden sor tartósan mentésre került. A Pending állapotú hozzáadás nem jelent szolgáltatói elfogadást, ütemezett számhordozást vagy befejezett aktiválást.

Egyeztetés újrapróbálás előtt

  1. A számok hozzáadása előtt kérje le a projekt számlistáját, és saját kérésnyilvántartásában őrizze meg a tervezett hozzáadás adatait.
  2. A hozzáadási kérést egyszer küldje el.
  3. Kérje le újra a projekt számlistáját, és hasonlítsa össze az összes hozzáadni kívánt számot. Ellenőrizze az ismétlődéseket és az egyes számok állapotát.
  4. Ha a kérés túllépi az időkorlátot, hibát ad vissza vagy bizonytalan eredményt jelez, az újrapróbálás előtt kérje le az aktuális adatokat. Előfordulhat, hogy egyes hozzáadások már megtörténtek.
  5. A hiányzó vagy ismétlődő sorokat a számhordozási megrendelés munkafolyamatán vagy az ügyfélszolgálaton keresztül rendezze, ahelyett hogy ellenőrzés nélkül megismételné a teljes kérést.

A kezelő egyenként szúrja be a bejegyzéseket, tranzakció és az ismétlődések elleni védelem nélkül. Megszakítás esetén a korábbi írások megmaradhatnak; egy false értékkel visszatérő sikertelen beszúrás is beleszámíthat a jelentett darabszámba. A kérés megismétlése ismétlődő sorokat hozhat létre. A kezelő önmagában nem rögzít eseményt, és nem hajt végre szolgáltatók közötti számhordozást.

A régi végpont hibái

A POST metódustól eltérő metódus 403-as API-kódot ad vissza. A hiányzó, törölt vagy nem a fiókhoz tartozó projekt 404-es API-kódot eredményez. Üres számbemenet esetén szintén 404-es API-kód a válasz. A hitelesítési követelmények és a forrás-IP-címre vonatkozó korlátozások érvényesek. Ezek a régi kódok nem bizonyítják, hogy a feldolgozás megkezdése után nem történt már korábban beszúrás.

A számlázás és a számhordozás hatóköre

A felülvizsgált kezelő a projekthez tartozó számsorokat szúr be, és nem tartalmaz közvetlen számlaterhelést vagy szolgáltatóhoz történő benyújtást. Ettől a teljes számhordozási szolgáltatás nem válik ingyenessé, és a megállapodás szerinti számhordozási díjak sem vesztik érvényüket. A számhordozásra csak a projekt felhatalmazási, dokumentációs és felülvizsgálati követelményeinek teljesítése után számítson.