We use cookies to improve your experience on this site and serve more relevant content to you. By continuing to browse our site you agree to our use of cookies, revised Privacy Policy and Terms of Service.  More information about cookies

Operator

Get information about operator from VertexSMS internal database.

GET https://api.vertexsms.com/operators/{operatorId}

Return field explanation
Field
Type
Description
Field name
Type string
Description Operator name in VertexSMS API
Field country
Type string
Description Country code in ISO 3166-1 alpha-2 format
Field mcc
Type int
Description Mobile country code MCC list
Field mnc
Type array
Description Mobile network code MNC list

Request example:

GET /operators/493 HTTP/1.1
Host: api.vertexsms.com
Accept: application/json
X-VertexSMS-Token: eB52vNTPL9fO3rDrx8pYmVnj6nqceHNhnqceHNh

Response example:

HTTP/1.1 200 OK
Content-Type: application/json
Cache-control: no-cache

{“name”:”BITE”,”country”:”LT”,”mcc”:”245”,”mnc”:[“020”,”028”]}

Prices

GET https://api.vertexsms.com/rates/?format={format}

Input field explanation
Field
Type
Description
Field format
Type string
Description ‘json’ or ‘csv’
Input field explanation
Field
Type
Description
Field CountryName
Type string
Description Eg. Taiwan
Field CountryCode
Type string
Description Country code in ISO 3166-1 alpha-2 format
Field Operator
Type string
Description Operator name, eg. VIBO Telecom
Field Network
Type string
Description Network name, eg. VIBO
Field mcc
Type integer
Description Mobile country code MCC list
Field mnc
Type string
Description Mobile network code MNC list. Can be null
Field Rate
Type string
Description 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:

GET /rates/?format=json HTTP/1.1
Host: api.vertexsms.com
Accept: application/json
X-VertexSMS-Token: eB52vNTPL9fO3rDrx8pYmVnj6nqceHNhnqceHNh

Response example:

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.

GET https://api.vertexsms.com/mccmnc/{country}?Page={Page}

Input field explanation
Field
Type
Description
Field country
Type string
Description Country code in ISO 3166-1 alpha-2 format
Field Page
Type int
Description Page number
Return fields explanation
Field
Type
Description
Field country
Type string
Description Country code in ISO 3166-1 alpha-2 format
Field mcc
Type int
Description Mobile country code
Field mnc
Type string
Description Mobile network code
Field operatorId
Type int
Description Internal VertexSMS operator identifier. More info

Request example:

GET /mccmnc/LT?Page=1 HTTP/1.1
Host: api.vertexsms.com
Accept: application/json
X-VertexSMS-Token: eB52vNTPL9fO3rDrx8pYmVnj6nqceHNhnqceHNh

Response example:

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.

GET https://api.vertexsms.com/prefixes/{country}

Input field explanation
Field
Type
Description
Field country
Type string
Description Country code in ISO 3166-1 alpha-2 format
Return fields explanation
Field
Type
Description
Field prefix
Type int
Description Mobile prefix
Field country
Type string
Description Country code in ISO 3166-1 alpha-2 format
Field operatorId
Type integer
Description Internal VertexSMS operator identifier. More info

Request example:

GET /prefixes/LT HTTP/1.1
Host: api.vertexsms.com
Accept: application/json
X-VertexSMS-Token: eB52vNTPL9fO3rDrx8pYmVnj6nqceHNhnqceHNh

Response example:

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.

GET https://api.vertexsms.com/numberCorrection

Input field explanation
Field
Type
Description
Field Number
Type int
Description International subscriber number.
Field country
Type string
Description Country code in ISO 3166-1 alpha-2 format
Return fields explanation
Field
Type
Description
Field Error
Type string
Description Error description or empty if there is no error
Field Number
Type int
Description Original number submitted to API
Field NumberType
Type string
Description Number type: mobile, landline, unknown
Field CountryIso
Type string
Description Country code in ISO 3166-1 alpha-2 format
Field Mobile
Type bool
Description Is the number mobile
Field NumberE164
Type string
Description Fixed number by E164 format

Request example:

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:

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” }]