Изберете съществуваща марка във вашия акаунт
Започнете с идентификатора на марката в регистъра, който вече е свързан с вашия MultiTEL акаунт. Тази справка не създава марка и не свързва чужда марка с вашия акаунт. Текущият работен процес за клиенти проверява собствеността, преди да поиска данните за допустимост. Ако справката върне 404, проверете избраните акаунт и марка, вместо да използвате идентификатор на ред от локалната база.
Съставете възможностите за избор на предназначение от този резултат
Общият каталог на предназначенията описва възможностите в регистъра. Тази справка за конкретна марка предоставя възможностите за избор за избраната марка. Запазете всяка върната usecase стойност и я съчетайте с показваното име и описанието от каталога. Не предлагайте всеки запис от общия каталог така, сякаш марката отговаря на условията за него.
Порталът очаква този отговор да бъде списък във формат JSON. Ако отговорът липсва, е с неправилна структура или представлява грешка, запазете формуляра на клиента и покажете, че данните за допустимост не могат да бъдат заредени. Не приемайте това мълчаливо за одобрение на предназначение по подразбиране. Регистърът може да върне и полета, които не са показани в съкратения пример.
Заредете изискванията за избраното предназначение
След като клиентът избере една от върнатите стойности за предназначение, изпратете заявка към /tcr/v2/campaignBuilder/brand/{brand_id}/usecase/{usecase} за същата марка. Този отговор предоставя ограниченията за подпредназначенията и изискванията на отделните оператори. Използвайте го, за да съберете примерни съобщения, съгласие и други задължителни декларации. Самият списък с допустими предназначения не е достатъчен за съставяне на пълна заявка за регистрация на кампания.
Прегледайте отделно цените за акаунта
Полета на доставчика като monthlyFee, quarterlyFee или annualFee, когато са върнати, описват метаданни за таксите на доставчика. Те не заместват цената за акаунта на клиента или условията за регистрация. Текущият портал зарежда отделно крайните клиентски цени на кампаниите и ги съчетава с данните за допустимост на екрана за преглед. Не определяйте сумата за плащане от клиента въз основа на цените, фиксирани в кода на старата помощна функция за изброими типове.
Обновявайте данните при промяна на марката или предназначението
При смяна на марката отхвърлете възможностите за избор на предишната марка и заредете данните за допустимост за новия избор. Обновете изискванията за избраното предназначение преди подаване. Тези GET заявки не подават регистрация, не активират кампания и не присвояват номера.
Заявка
Използвайте активиран API акаунт през HTTPS от разрешен изходен IP адрес. Текущият маршрут поддържа политиката за удостоверяване на акаунта, включително удостоверяване Basic и активирани API акаунти с удостоверяване чрез токен за достъп. Не използвайте идентификационните данни на доставчика.
GET с идентификатора на марката в URL пътя. Не е необходимо тяло на заявката.
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID"| Име | Тип | Задължителен | Описание |
|---|---|---|---|
brand_id | низ | Да | Идентификаторът на марката в регистъра, свързан с вашия удостоверен MultiTEL акаунт. Използвайте идентификатора на марката, а не идентификатор на ред в локалната база данни, идентификатор на кампания или данъчен номер на фирмата. Кодирайте го като един сегмент от URL пътя. |
Отговор
Текущият маршрут на TCR връща директно тялото на отговора от регистъра във формат JSON и запазва неговия HTTP статус. Той не добавя старата обвивка status/response от версия v3. Съкратеният измислен пример не е реален резултат от проверка за допустимост. Проверете HTTP статуса и очакваната JSON структура, преди да го използвате. Текущият портал очаква списък със записи за допустимост, всеки от които посочва usecase. Той съчетава тези записи с каталога usecase, за да получи показваните имена, и зарежда крайните клиентски цени отделно. Възможно е да присъстват и допълнителни полета на доставчика.
Примерна структура на отговора; не представлява реални данни на акаунт или актуална ценова оферта.
[
{
"usecase": "2FA"
}
]Грешки
- 401: Неуспешно удостоверяване на акаунта. Проверете идентификационните данни за API, дали акаунтът е активиран и приложимите ограничения за изходни IP адреси.
- 404: Марката не е свързана с удостоверения акаунт или доставчикът не може да намери заявената марка или избор. Локалният отказ поради непотвърдена собственост се връща преди изпращане на заявка до доставчика.
- Други грешки на регистъра: HTTP статусът и тялото на отговора от външната услуга се запазват. Невалидно или недостъпно предназначение не представлява успешно получен празен набор от изисквания.
- 429: Достигнат е лимитът за заявки на акаунта или споделеният лимит на доставчика. Спазвайте Retry-After.
- 502/503: Грешка при преноса или недостъпност на доставчика или механизма за ограничаване на честотата на заявките. Запазете формуляра и опитайте отново с постепенно увеличаване на времето за изчакване.
Наличност и странични ефекти
- Прегледаната GET заявка проверява собствеността върху съществуващата марка, свързва се с регистъра и записва одитни записи за заявката. Тя не създава марка или кампания и не начислява такса за регистрация.
- Метаданните за таксите на доставчика не са оферта с крайни цени за клиент на MultiTEL. Порталът преглежда цените за акаунта отделно преди последваща заявка за регистрация.
- Допустимостта и изискванията могат да се променят. Обновете ги за избраните марка и предназначение преди подаване. Успешната справка не представлява одобрение на кампания, присвояване на номера или разрешение за започване на изпращане на съобщения.