Izstrādātājiem

POST/v3/number_identity/{number}

Iesniegt numura reģistrācijas profilu

Piesaistiet saglabāto reģistrācijas profilu iegādātam numuram un, ja tas tiek atbalstīts, pieprasiet operatora pārbaudi.

Šajā lapā
  1. Sagatavojiet saglabāto profilu un numuru
  2. Iesniedziet piesaistes pieprasījumu
  3. Atšķiriet piesaisti no apstiprināšanas
  4. Apstrādājiet kļūdas, neizveidojot uzdevumu dublikātus
  5. Vienreizējo dokumentu ierobežojums
  6. Aizsargājiet reģistrācijas informāciju

Sagatavojiet saglabāto profilu un numuru

Izmantojiet šo darbplūsmu, lai piesaistītu saglabātu reģistrācijas profilu iegādātam numuram un atbalstītajiem operatora nodrošinātajiem numuriem pieprasītu reģistrācijas pārbaudi. Tā nav universāla aktivizācijas API visiem numuru nodrošinātājiem. Veiksmīgs pieprasījums nepierāda, ka dokumenti ir apstiprināti vai numurs ir aktīvs.

Izmantojiet iespējotu MultiTEL API kontu, pieslēdzoties ar HTTPS un izmantojot kontam konfigurētos akreditācijas datus un IP ierobežojumus. Gan neizdzēstajam profilam, gan iegādātajam, neanulētajam numuram jāpieder jūsu kontam.

  1. Izveidojiet reģistrācijas profilu vai atlasiet esošu. Saglabājiet lokālā profila uuid, ko atgriež create_document; get_document atgriež to pašu lokālo atsauci laukā id.
  2. Lai iesniegtu datus operatoram, profilā jābūt saglabātām identitātes un adreses atsaucēm. Pievienojiet nepieciešamos apliecinājumus un papildu dokumentus pirms iesniegšanas, izmantojot tiem paredzētās darbplūsmas.
  3. Pārbaudiet, vai numurs un profils atbilst attiecīgās valsts un numura prasībām. Nepieņemiet, ka saglabāts profils ir apstiprināts visiem numuriem.

Iesniedziet piesaistes pieprasījumu

curl --silent --show-error --request POST \
  --user "$API_USER:$API_PASSWORD" \
  --form-string document_uuid="$PROFILE_UUID" \
  --form-string service_description="Example customer support line" \
  https://api.multitel.net/v3/number_identity/12125550123

Ceļā norāda iegādāto tālruņa numuru, nevis tā UUID, PBX iekšējo numuru vai identitātes ID. Apstrādes funkcija no numura noņem visas rakstzīmes, kas nav cipari. Izmantojiet pilnu starptautisko numuru ar valsts kodu. Piemērs ir izdomāts, un tajā norādītie dati jāaizstāj ar savu numuru un saglabātā lokālā profila atsauci.

Reģistrācijas iesniegšanas lauki
LauksObligātsNozīme
document_uuidJāPrecīzs saglabātā lokālā profila uuid. Tā vietā neizmantojiet maskēto attālo identity_id, address_id, augšupielādes ID vai atgriezto registration_details_id vērtību.
service_descriptionNēParedzētā pakalpojuma apraksts, kas tiek pārsūtīts operatora veiktai pārbaudei. Atstarpes sākumā un beigās tiek noņemtas.
onetime_filesAtkarīgs no darbplūsmasMasīvs operatoram paredzētiem vienreizējiem dokumentiem. Pašreizējā apstrādes funkcija no masīva virknēm noņem atstarpes sākumā un beigās un pārsūta tās, neatrisinot lokālās augšupielādes atsauces. Saderība ar maskētajiem ID, ko atgriež create_encrypt_files, nav noskaidrota; pirms šī lauka izmantošanas skatiet tālāk aprakstīto vienreizējo dokumentu ierobežojumu.

Vairākdaļu pieprasījumos masīvu norāda ar atkārtotiem onetime_files[] laukiem. Tiek pieņemts arī JSON pieprasījums ar Content-Type: application/json; tā rekvizīti tiek apvienoti ar veidlapas datiem. Ja ceļā numurs nav norādīts, pieprasījuma datos var norādīt lauku number. Lai izvairītos no neskaidrībām, ieteicams izmantot iepriekš parādīto skaidri norādīto ceļu.

Atšķiriet piesaisti no apstiprināšanas

Izlasiet gan HTTP rezultātu, gan JSON lauku status.code. JSON kļūdas var tikt saņemtas ar HTTP 200. Veiksmīga pieprasījuma gadījumā operatora nodrošinātā darbplūsma atgriež ziņojumu Address verification task created; awaiting carrier review. Šajā piemērā izmantotas izdomātas atsauces.

{
  "status": {
    "code": 200,
    "msg": "Address verification task created; awaiting carrier review."
  },
  "response": {
    "number": "+12125550123",
    "did_id": "11111111111111111111111111111111",
    "document_uuid": "0123456789abcdef0123456789abcdef",
    "identity_id": "22222222222222222222222222222222",
    "address_id": "33333333333333333333333333333333",
    "address_verification_id": "44444444444444444444444444444444",
    "verification_status": "pending",
    "verification_reference": null,
    "requirement_id": "55555555555555555555555555555555",
    "registration_details_id": "8516ac99dc60603295de7bdb6a153530"
  }
}

Ar pakalpojuma sniedzēju saistītie identifikatori ir maskētas atsauces, nevis savstarpēji aizstājami lokālo profilu ID. document_uuid joprojām ir jūsu iesniegtā lokālā profila atsauce. Šīs apstrādes funkcijas operatoram paredzētajā izpildes zarā registration_details_id ir šīs lokālās atsauces papildu jaucējvērtība; turpmākajos profila vai iesniegšanas pieprasījumos neaizstājiet document_uuid ar šo vērtību.

Dažiem piešķirtajiem numuriem tiek izmantota lokāla identitātes piesaiste, nevis izveidota operatora pārbaude. Veiksmīgais rezultāts ir Identity associated. ar tukšu response masīvu. Tas neizveido operatora pārbaudes uzdevumu un neapliecina apstiprinājumu. Portālā ir jaunāka piesaistes darbplūsma, kuras darbības ar pakalpojuma sniedzējiem un atkārtotas iesniegšanas pārbaudes atšķiras no šī galapunkta.

Apstrādājiet kļūdas, neizveidojot uzdevumu dublikātus

API kods 400 attiecas uz trūkstošu numuru vai profila atsauci. Kods 404 attiecas uz kontam nepieejamu profilu vai numuru vai numuru, kura nav operatora numuru krājumā. Kods 422 var norādīt uz trūkstošām identitātes vai adreses atsaucēm, pārdevēja prasībām vai operatora validācijas noraidījumu. Trūkstoša atzvana konfigurācija var izraisīt kodu 503, savukārt datu pārraides kļūme izveides laikā var izraisīt kodu 502. Izlasiet ziņojumu un visus requirement_diagnostics datus, nevis uztveriet visas kļūmes vienādi.

Operatoram paredzētais izpildes zars var atjaunināt lokālās gaidošas reģistrācijas pazīmes, pirms ir pabeigta prasību validācija, atzvana konfigurācijas pārbaudes vai uzdevuma izveide. Tāpēc kļūda nenozīmē, ka lokālais stāvoklis nav mainījies, un gaidīšanas pazīme pati par sevi nepierāda, ka uzdevums pastāv. Neizmantojiet šīs pazīmes kā apstiprinājumu, ka pieprasījums ir apstiprināts vai piegādāts.

Pakalpojuma sniedzējs var pieņemt uzdevumu pat tad, ja vēlāk neizdodas lokālās datubāzes darbība, un šī palīgfunkcija pirms ziņošanas par panākumiem nepārbauda katras lokālās ierakstīšanas rezultātu. Šajā apstrādes funkcijā nav klienta idempotences parametra vai aizsardzības pret atkārtotu iesniegšanu. Pēc taimauta, kļūdas vai neskaidra rezultāta pārbaudiet numura reģistrācijas vēsturi portālā vai pirms atkārtotas iesniegšanas sazinieties ar atbalsta dienestu. Lokāla ieraksta neesamība pati par sevi nepierāda, ka pakalpojuma sniedzējs neko nav saņēmis.

Vienreizējo dokumentu ierobežojums

Apstrādes funkcija pieņem onetime_files un pārsūta katru netukšo virkni uz operatora šifrēto failu saistību. Tā nemeklē augšupielāžu ierakstus kontā, kuram tās pieder, un nepārveido ārējos maskētos augšupielāžu ID par pakalpojuma sniedzēja failu ID. Bezsaistes auditā tika pārbaudīta pārsūtīšanas darbība, nevis veiksmīga failu pievienošana operatora pusē.

Nepieņemiet, ka faila ID, ko atgriež create_encrypt_files, var iekopēt šajā laukā, lai pabeigtu vienreizējas vienošanās darbplūsmu. Ja numuram ir nepieciešami šie dokumenti, izmantojiet portālu vai noskaidrojiet pie MultiTEL, kāda identifikatoru darbplūsma tiek atbalstīta. Šī joprojām ir neatrisināta API pārbaudes daļa, nevis pārbaudīts piemērs visam procesam no sākuma līdz beigām.

Aizsargājiet reģistrācijas informāciju

Iesniedziet tikai informāciju un dokumentus, ko esat tiesīgs izmantot attiecīgajam numuram. Nodrošiniet, lai profila un pārbaudes atsauces būtu piesaistītas pareizajam kontam, un izvairieties no pilnu reģistrācijas pieprasījumu datu ierakstīšanas žurnālos. Šis pieprasījums neizdzēš un neaizstāj visus iepriekšējos apliecinājumus vai pārbaudes. Operatora pārbaude, aktivizācija un datu glabāšana ir atsevišķi procesi.