Ken 'n nommer aan 'n boodskapveldtog toe

Ken 'n stuurnommer aan 'n veldtog toe

Gebruik hierdie bewerking nadat jou boodskaphandelsmerk en produksieveldtog geregistreer is en die veldtog aktief is. Dit assosieer een SMS-geaktiveerde nommer op jou rekening met die veldtog. Dit skep nie 'n handelsmerk nie, skep of keur nie 'n veldtog goed nie, koop nie 'n nommer nie en stuur nie 'n boodskap nie.

Die huidige portaal gebruik hierdie roete wanneer 'n veldtog aan 'n nommer toegeken word. Die openbare API aanvaar 'n veldtogidentifiseerder; dit lei die handelsmerk af van die veldtog wat deur die rekening besit word, eerder as om 'n afsonderlike handelsmerkidentifiseerder te aanvaar.

Versoek

Stuur 'n vormgekodeerde POST oor HTTPS met jou geaktiveerde API-rekening en sy toegelate bron-IP-adres. Gebruik die werklike nommer- en veldtogidentifiseerders uit jou rekening. Die nommer in hierdie voorbeeld is fiktief.

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'

Veldtogtoekenningsparameters
Parameter	Vereis	Betekenis
action	Ja	Gebruik add om toe te ken of delete om die nommer se huidige veldtogassosiasie te verwyder. Hoofletters en omringende spasies word genormaliseer.
campaign	Vir add	Die campaignId van 'n ACTIVE veldtog wat deur die geoutentiseerde rekening besit word. Sy handelsmerk moet ook aan die rekening behoort. 'n Veldtog wat uitdruklik as sandbox gemerk is, kan nie aan lewendige stuurnommers toegeken word nie. Laat hierdie parameter weg vir delete; verwydering gebruik die nommer se bestaande assosiasie.
number	Ja	Die aktiewe, nie-nietige, SMS-geaktiveerde stuurnommer in jou besit. Vir 'n Noord-Amerikaanse nommer, gebruik landkode 1 gevolg deur sy tien syfers, sonder 'n plusteken. Die hanteerder verwyder nie-syferkarakters en soek ook na ekwivalente met 'n plusvoorvoegsel en met tien syfers. Hierdie normalisering is nie 'n algemene geldigheidskontrole vir telefoonnommers nie.

Die bewerking verander een nommer. Dit het geen paginering, bondelparameter of proeflopie-opsie nie. Moenie 'n veldtogskeppingseindpunt gebruik bloot om 'n nommer aan 'n bestaande veldtog te heg nie.

Verwyder die huidige assosiasie

Gebruik action=delete met die nommer in jou besit. Dit verwyder sy stuurveldtogassosiasie en maak die gestoorde handelsmerk-/veldtogvelde vir daardie nommer skoon. Dit skrap nie die veldtog of handelsmerk nie, stel nie die telefoonnommer vry nie, kanselleer nie die nommer se diens nie en stop nie die veldtog se herhalende fakturering nie.

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

Antwoord en verifikasie

Hierdie fiktiewe voorbeeld illustreer die gewone API-antwoordomhulsel en geselekteerde resultaatvelde. Die teruggestuurde nommer behou die formaat wat in jou rekening gestoor is. brandId en campaignId is leë stringe ná 'n suksesvolle verwydering.

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

providerStatus is die boodskapvennoot se HTTP-status. Die hanteerder aanvaar 'n 2xx vervoerantwoord en werk dan die plaaslike nommerrekord by; dit interpreteer nie die vennoot se antwoordliggaam vir 'n afsonderlike besigheidsvlak-aanvaardingsresultaat nie. 'n Suksesantwoord is dus nie bewys dat boodskapregistrasie voltooi is of dat aflewering sal slaag nie. Hersien die nommer se veldtogstatus in die portaal voordat jy produksieverkeer stuur.

Moenie 'n plaaslike assosiasie alleen as afleweringsgoedkeuring beskou nie. Veldtog- en handelsmerkgoedkeuring, nommervoorsiening, rekeningtoestemmings, inhoudreëls en gewone boodskaplimiete geld steeds.

Foute en gedeeltelike resultate

401: geen geoutentiseerde rekening is vir die hanteerder beskikbaar nie.
400: action of number ontbreek of is ongeldig, of 'n add versoek het geen veldtogidentifiseerder nie.
404: die nommer is nie 'n aktiewe, nie-nietige SMS-nommer in jou besit nie.
409: die veldtog is nie vir die rekening beskikbaar nie, is nie ACTIVE nie, is uitdruklik sandbox, of sy handelsmerk is nie vir die rekening beskikbaar nie.
503: die boodskapintegrasie is nie beskikbaar nie. Kontak ondersteuning eerder as om rekeningaanmeldbesonderhede te verander of konfigurasiewaardes uit te dink.
502: die boodskapversoek het misluk, uitgetel of 'n nie-2xx HTTP-status teruggestuur. providerStatus kan teruggestuur word. 'n Uitteltyd bewys nie dat die vennoot geen verandering gemaak het nie.
500 met partial=true: die boodskapvennoot het 'n suksesvolle HTTP-status teruggestuur, maar die plaaslike assosiasie kon nie bevestig word nie. Rekonsilieer die nommer in die portaal of kontak ondersteuning voordat jy weer probeer.

Kontroleer die API-statuskode en antwoordliggaam sowel as die HTTP-resultaat. Moenie 'n uitteltyd of gedeeltelike resultaat blindelings weer probeer nie. Hierdie hanteerder het geen idempotensiesleutel op versoekvlak, transaksionele terugrol of veldtogregistrasie-voltooiingskontrole nie. 'n Herhaalde ooreenstemmende plaaslike toekenning kan sukses teruggee selfs wanneer die databasis geen veranderde rye rapporteer nie.

Omvang en gevolge

Hierdie bewerking verander stuurnommerroetering en sy gestoorde veldtog-/handelsmerkassosiasie. Dit bevat geen direkte rekeningdebiet, veldtogskepping, aankoop of boodskapversending in die nagegaande hanteerder nie. Dit is nie 'n pryskwotasie of 'n belofte van gratis diens nie: bestaande nommer-, veldtog- en boodskapkoste duur voort onder jou rekeningvoorwaardes.

In die portaal verwyder die verandering na 'n ander veldtog eers die vorige assosiasie en voeg dan die nuwe een by. Dit is afsonderlike versoeke. As die tweede versoek misluk, is die vorige assosiasie dalk reeds verwyder. Moenie aanvaar dat die twee versoeke saam terugrol nie.