REST API -dokumentaatio
Puhelinnumeroiden REST API:t
Löydä saatavilla olevat maat ja numerot, tarkastele täydellistä tarjousta ja hallinnoi omistamiasi numeroita.
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.
Lue saatavilla oleva maaluettelo
curl --fail-with-body \
--user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
--header "Accept: application/json" \
"https://api.multitel.net/v3/getcountries"v3-vastaus sisältää status-elementin ja response-taulukon. Maatietueet sisältävät isocode-, name- ja countrycode-kentät, ominaisuustiedot sekä next_function-kentän. Saatavuus riippuu tilistä ja varastosta; maa ei ole lupaus siitä, että jokainen etuliite tai numerotyyppi on varastossa.
{
"status": {
"code": 200,
"msg": "Results: 1"
},
"response": [
{
"countrycode": "1",
"name": "United States",
"description": "United States",
"isocode": "US",
"is_mobile": 0,
"sms_coverage": 1,
"latitude": "37.0902",
"longitude": "-95.7129",
"next_function": "v3/getareas/US"
}
]
}Löytämisestä käyttöönottoon
- Valitse maa, tarvittaessa osa-alue, alue ja numerotyyppi vastaavilla maantiedetoiminnoilla.
- Lue valitun numeron käyttöönotto-, kuukausi- ja käyttöhinnat, kanavat, kiintiö ja rekisteröintivaatimukset.
- Lähetä vaaditut loppukäyttäjän asiakirjat ja tarkista niiden tila. Numero voi pysyä odottavana hyväksyntään asti.
- Tilaa kerran tarkalla varasto-/hintavalinnalla. Jos vastaus on epävarma, tarkista varastosi ennen uuden tilauksen lähettämistä.
- Määritä puhereititys ja viestien toimitus erikseen ja testaa sitten koko tarkoitettu reitti.
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ä.