Прочитајте захтеве за кампању бренда

Држите бренд и случај употребе заједно

Користите ID бренда на свом налогу и вредност случаја употребе коју је вратила листа квалификација тог истог бренда. Кориснички ток рада проверава власништво пре захтева ка провајдеру. Потврдите да се usecase враћеног објекта поклапа са изабраном вредношћу. Претрага за један бренд или случај употребе не утврђује захтеве за други.

Прочитајте тренутне захтеве

Захтеви које користи тренутни образац кампање
Поље	Како га портал користи
minSubUsecases / maxSubUsecases	Најмањи и највећи број под-случајева употребе за овај избор. Бирајте вредности из важећег каталога под-случајева употребе, а не слободан текст.
mnoMetadata	Захтеви специфични за оператера, индексирани по ID-у оператера. За избор оператера користите ID-ове присутне у тренутном одговору.
mnoSupport / qualify	Подршка и квалификација оператера. Портал искључује оператере који су изричито означени као false за било које од ова два поља и захтева најмање једног подобног изабраног оператера.
minMsgSamples	Обавезан број узорака за оператера. Портал захтева најмање један непразан узорак и испуњава највиши минимум међу подобним изабраним оператерима.
reqSubscriberOptin / reqSubscriberOptout / reqSubscriberHelp	Обавезне изјаве претплатника. Тамо где је обавезна, одговарајућа изјава мора бити true. Омогућене изјаве такође захтевају своја поља за кључне речи и поруку одговора.
noEmbeddedLink / noEmbeddedPhone	Ограничења за уграђене везе или бројеве телефона. Портал одбија пријављену функцију ако је подобан изабрани оператер забрањује.

Примените захтеве изабраних оператера заједно

Захтеви оператера могу се разликовати. Када није наведена изричита листа оператера, портал узима у обзир све метаподатке оператера у одговору; непразна листа ограничава провере на те изабране ID-ове. Не користите само број узорака или изјаве првог оператера. Изаберите оператере из одговора, проверите подршку и квалификацију, испуните највиши применљиви минимум узорака и задовољите обавезне изјаве о пријави, одјави и помоћи за цео тај избор. Портал одбија изабране ID-ове оператера којих нема у тренутном одговору и одбија избор без иједног подобног оператера.

Захтеви описују шта мора бити достављено; они не доказују да процес пристанка корисника или садржај кампање испуњавају те захтеве. Прикупите истините, репрезентативне узорке и изјаве. Не укључујте изјаве аутоматски да би образац прошао.

Припремите узорке и одговоре претплатницима

Тренутни образац кампање користи поља од sample1 до sample5 за узорке порука. Ако се захтеви не могу испунити у оквиру доступног обрасца, зауставите се и разрешите избор уз помоћ подршке. За омогућену изјаву претплатника наведите одговарајуће кључне речи и текст одговора: optinKeywords/optinMessage, optoutKeywords/optoutMessage и helpKeywords/helpMessage. Нека узорци буду усклађени са изабраним случајем употребе и стварним порукама корисника.

Прегледајте пре било ког захтева за регистрацију

Освежите захтеве када се промени бренд, случај употребе или избор оператера. Портал поново проверава изабрани случај употребе, број под-случајева употребе, подобност оператера, узорке и изјаве пре креирања. Цене налога и услове регистрације прегледајте одвојено. Овај GET не региструје нити одобрава кампању, не дели је са оператером за поруке и не додељује број телефона. Креирање и провизионисање су одвојене операције.

Поступање са неуспелом претрагом захтева

Ако захтев не успе, врати неочекивани JSON или се не поклапа са изабраним случајем употребе, оставите образац непотпуним и дозволите кориснику да покуша поново након што се грешка отклони. Не замењујте недоступне захтеве празним објектом и не претпостављајте да недостатак података значи да нема захтева. Поштујте Retry-After и користите одлагање са повећањем интервала за ограничења броја захтева и грешке доступности.

Захтев

Користите омогућен API налог преко HTTPS-а са дозвољене изворне IP адресе. Тренутна рута подржава политику аутентификације налога, укључујући Basic аутентификацију и омогућене bearer API налоге. Не користите акредитиве провајдера.

GET са ID-ом бренда и изабраном вредношћу случаја употребе у URL путањи. Тело захтева није потребно.

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/tcr/v2/campaignBuilder/brand/$BRAND_ID/usecase/$USECASE"

Параметри путање
Назив	Тип	Обавезно	Опис
`brand_id`	string	Да	ID бренда у регистру повезан са вашим аутентификованим MultiTEL налогом. Користите ID бренда, а не ID реда у локалној бази података, ID кампање или порески број предузећа. Кодирајте га као један сегмент URL путање.
`usecase`	string	Да	Машински читљива вредност usecase изабрана са листе квалификација овог истог бренда. Сачувајте њена велика и мала слова; не шаљите преведену ознаку за приказ. Кодирајте је као један сегмент URL путање.

Одговор

Тренутна TCR рута враћа JSON тело регистра директно и чува његов HTTP статус. Не додаје наслеђени v3 status/response омотач. Скраћени измишљени пример није стварни резултат квалификације. Проверите HTTP статус и очекивани JSON облик пре употребе. Портал очекује објекат чији се usecase поклапа са изабраним случајем употребе. Захтеви оператера налазе се под mnoMetadata, индексирани по ID-у оператера. ID оператера и захтеви у примеру су измишљени. Могу бити враћена и друга поља провајдера.

Илустративни облик одговора; нису стварни подаци о налогу нити тренутна понуда.

{
  "usecase": "2FA",
  "minSubUsecases": 0,
  "maxSubUsecases": 0,
  "mnoMetadata": {
    "12345": {
      "mnoSupport": true,
      "qualify": true,
      "minMsgSamples": 1,
      "reqSubscriberOptin": true,
      "reqSubscriberOptout": true,
      "reqSubscriberHelp": true,
      "noEmbeddedLink": false,
      "noEmbeddedPhone": false
    }
  }
}

Грешке

401: Аутентификација налога није успела. Проверите API акредитиве, стање омогућености и применљива ограничења изворне IP адресе.
404: Бренд није повезан са аутентификованим налогом, или провајдер не може да пронађе тражени бренд или избор. Локално одбијање због власништва враћа се пре захтева ка провајдеру.
Остале грешке регистра: Узводни HTTP статус и тело се чувају. Неважећи или недоступан случај употребе није успешан празан скуп захтева.
429: Достигнуто је ограничење броја захтева налога или дељеног провајдера. Поштујте Retry-After.
502/503: Грешка доступности транспорта, провајдера или ограничавача броја захтева. Сачувајте образац и покушајте поново уз одлагање са повећањем интервала.

Доступност и споредни ефекти

Прегледани GET проверава постојеће власништво над брендом, контактира регистар и уписује записе ревизије захтева. Не креира бренд нити кампању и не наплаћује накнаду за регистрацију.
Метаподаци о накнади провајдера нису малопродајна понуда за MultiTEL корисника. Портал одвојено прегледа цене налога пре каснијег захтева за регистрацију.
Квалификација и захтеви се могу променити. Освежите их за изабрани бренд и случај употребе пре подношења. Успешна претрага није одобрење кампање, додела броја нити дозвола за почетак слања порука.