Доделите број кампањи за слање порука

Доделите број за слање кампањи

Користите ову операцију након што су ваш бренд за слање порука и продукциона кампања регистровани и када је кампања активна. Она повезује један број са омогућеним SMS-ом на вашем налогу са кампањом. Она не креира бренд, не креира нити одобрава кампању, не купује број и не шаље поруку.

Тренутни портал користи ову руту када додељује кампању броју. Јавни API прихвата идентификатор кампање; бренд изводи из кампање коју поседује налог, уместо да прихвата засебан идентификатор бренда.

Захтев

Пошаљите POST кодиран као формулар преко HTTPS-а користећи свој омогућени API налог и његову дозвољену изворну IP адресу. Користите стварне идентификаторе броја и кампање са свог налога. Број у овом примеру је измишљен.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode 'action=add' \
  --data-urlencode "campaign=$CAMPAIGN_ID" \
  --data-urlencode 'number=12025550123' \
  'https://api.multitel.net/v3/campaign'

Параметри додељивања кампање
Параметар	Обавезан	Значење
action	Да	Користите add за додељивање или delete за уклањање тренутног повезивања броја са кампањом. Велика и мала слова и размаци око вредности се нормализују.
campaign	За add	campaignId кампање у статусу ACTIVE коју поседује аутентификовани налог. Њен бренд такође мора припадати налогу. Кампања која је изричито означена као sandbox не може се доделити живим бројевима за слање. Изоставите овај параметар за delete; уклањање користи постојеће повезивање броја.
number	Да	Број за слање који поседујете, активан, непоништен и са омогућеним SMS-ом. За северноамерички број користите позивни број земље 1, иза кога следи његових десет цифара, без знака плус. Обрађивач уклања знакове који нису цифре и такође тражи еквиваленте са префиксом плус и десетоцифрене еквиваленте. Ова нормализација није општа провера исправности телефонског броја.

Операција мења један број. Нема пагинацију, параметар за групну обраду нити опцију пробног извршавања. Немојте користити крајњу тачку за креирање кампање само да бисте повезали број са постојећом кампањом.

Уклоните тренутно повезивање

Користите action=delete са бројем који поседујете. Ово уклања његово повезивање са кампањом за слање и брише сачувана поља бренда/кампање за тај број. Не брише кампању нити бренд, не ослобађа телефонски број, не отказује услугу броја и не зауставља периодичну наплату кампање.

curl --silent --show-error --user "$API_USER:$API_PASSWORD" \
  --data-urlencode 'action=delete' \
  --data-urlencode 'number=12025550123' \
  'https://api.multitel.net/v3/campaign'

Одговор и провера

Овај измишљени пример илуструје уобичајени омотач API одговора и изабрана поља резултата. Враћени број задржава формат сачуван на вашем налогу. brandId и campaignId су празни стрингови након успешног уклањања.

{
  "status": {"code": 200, "msg": "Campaign assignment updated."},
  "response": {
    "number": "+12025550123",
    "brandId": "BRAND_FROM_ACCOUNT",
    "campaignId": "CAMPAIGN_FROM_ACCOUNT",
    "providerStatus": 200
  }
}

providerStatus је HTTP статус партнера за слање порука. Обрађивач прихвата 2xx одговор на нивоу преноса и затим ажурира локални запис броја; он не тумачи тело одговора партнера ради засебног резултата прихватања на пословном нивоу. Успешан одговор стога није доказ да је регистрација за слање порука завршена нити да ће испорука успети. Проверите статус кампање за број на порталу пре слања продукционог саобраћаја.

Немојте третирати само локално повезивање као одобрење за испоруку. Одобрење кампање и бренда, обезбеђивање броја, дозволе налога, правила о садржају и уобичајена ограничења за слање порука и даље важе.

Грешке и делимични резултати

401: обрађивачу није доступан ниједан аутентификовани налог.
400: action или number недостаје или је неисправан, или add захтев нема идентификатор кампање.
404: број није SMS број који поседујете, активан и непоништен.
409: кампања није доступна налогу, није у статусу ACTIVE, изричито је sandbox, или њен бренд није доступан налогу.
503: интеграција за слање порука није доступна. Контактирајте подршку уместо да мењате акредитиве налога или измишљате вредности конфигурације.
502: захтев за слање порука није успео, истекао је или је вратио HTTP статус који није 2xx. providerStatus може бити враћен. Истек времена не доказује да партнер није направио никакву промену.
500 са partial=true: партнер за слање порука вратио је успешан HTTP статус, али локално повезивање није могло бити потврђено. Ускладите број на порталу или контактирајте подршку пре поновног покушаја.

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

Опсег и ефекти

Ова операција мења рутирање броја за слање и његово сачувано повезивање са кампањом/брендом. У прегледаном обрађивачу не садржи директно задужење налога, креирање кампање, куповину нити слање поруке. Ово није понуда цене нити обећање бесплатне услуге: постојеће накнаде за број, кампању и слање порука настављају се према условима вашег налога.

На порталу, прелазак на другу кампању прво уклања претходно повезивање, а затим додаје ново. То су засебни захтеви. Ако други захтев не успе, раније повезивање је можда већ уклоњено. Немојте претпостављати да се та два захтева заједно враћају на претходно стање.