Caktoni një numër për një fushatë mesazhesh

Caktoni një numër dërgimi për një fushatë

Përdoreni këtë veprim pasi marka juaj e mesazheve dhe fushata e prodhimit të jenë regjistruar dhe fushata të jetë aktive. Ai lidh një numër me SMS të aktivizuar në llogarinë tuaj me fushatën. Ai nuk krijon një markë, nuk krijon ose miraton një fushatë, nuk blen një numër dhe nuk dërgon një mesazh.

Portali aktual e përdor këtë rrugë kur i cakton një fushatë një numri. API-ja publike pranon një identifikues fushate; ajo e nxjerr markën nga fushata në pronësi të llogarisë në vend që të pranojë një identifikues të veçantë marke.

Kërkesa

Dërgoni një POST të koduar si formular përmes HTTPS duke përdorur llogarinë tuaj të aktivizuar të API-së dhe adresën e saj IP burimore të lejuar. Përdorni identifikuesit realë të numrit dhe të fushatës nga llogaria juaj. Numri në këtë shembull është fiktiv.

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'

Parametrat e caktimit të fushatës
Parametri	I detyrueshëm	Kuptimi
action	Po	Përdorni add për të caktuar ose delete për të hequr lidhjen aktuale të numrit me fushatën. Shkronjat e mëdha ose të vogla dhe hapësirat përreth normalizohen.
campaign	Për add	campaignId e një fushate ACTIVE në pronësi të llogarisë së autentikuar. Edhe marka e saj duhet t'i përkasë llogarisë. Një fushatë e shënuar shprehimisht si sandbox nuk mund t'u caktohet numrave realë të dërgimit. Lëreni jashtë këtë parametër për delete; heqja përdor lidhjen ekzistuese të numrit.
number	Po	Numri i dërgimit në pronësi, aktiv, i paanuluar dhe me SMS të aktivizuar. Për një numër të Amerikës së Veriut, përdorni kodin e shtetit 1 të ndjekur nga dhjetë shifrat e tij, pa shenjën plus. Përpunuesi i kërkesës heq karakteret jo-shifrore dhe kërkon gjithashtu ekuivalentët me prefiks plus dhe me dhjetë shifra. Ky normalizim nuk është një kontroll i përgjithshëm i vlefshmërisë së numrit të telefonit.

Veprimi ndryshon një numër të vetëm. Ai nuk ka faqosje, parametër grupi apo opsion ekzekutimi prove. Mos përdorni një pikë fundore për krijimin e fushatës vetëm për t'i bashkëngjitur një numër një fushate ekzistuese.

Hiqni lidhjen aktuale

Përdorni action=delete me numrin që zotëroni. Kjo heq lidhjen e tij me fushatën e dërgimit dhe pastron fushat e ruajtura të markës/fushatës për atë numër. Ajo nuk e fshin fushatën ose markën, nuk e liron numrin e telefonit, nuk e anulon shërbimin e numrit dhe nuk e ndalon faturimin periodik të fushatës.

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

Përgjigja dhe verifikimi

Ky shembull fiktiv ilustron mbështjelljen e zakonshme të përgjigjes së API-së dhe disa fusha të zgjedhura të rezultatit. Numri i kthyer ruan formatin e ruajtur në llogarinë tuaj. brandId dhe campaignId janë vargje bosh pas një heqjeje të suksesshme.

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

providerStatus është statusi HTTP i partnerit të mesazheve. Përpunuesi i kërkesës pranon një përgjigje transporti 2xx dhe më pas përditëson regjistrimin lokal të numrit; ai nuk e interpreton trupin e përgjigjes së partnerit për një rezultat të veçantë pranimi në nivel biznesi. Prandaj një përgjigje suksesi nuk është provë se regjistrimi i mesazheve ka përfunduar ose se dorëzimi do të ketë sukses. Shqyrtoni statusin e fushatës së numrit në portal përpara se të dërgoni trafik prodhimi.

Mos e trajtoni vetëm një lidhje lokale si miratim për dorëzim. Miratimi i fushatës dhe i markës, pajisja me numër, lejet e llogarisë, rregullat e përmbajtjes dhe kufijtë e zakonshëm të mesazheve vazhdojnë të zbatohen.

Gabimet dhe rezultatet e pjesshme

401: përpunuesi i kërkesës nuk ka në dispozicion asnjë llogari të autentikuar.
400: action ose number mungon ose është i pavlefshëm, ose një kërkesë add nuk ka identifikues fushate.
404: numri nuk është një numër SMS në pronësi, aktiv dhe i paanuluar.
409: fushata nuk është e disponueshme për llogarinë, nuk është ACTIVE, është shprehimisht sandbox, ose marka e saj nuk është e disponueshme për llogarinë.
503: integrimi i mesazheve nuk është i disponueshëm. Kontaktoni mbështetjen në vend që të ndryshoni kredencialet e llogarisë ose të shpikni vlera konfigurimi.
502: kërkesa e mesazheve dështoi, skadoi ose ktheu një status HTTP jo-2xx. providerStatus mund të kthehet. Një skadim kohe nuk vërteton se partneri nuk bëri asnjë ndryshim.
500 me partial=true: partneri i mesazheve ktheu një status HTTP të suksesshëm, por lidhja lokale nuk mund të konfirmohej. Rakordoni numrin në portal ose kontaktoni mbështetjen përpara se të provoni përsëri.

Kontrolloni kodin e statusit të API-së dhe trupin e përgjigjes, si edhe rezultatin HTTP. Mos e riprovoni verbërisht një skadim kohe ose një rezultat të pjesshëm. Ky përpunues i kërkesës nuk ka çelës idempotence në nivel kërkese, rikthim transaksional apo kontroll të përfundimit të regjistrimit të fushatës. Një caktim lokal i përsëritur dhe i njëjtë mund të kthejë sukses edhe kur baza e të dhënave raporton se asnjë rresht nuk ka ndryshuar.

Fusha e veprimit dhe efektet

Ky veprim ndryshon drejtimin e numrit të dërgimit dhe lidhjen e tij të ruajtur me fushatën/markën. Në përpunuesin e shqyrtuar të kërkesës ai nuk përmban asnjë debitim të drejtpërdrejtë të llogarisë, krijim fushate, blerje apo dërgim mesazhi. Kjo nuk është një ofertë çmimi apo premtim për shërbim falas: tarifat ekzistuese për numrin, fushatën dhe mesazhet vazhdojnë sipas kushteve të llogarisë suaj.

Në portal, kalimi në një fushatë tjetër fillimisht heq lidhjen e mëparshme dhe më pas shton të renë. Këto janë kërkesa të veçanta. Nëse kërkesa e dytë dështon, lidhja e mëparshme mund të jetë hequr tashmë. Mos supozoni se të dyja kërkesat rikthehen së bashku.