REST API-dokumentasjon
REST API-er for SMS og MMS
Send godkjente applikasjonsmeldinger og håndter aksept, leveringshendelser, segmentering og kostnader.
Velg API og legitimasjon sammen
Godkjente kontoer av typen Utvikler og automatisering, Bedrift og Kommunikasjonsleverandører kan integrere aktiverte tjenester. En individuell utvikler trenger ikke å utgi seg for å være et selskap. Applikasjons-SMS/MMS krever gjeldende sendingsgodkjenning og registrering. Tjenesten Privat og familie har ingen kundetilgjengelig API for å starte meldingssending.
| API-familie | Basis-URL | Autentisering og resultat |
|---|---|---|
| Communications v3 | https://api.multitel.net/v3 | Godkjente Basic-legitimasjoner; kvalifiserte, klargjorte tokener bare for operasjoner som støtter dem. JSON status og response. |
| Registrering for nødanrop | https://api.multi.tel/emergency | Godkjente Basic-legitimasjoner eller spesifikt klargjort bearer-tilgang. JSON code, message og data. |
| Portal REST-integrasjoner | Vert og operasjon vises i kontoens utviklerreferanse | Bruk operasjonens dokumenterte legitimasjon, scopes og skjema. Forespørsler fra nettleserøkten er et separat grensesnitt. |
Angi MULTITEL_API_USERNAME og MULTITEL_API_PASSWORD via serverens hemmelighetskonfigurasjon før du bruker eksemplene. Legg dem aldri inn i offentlig nettleser-JavaScript, URL-er eller kildekontroll. Dedikerte legitimasjoner administreres i API-integrasjonsinnstillinger.
Forbered en SMS-forespørsel
Bruk et godkjent, SMS-aktivert sendernummer som eies av kontoen, og en mottaker som har samtykket til meldingen. Fullfør nødvendig Brand/Campaign-registrering eller verifisering av gratisnummeret. Eksemplet nedenfor sender en ekte melding når det fylles ut med fungerende legitimasjon og numre; det er ikke en sandkasse.
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"Erstatt plassholderne for avsender og mottaker med telefonnumre i internasjonalt format, med bare sifre og inkludert landkode. For MMS må du oppgi den støttede, offentlig hentbare media-URL-en i media og verifisere MMS-berettigelse og priser først.
Aksept er ikke levering
Undersøk både den ytre applikasjonsstatusen og det returnerte meldingsresultatet. Registrer meldingsidentifikatoren fra tjenesten, og følg leveringsstatus og webhook-hendelser. En vellykket innsending kan ikke bevise at mottakerens håndsett mottok meldingen.
SMS-fakturering skjer per segment. Koding og meldingslengde kan gi flere segmenter; media- og operatørrelaterte kostnader kan avvike fra SMS. Les kontoens gjeldende salgspris før sending. Prøv aldri blindt på nytt etter en tidsavbrutt sending: undersøk det registrerte utfallet først.
Håndter feil og nye forsøk
- Autentiserings- eller tillatelsesfeil
- Kontroller API-legitimasjonens aktiverte tilstand, tillatte tjeneste og kilde-IP-begrensning. En informasjonskapsel for portaløkten er ikke en integrasjonslegitimasjon.
- Utilstrekkelig kreditt eller manglende godkjenning
- Løs problemet med kontosaldo, sendingsgodkjenning eller dokumentkrav før du gjentar operasjonen.
- Ingen resultater
- Behandle tomt lager eller manglende innringernavn som et vanlig utfall. Ikke anta at et syntaktisk gyldig nummer har alle tjenester.
- Nettverkstidsavbrudd eller tjenestefeil
- Bruk begrensede nye forsøk med backoff for lesinger. For et kjøp, en sending eller en registrering må du først undersøke operasjonens tilstand; å prøve en akseptert forespørsel på nytt kan duplisere en fakturerbar handling.
Idempotensstøtte tilhører hver API-familie. Emergency API støtter nøkler for nye forsøk; det gjør ikke vilkårlige v3-forespørsler idempotente. Behold tidsstempler, returnerte ID-er og sladdede responser for brukerstøtte.
Fortsett med referansen for kontoen din
Den innloggede referansen filtrerer operasjoner etter tillatelsene dine og aktiverte tjenester. Bruk nøyaktig vert, legitimasjonstype, forespørselsfelt og responsskjema der. Konsollene kan utføre live-operasjoner, inkludert kjøp og meldinger.