REST API -dokumentaatio
SMS & MMS REST API:t
Lähetä hyväksyttyjä sovellusviestejä ja käsittele hyväksyntä, toimitustapahtumat, segmentointi ja maksut.
Valitse API ja tunnistetieto yhdessä
Hyväksytyt Kehittäjät ja automaatio-, Yritys- ja Viestintäpalveluntarjoajat-tilit voivat integroida käytössä olevia palveluja. Yksittäisen kehittäjän ei tarvitse esiintyä yrityksenä. Sovellusten SMS/MMS edellyttää soveltuvaa lähetyshyväksyntää ja rekisteröintiä. Henkilöt ja perheet -palvelulla ei ole asiakkaan käytettävissä olevaa viestien lähetyksen API-rajapintaa.
| API-perhe | Perus-URL | Todennus ja tulos |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Hyväksytyt Basic-tunnistetiedot; oikeutetut provisionoidut tunnukset vain toimintoihin, jotka tukevat niitä. JSON-muotoiset status ja response. |
| Hätäpalvelun rekisteröinti | https://api.multi.tel/emergency | Hyväksytyt Basic-tunnistetiedot tai erikseen provisionoitu bearer-käyttöoikeus. JSON-muotoiset code, message ja data. |
| Portaalin REST-integraatiot | Isäntä ja toiminto on esitetty tilisi kehittäjäviitteessä | Käytä kyseisen toiminnon dokumentoitua tunnistetietoa, käyttöoikeuksia ja skeemaa. Selainistunnon pyynnöt ovat erillinen rajapinta. |
Määritä MULTITEL_API_USERNAME ja MULTITEL_API_PASSWORD palvelimesi salaisuuksien hallinnan kautta ennen esimerkkien käyttöä. Älä koskaan upota niitä julkiseen selaimen JavaScript-koodiin, URL-osoitteisiin tai versionhallintaan. Erillisiä tunnistetietoja hallitaan kohdassa API-integraation asetukset.
Valmistele SMS-pyyntö
Käytä hyväksyttyä, SMS-yhteensopivaa tilin omistamaa lähetysnumeroa ja vastaanottajaa, joka on suostunut viestiin. Suorita vaadittu Brand/Campaign-rekisteröinti tai soittajalle maksuttoman numeron vahvistus. Alla oleva esimerkki lähettää oikean viestin, kun se täytetään toimivilla tunnistetiedoilla ja numeroilla; se ei ole hiekkalaatikko.
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
--request POST \
--header "Content-Type: application/json" \
--data '{"from":"YOUR_APPROVED_NUMBER","to":"YOUR_CONSENTED_RECIPIENT","text":"Your requested update is ready."}' \
"https://api.multitel.net/v3/sendsms"Korvaa lähettäjän ja vastaanottajan paikkamerkit kansainvälisessä muodossa olevilla puhelinnumeroilla, jotka sisältävät vain numerot ja maatunnuksen. Anna MMS-viestiä varten tuettu julkisesti noudettavissa oleva median URL-osoite kentässä media ja tarkista ensin MMS-kelpoisuus ja hinnoittelu.
Hyväksyntä ei ole toimitus
Tarkista sekä ulompi sovellustila että palautettu viestinnän tulos. Kirjaa palvelun antama viestitunnus muistiin ja seuraa toimitustilaa ja webhook-tapahtumia. Onnistunut lähetys ei todista, että vastaanottajan puhelin sai viestin.
SMS-laskutus on segmenttikohtaista. Koodaus ja viestin pituus voivat tuottaa useita segmenttejä; media- ja operaattorikohtaiset maksut voivat erota SMS-maksuista. Lue tilin nykyinen myyntihinta ennen lähettämistä. Älä koskaan yritä aikakatkaisuun päättynyttä lähetystä sokeasti uudelleen: tarkista ensin sen kirjattu tulos.
Käsittele virheet ja uudelleenyritykset
- Todennus- tai käyttöoikeusvirhe
- Tarkista API-tunnistetiedon käytössäolotila, sallittu palvelu ja lähde-IP-rajoitus. Portaalin istuntoeväste ei ole integraation tunnistetieto.
- Riittämätön saldo tai puuttuva hyväksyntä
- Selvitä tilin saldo, lähetyshyväksyntä tai asiakirjavaatimus ennen toiminnon toistamista.
- Ei tulosta
- Käsittele tyhjää varastoa tai puuttuvaa soittajan nimeä tavallisena tuloksena. Älä oleta, että syntaktisesti kelvollisella numerolla on kaikki palvelut.
- Verkon aikakatkaisu tai palveluvirhe
- Käytä lukutoiminnoissa rajoitettuja uudelleenyrityksiä viiveen pidennyksellä. Tarkista oston, lähetyksen tai rekisteröinnin yhteydessä ensin toiminnon tila; hyväksytyn pyynnön uudelleenyritys voi monistaa laskutettavan toiminnon.
Idempotenssituki määräytyy API-perhekohtaisesti. Emergency API tukee uudelleenyritysavaimia; se ei tee mielivaltaisista v3-pyynnöistä idempotentteja. Säilytä aikaleimat, palautetut tunnukset ja sensuroidut vastaukset tukea varten.
Jatka tilisi viiteaineistoon
Kirjautuneen käyttäjän viiteaineisto näyttää toiminnot käyttöoikeuksien ja käytössä olevien palvelujen mukaan. Käytä siinä ilmoitettua tarkkaa isäntää, tunnistetietotyyppiä, pyyntökenttiä ja vastausskeemaa. Konsolit voivat suorittaa todellisia toimintoja, myös ostoja ja viestien lähetyksiä.