Type Definitions
BalanceObject
Type:
Properties- object
| Name | Type | Description |
|---|---|---|
balance_string | string | Balance as string |
balance_float | number | Balance as float number |
balance_number | number | Balance as multiplied by 100 as integer number |
InitProperties
Type:
Properties- object
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
key | string | Service API key | ||
url | string | Service endpoint url | ||
secondUrl | string | <optional> | https://smshub.org/api.php | Used for method `getListOfCountriesAndOperators` (only SMSHUB) |
lang | 'en' | | <optional> | ru | Lang code, smshub can return results with russian or english (Only smshub) |
service | 'smshub' | | Service name | ||
interval | number | <optional> | 2000 | Polling interval of getCode method |
additionalServiceResponse
Type:
Properties- object
| Name | Type | Description |
|---|---|---|
id | string | Status code |
number | string | Text from SMS |
fullSMSTextResponse
Type:
Properties- object
| Name | Type | Attributes | Description |
|---|---|---|---|
status | string | Status code | |
text | string | <optional> | Text from SMS. Is returning _**only if status is not `STATUS_WAIT_CODE`, `STATUS_CANCEL`**_ |
getCodeResponse
Type:
Properties- object
| Name | Type | Description |
|---|---|---|
status | string | Status code |
code | string | | Code from SMS |
getCodeResponse
Type:
Properties- object
| Name | Type | Description |
|---|---|---|
status | string | Status code |
code | string | | Code from SMS. Is returning _**only with `STATUS_WAIT_RETRY`, `STATUS_OK` statuses**_ |