VertexSMS — API Reference¶
VertexSMS SMS / Viber gateway — 11 operations across 5 areas, from the official docs (vertexsms.com). Auth: access token via the at query parameter. Interactive: the API page.
SMS (2)¶
GET /sms¶
List scheduled messages Returns scheduled messages: id, scheduled, from, to, message, dlrUrl.
| Param | In | Required |
|---|---|---|
scheduled |
query | False |
POST /sms¶
Send SMS Required: to, from, message. Returns a unique message id.
Viber (1)¶
POST /viber¶
Send Viber message Required: to, from, message.
Number Lookup (HLR) (1)¶
POST /hlr¶
Number lookup (HLR) Async. Result delivered to callBackUrl: id, error, imsi, country, operatorId, mcc, mnc, ported[].
Sender ID (2)¶
POST /senderId¶
Register a sender ID
POST /senderId/confirm/{id}¶
Confirm a sender ID
| Param | In | Required |
|---|---|---|
id |
path | True |
Other (5)¶
GET /mccmnc/{country}¶
Get MCC/MNC list for a country
| Param | In | Required |
|---|---|---|
country |
path | True |
Page |
query | False |
POST /numberCorrection¶
Number correction / validation Returns: Error, Number, NumberType (mobile/landline/unknown), CountryIso, Mobile, NumberE164.
GET /operators/{operatorId}¶
Get operator details
| Param | In | Required |
|---|---|---|
operatorId |
path | True |
GET /prefixes/{country}¶
Get prefixes for a country
| Param | In | Required |
|---|---|---|
country |
path | True |
GET /rates/¶
Get rates
| Param | In | Required |
|---|---|---|
format |
query | False |