Подгответе запазения профил и номера
Използвайте този процес, за да свържете запазен регистрационен профил със закупен номер и, за поддържаните номера с регистрация чрез оператор, да поискате преглед на регистрацията. Това не е универсален API за активиране на номера от всеки доставчик. Успешната заявка не доказва, че документите са одобрени или че номерът е активен.
Използвайте активиран MultiTEL API акаунт през HTTPS с конфигурираните за него идентификационни данни и IP ограничения. Както неизтритият профил, така и закупеният номер, който не е анулиран, трябва да принадлежат на вашия акаунт.
- Създайте регистрационен профил или изберете съществуващ. Запазете локалния uuid на профила от create_document; get_document връща същата локална референция като id.
- За подаване чрез оператор профилът трябва да съдържа запазените референции към самоличността и адреса. Преди подаването прикачете необходимите доказателства и съпътстващи документи чрез съответните процеси.
- Проверете дали номерът и профилът отговарят на приложимите изисквания за държавата и номера. Не приемайте, че запазен профил е одобрен за всеки номер.
Подайте заявката за свързване
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Пътят съдържа закупения телефонен номер, а не неговия UUID, вътрешен номер на PBX централа или идентификатор на самоличност. Обработчикът премахва от номера всички знаци, които не са цифри. Използвайте пълния международен номер с кода на държавата. Примерът е измислен и трябва да бъде заменен с вашия номер и запазената локална референция на профила.
| Поле | Задължително | Значение |
|---|---|---|
document_uuid | Да | Точният запазен локален uuid на профила. Не го заменяйте с маскирания отдалечен identity_id, address_id, идентификатор на качване или върната стойност на registration_details_id. |
service_description | Не | Описание на предвидената услуга, което се препраща за проверка чрез оператор. Интервалите в началото и края се премахват. |
onetime_files | Зависи от процеса | Масив, който се приема за документи за еднократна употреба при оператора. Текущият обработчик премахва интервалите в началото и края на низовете му и ги препраща, без да разрешава локалните референции към качени файлове. Съвместимостта с маскираните идентификатори, връщани от create_encrypt_files, не е установена; преди да използвате това поле, вижте ограничението за документите за еднократна употреба по-долу. |
При заявки от няколко части масивът използва повтарящи се полета onetime_files[]. Приема се и JSON заявка с Content-Type: application/json; свойствата ѝ се сливат с данните на формуляра. Полето number може да бъде подадено в тялото на заявката, когато номерът е пропуснат в пътя. За да избегнете двусмислие, предпочитайте изрично посочения по-горе път.
Разграничавайте свързването от одобрението
Прочетете както HTTP резултата, така и JSON полето status.code. JSON грешки могат да пристигнат с HTTP 200. Успешно подаване чрез оператор връща съобщението Address verification task created; awaiting carrier review. Този пример използва измислени референции.
{
"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"
}
}Идентификаторите, свързани с доставчика, са маскирани референции, а не взаимозаменяеми локални идентификатори на профили. document_uuid остава локалната референция на профила, която сте подали. В клона на този обработчик за подаване чрез оператор registration_details_id е допълнителен хеш на тази локална референция; не заменяйте document_uuid с него в последващи заявки за профил или подаване.
Някои разпределени номера използват локално свързване на самоличността вместо създаване на проверка при оператора. Успешният резултат при тях е Identity associated. с празен масив response. Това не създава задача за преглед от оператора и не установява одобрение. Порталът разполага с по-нов процес за свързване, чиято обработка на доставчиците и проверки за повторно подаване се различават от тези на тази крайна точка.
Обработвайте грешките, без да създавате дублирани задачи
API код 400 означава липсващ номер или референция на профил. Код 404 означава профил или номер, който не е достъпен за акаунта, или номер, който липсва в инвентара на оператора. Код 422 може да съобщава за липсващи референции към самоличност или адрес, изисквания на продавача или отхвърляне при валидация от оператора. Липсваща конфигурация за обратно извикване може да доведе до 503, а транспортна грешка при създаване — до 502. Прочетете съобщението и всички данни requirement_diagnostics, вместо да третирате всички неуспехи по един и същ начин.
Клонът за подаване чрез оператор може да актуализира локалните флагове за чакаща регистрация, преди да приключат валидацията на изискванията, проверките на конфигурацията за обратно извикване или създаването на задачата. Следователно грешката не означава, че локалното състояние е непроменено, а сам по себе си флагът за изчакване не доказва, че съществува задача. Не използвайте тези флагове като потвърждение за одобрение или доставяне на заявката.
Доставчикът може да приеме задача дори ако по-късна операция в локалната база данни се провали, а тази помощна функция не проверява резултата от всеки локален запис, преди да съобщи за успех. В този обработчик няма клиентски параметър за идемпотентност или защита от дублирано подаване. След изтичане на времето за изчакване, грешка или неясен резултат проверете историята на регистрацията на номера в портала или се свържете с поддръжката, преди да подадете отново. Липсата на локален запис сама по себе си не доказва, че доставчикът не е получил нищо.
Ограничение за документи за еднократна употреба
Обработчикът приема onetime_files и препраща всеки непразен низ към релацията на оператора за шифровани файлове. Той не търси записите за качени файлове на акаунта, на който принадлежат, и не преобразува външните маскирани идентификатори на качвания в идентификатори на файлове при доставчика. Офлайн одитът потвърди поведението при препращане, а не успешно прикачване при оператора.
Не приемайте, че идентификатор на файл от create_encrypt_files може да бъде копиран в това поле, за да се завърши процесът за еднократно споразумение. Когато даден номер изисква тези документи, използвайте портала или потвърдете с MultiTEL поддържания процес за идентификаторите. Това остава неразрешена част от прегледа на API, а не пример, проверен от начало до край.
Защитете регистрационната информация
Подавайте само информация и документи, които сте упълномощени да използвате за номера. Поддържайте референциите към профилите и проверките свързани с правилния акаунт и избягвайте записването на пълното съдържание на регистрационните заявки в журналите. Тази заявка не изтрива и не заменя всички предишни доказателства или проверки. Прегледът от оператора, активирането и съхранението на данни са отделни процеси.