REST API-dokumentasie

Noodoproep-REST-API's

Registreer 'n nommer en diensadres, volg die aktiveringstatus daarvan en hou die rekord by namate die ligging verander.

Maak rekeningspesifieke verwysing oop Ontwikkelaar en Outomatisering

Kies die API en aanmeldbesonderhede saam

Goedgekeurde rekeninge vir Ontwikkelaar en Outomatisering, Besigheid en Kommunikasieverskaffers kan geaktiveerde dienste integreer. 'n Individuele ontwikkelaar hoef nie voor te gee om 'n maatskappy te wees nie. SMS/MMS vanaf toepassings vereis die toepaslike versendingsgoedkeuring en registrasie. Die diens vir Individue en gesinne het geen API wat kliënte kan gebruik om boodskappe te stuur nie.

API-familie	Basis-URL	Stawing en resultaat
Communications v3	`https://api.multitel.net/v3`	Goedgekeurde Basic-aanmeldbesonderhede; toepaslike uitgereikte tokens slegs vir bewerkings wat dit ondersteun. JSON `status` en `response`.
Registrasie vir noodoproepe	`https://api.multi.tel/emergency`	Goedgekeurde Basic-aanmeldbesonderhede of spesifiek geaktiveerde bearer-toegang. JSON `code`, `message` en `data`.
Portaal-REST-integrasies	Gasheer en bewerking word in jou rekening se ontwikkelaarverwysing getoon	Gebruik daardie bewerking se gedokumenteerde aanmeldbesonderhede, toestemmingsomvang en skema. Blaaier-sessieversoeke gebruik 'n afsonderlike koppelvlak.

Stel MULTITEL_API_USERNAME en MULTITEL_API_PASSWORD deur jou bediener se geheimekonfigurasie in voordat jy die voorbeelde gebruik. Moet dit nooit in openbare blaaier-JavaScript, URL's of bronbeheer inbed nie. Afsonderlike aanmeldbesonderhede word in API-integrasie-instellings bestuur.

Lees dekking sonder om 'n nommer te registreer

curl --fail-with-body \
  --user "$MULTITEL_API_USERNAME:$MULTITEL_API_PASSWORD" \
  --header "Accept: application/json" \
  "https://api.multi.tel/emergency/coverage?environment=production"

https://api.multitel.net/emergency word ook ondersteun. Geeneen van die noodoproep-basis-URL's bevat /v3 nie. Die dekking lys die ondersteunde lande vir die internasionale diens, ondersteunde nommersoorte en pryse; Noord-Amerikaanse E911-geskiktheid word tydens registrasie nagegaan.

{
  "code": 200,
  "message": "",
  "environment": "production",
  "requestId": "EXAMPLE_REQUEST_ID",
  "data": {}
}

Dit illustreer slegs die buitenste responsstruktuur. Lees elke bewerking se data-skema in die gepubliseerde Emergency API-gids.

Registreer, volg status, konfigureer dan oproepe

Vir VSA/Kanada en die ander ondersteunde Noord-Amerikaanse E911-streke, verskaf die nommer, E911-adres en vereiste toestemmingsbevestigings. Noord-Amerikaanse E911 is slegs in die produksieomgewing beskikbaar.
Vir 'n ondersteunde internasionale nommer in besit, verskaf óf 'n gestoorde Document-verwysing óf die eindgebruiker se identiteit en adres. Hersien eers die land- en nommersoortvereistes.
Stuur een POST /registrations-versoek. 'n Opsionele Idempotency-Key identifiseer 'n logiese mutasie; behou dit en die presiese payload oor herprobeerslae heen.
Lees GET /registrations/:number. Inspekteer lewensiklus, pending en actionRequired; los vereiste regstellings op. Aanvaarding of hangende is nie aktiewe diens nie.
Na aktivering, konfigureer die korrekte nood-beller-ID en landspesifieke skakelroete. Gebruik die diens se nie-noodverifikasieprosedure.

Internasionale sandbox-registrasies is geïsoleerd en aktiveer nie werklike noodoproepe nie. Die hoofrekening se aanmeldbesonderhede word vir Noord-Amerikaanse E911 vereis; die gids verduidelik die beperkte internasionale subrekeningondersteuning.

Portaalopstelling en verifikasie Landdekking en noodnommers Volledige openbare versoek-, veld-, status- en herprobeergids

Hanteer foute en herprobeerslae

Stawing- of toestemmingsfout: Kontroleer of die API-aanmeldbesonderhede geaktiveer is, watter diens toegelaat word en watter bron-IP-beperking geld. 'n Portaal-sessiekoekie is nie aanmeldbesonderhede vir 'n integrasie nie.
Onvoldoende krediet of ontbrekende vereiste goedkeuring: Los eers enige probleem met die rekeningsaldo, versendingsgoedkeuring of dokumentvereiste op voordat jy die bewerking herhaal.
Geen resultaat nie: Hanteer leë voorraad of 'n ontbrekende bellernaam as 'n gewone uitkoms. Moenie aanneem dat 'n sintakties geldige nommer elke diens het nie.
Netwerktydverstreking of diensfout: Gebruik 'n beperkte aantal herprobeerslae met wagtye tussen pogings vir leesbewerkings. Vir 'n aankoop, versending of registrasie, inspekteer eers die bewerkingstatus; om 'n aanvaarde versoek weer te probeer, kan 'n faktureerbare aksie dupliseer.

Ondersteuning vir idempotensie is spesifiek aan elke API-familie. Die Emergency-API ondersteun sleutels vir herprobeerslae; dit maak nie arbitrêre v3-versoeke idempotent nie. Behou tydstempels, teruggegewe ID's en response waarvan sensitiewe besonderhede verwyder is vir ondersteuning.

Gaan voort met jou rekening se verwysing

Die verwysingsdokumentasie wat jy ná aanmelding sien, filtreer bewerkings volgens jou toestemmings en geaktiveerde dienste. Gebruik die presiese gasheer, tipe aanmeldbesonderhede, versoekvelde en responsskema daarin. Die konsoles kan werklike bewerkings uitvoer, insluitend aankope en die stuur van boodskappe.

Rekeningspesifieke eindpuntkatalogus Kommunikasie-REST-konsole Openbare OpenAPI-dokument vir kommunikasie OAuth-integrasiegids