Begin hier om plaaslike nommers te vind. Die lys bevat slegs lande wat tans nommers in voorraad het. Dit reserveer niks nie.
- Gee
isocodedeur aangetareas, aangetstates(slegs US en CA) of aanother. next_functionwys altyd nav3/getareas/{isocode}. Vir die Verenigde State en Kanada kan u eersgetstatesaanroep om die keuse volgens deelstaat of provinsie te beperk.is_mobileensms_coverageis aanwysers op landvlak, nie waarborge vir elke nommer nie. Vir die Verenigde State geld die volgende:is_mobileis0tensy u rekening vir selfoonnommers in die Verenigde State geaktiveer is.- Lande met dekking wat slegs op bestelling beskikbaar is, word nie gelys nie. U kan steeds
getareasofotherdirek aanroep vir 'n land wat nie gelys is nie. - Sorteer die lys self indien u 'n bepaalde volgorde benodig.
Indien geen land kwalifiseer nie, geld die volgende: response is null en status.code is 200.
Versoek
Vereis: HTTP Basic of 'n Bearer-token (sien Stawing en API-antwoorde). Mislukte stawing word met HTTP 401 beantwoord voordat die opsoek uitgevoer word.
GET sonder 'n versoekliggaam. Die enigste parameter is die opsionele pid, wat in die navraagstring gestuur word.
curl --user "$API_USER:$API_PASSWORD" 'https://api.multitel.net/v3/getcountries'| Naam | Tipe | Vereis | Beskrywing |
|---|---|---|---|
pid | string | Nee | Gevorderd en opsioneel. Beperk die lys tot lande wat vir een voorraadbron gemerk is. Gebruik slegs 'n waarde wat deur MultiTEL verskaf is, in numeriese vorm of in heksadesimale vorm met 32 karakters, en laat dit vir normale gebruik weg. pid beperk nie die voorraadkontrole wat in die antwoord beskryf word nie. Onherkende waardes, nul en waardes wat hierdie eindpunt nie aanvaar nie, word sonder 'n fout geïgnoreer; die lys dek dan alle ondersteunde bronne. |
Antwoord
Standaard omhulsel. By sukses is status.code 200, status.msg is 'Results: N', status.results is N, en response is 'n lys lande sonder 'n gewaarborgde volgorde. Velde: countrycode (land se skakelkode sonder '+'); name (landnaam); description (dieselfde waarde as name); isocode (ISO 3166-1 alpha-2-kode); is_mobile (0 of 1, 'n katalogusaanwyser op landvlak, altyd 0 vir US tensy u rekening vir selfoonnommers in US geaktiveer is); sms_coverage (0 of 1, 'n katalogusaanwyser op landvlak); latitude en longitude (land se koördinate); next_function ('v3/getareas/{isocode}'). 'n Land word slegs gelys indien dit sigbaar is en minstens een van sy voorvoegsels tans voorraad in enige voorraadbron het. Lande waarvan die dekking geheel en al slegs op bestelling beskikbaar is (geen voorraad nie), word nie gelys nie. Hierdie voorraadkontrole is breër as die filters wat getareas toepas, dus kan 'n gelyste land soms daar 'No areas found' teruggee. Indien geen land kwalifiseer nie, is status.code 200, status.msg is 'Results: 0', daar is geen status.results-veld nie, en response is null.
Voorbeeld van die antwoordstruktuur; dit is nie regstreekse rekeningdata of 'n huidige kwotasie nie.
{
"status": {
"code": 200,
"msg": "Results: 2",
"results": 2
},
"response": [
{
"countrycode": "1",
"name": "United States",
"description": "United States",
"isocode": "US",
"is_mobile": 0,
"sms_coverage": 1,
"latitude": "38.0000",
"longitude": "-97.0000",
"next_function": "v3/getareas/US"
},
{
"countrycode": "44",
"name": "United Kingdom",
"description": "United Kingdom",
"isocode": "GB",
"is_mobile": 1,
"sms_coverage": 0,
"latitude": "54.0000",
"longitude": "-2.0000",
"next_function": "v3/getareas/GB"
}
]
}Foute
- 401: Stawing ontbreek of het misluk. Word met HTTP-status 401 gestuur (sien Stawing en API-antwoorde).
Beskikbaarheid en newe-effekte
- Slegs 'n opsoek. Dit reserveer, bestel of verander niks nie.
- Resultate weerspieël die voorraad ten tyde van die versoek en kan tussen aanroepe verander.