Operator
Get information about operator from VertexSMS internal database.
GEThttps://api.vertexsms.com/operators/{operatorId}
Return field explanation
| Field | Type | Description |
|---|---|---|
| name | string | Operator name in VertexSMS API |
| country | string | Country code in ISO 3166-1 alpha-2 format |
| mcc | int | Mobile country code MCC list |
| mnc | array | Mobile network code MNC list |
Request example:
REQUEST EXAMPLEGET
GET /operators/493 HTTP/1.1
Host: api.vertexsms.com
Accept: application/json
X-VertexSMS-Token: eB52vNTPL9fO3rDrx8pYmVnj6nqceHNhnqceHNh
Response example:
RESPONSE · 200 OK
HTTP/1.1 200 OK
Content-Type: application/json
Cache-control: no-cache
{"name":"BITE","country":"LT","mcc":"245","mnc":["020","028"]}
Prices
GEThttps://api.vertexsms.com/rates/?format={format}
Input field explanation
| Field | Type | Description |
|---|---|---|
| format | string | 'json' or 'csv' |
Output field explanation
| Field | Type | Description |
|---|---|---|
| CountryName | string | Eg. Taiwan |
| CountryCode | string | Country code in ISO 3166-1 alpha-2 format |
| Operator | string | Operator name, eg. VIBO Telecom |
| Network | string | Network name, eg. VIBO |
| mcc | integer | Mobile country code MCC list |
| mnc | string | Mobile network code MNC list. Can be null |
| Rate | string | Price |
Network and Operator fields can also have values 'All' or 'All other carriers'. It is the default route in both cases. It is named 'All' when there are only one default route, and 'All other carriers' means that in country there is more than one default route.
Request example:
REQUEST EXAMPLEGET
GET /rates/?format=json HTTP/1.1
Host: api.vertexsms.com
Accept: application/json
X-VertexSMS-Token: eB52vNTPL9fO3rDrx8pYmVnj6nqceHNhnqceHNh
Response example:
RESPONSE · 200 OK
HTTP/1.1 200 OK
Content-Type: application/json
Cache-control: no-cache
[{"CountryName":"Abkhazia","CountryCode":"AB","Operator":"Default","Network":"Default","MCC":"289","MNC":null,"Rate":"0.039"},{"CountryName":"Abkhazia","CountryCode":"AB","Operator":"Aquafon JSC","Network":"Aquafon","MCC":"289","MNC":"67","Rate":"0.039"}]
Mobile Country Code (MCC) & Mobile Network Code (MNC) List
Get MCC and MNC list from VertexSMS internal database.
GEThttps://api.vertexsms.com/mccmnc/{country}?Page={Page}
Input field explanation
| Field | Type | Description |
|---|---|---|
| country | string | Country code in ISO 3166-1 alpha-2 format |
| Page | int | Page number |
Return fields explanation
| Field | Type | Description |
|---|---|---|
| country | string | Country code in ISO 3166-1 alpha-2 format |
| mcc | int | Mobile country code |
| mnc | string | Mobile network code |
| operatorId | int | Internal VertexSMS operator identifier. More info |
Request example:
REQUEST EXAMPLEGET
GET /mccmnc/LT?Page=1 HTTP/1.1
Host: api.vertexsms.com
Accept: application/json
X-VertexSMS-Token: eB52vNTPL9fO3rDrx8pYmVnj6nqceHNhnqceHNh
Response example:
RESPONSE · 200 OK
HTTP/1.1 200 OK
Content-Type: application/json
Cache-control: no-cache
[{"country":"LT","MCC":"246","MNC":"01","operatorId":"1891"},{"country":"LT","MCC":"246","MNC":"02","operatorId":"493"}]
Mobile Prefix List
Get prefixes list from VertexSMS internal database.
GEThttps://api.vertexsms.com/prefixes/{country}
Input field explanation
| Field | Type | Description |
|---|---|---|
| country | string | Country code in ISO 3166-1 alpha-2 format |
Return fields explanation
| Field | Type | Description |
|---|---|---|
| prefix | int | Mobile prefix |
| country | string | Country code in ISO 3166-1 alpha-2 format |
| operatorId | integer | Internal VertexSMS operator identifier. More info |
Request example:
REQUEST EXAMPLEGET
GET /prefixes/LT HTTP/1.1
Host: api.vertexsms.com
Accept: application/json
X-VertexSMS-Token: eB52vNTPL9fO3rDrx8pYmVnj6nqceHNhnqceHNh
Response example:
RESPONSE · 200 OK
HTTP/1.1 200 OK
Content-Type: application/json
Cache-control: no-cache
[{"prefix":"3706000","country":"LT","operatorId":"2536"},{"prefix":"3706001","country":"LT","operatorId":"2536"}]
Number Correction
Number correction is a method to fix given number(s) by a given parameters.
GEThttps://api.vertexsms.com/numberCorrection
Input field explanation
| Field | Type | Description |
|---|---|---|
| Number | int | International subscriber number. |
| country | string | Country code in ISO 3166-1 alpha-2 format |
Return fields explanation
| Field | Type | Description |
|---|---|---|
| Error | string | Error description or empty if there is no error |
| Number | int | Original number submitted to API |
| NumberType | string | Number type: mobile, landline, unknown |
| CountryIso | string | Country code in ISO 3166-1 alpha-2 format |
| Mobile | bool | Is the number mobile |
| NumberE164 | string | Fixed number by E164 format |
Request example:
REQUEST EXAMPLEPOST
POST /numberCorrection HTTP/1.1
Host: api.vertexsms.com
Content-Type: application/json
Accept: application/json
X-VertexSMS-Token: eB52vNTPL9fO3rDrx8pYmVnj6nqceHNhnqceHNh
[{"Number":"861860698","CountryIso":"LT"},{"Number":"61860698","CountryIso":"LT"},{"Number":"(370)-618-60698","CountryIso":"LT"}]
Response example:
RESPONSE · 200 OK
HTTP/1.1 200 OK
Content-Type: application/json
Cache-control: no-cache
[ { "Error": null, "Number": "378611463155463", "NumberType": "unknown", "CountryIso": "LT", "Mobile": false, "NumberE164": "+370378611463155463" }, { "Error": null, "Number": "61860698", "NumberType": "mobile", "CountryIso": "LT", "Mobile": true, "NumberE164": "+37061860698" }, { "Error": null, "Number": "37056684554775", "NumberType": "unknown", "CountryIso": "LT", "Mobile": false, "NumberE164": "+37056684554775" }]