Classes
Type Definitions
AddressBook
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
id |
number | Address book identifier |
name |
string | Address book name |
phones |
number | Number of phone numbers in address book |
exceptions |
number | Number of phone numbers in address book exceptions |
creationdate |
string | Address book creation date |
description |
string | Address book description |
Address book data
Type:
- Object
AddressBookClonedResponse
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
idAddressBook |
number | id of the created address book |
successful |
boolean | result |
Response data for address book clone request
Type:
- Object
AddressBookSearchFields
- Source:
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
name |
module:epochta-client.SearchField |
<optional> |
|
phones |
module:epochta-client.SearchField |
<optional> |
|
date |
module:epochta-client.SearchField |
<optional> |
Search params object
Type:
- Object
Balance
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
currency |
module:epochta-client.Currency | current currency |
balance_currency |
number | balance in current currency |
Balance
Type:
- Object
CampaignDeliveryStats
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
phone |
Array.<number> | phone numbers |
sentdate |
Array.<string> | when was sent |
donedate |
Array.<string> | when was done |
status |
Array.<string> |
Statuses: | Status | Description | |-----------------------|---------------------| | 0 |Pending | | SENT |Sent | | DELIVERED |Delivered | | NOT_DELIVERED |Not delivered | | INVALID_PHONE_NUMBER |Invalid phone number | | SPAM |Spam |
Type:
- Object
CampaignInfo
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
sent |
number | number of sent SMS that been sent |
delivered |
number | number of delivered SMS |
not_delivered |
number | number of not delivered SMS |
price |
number | campaign price |
status |
number |
Statuses:
- Pending
- Not enough money
- In progress
- Done
- Incorect phone numbers
- Done partially
- SPAM
- Wrong sender name
- Paused
- Planned
- Moderation
Type:
- Object
CampaignList
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
id |
Array.<number> | campaign id |
from |
Array.<string> | sender |
body |
Array.<string> | message |
status |
Array.<string> |
Statuses:
- Pending
- Not enough money
- In progress
- Done
- Incorect phone numbers
- Done partially
- SPAM
- Wrong sender name
- Paused
- Planned
- Moderation
Type:
- Object
Currency
- Source:
Currency
Type:
- 'USD' | 'GBP' | 'UAH' | 'RUB' | 'EUR'
PhoneException
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
id |
number | unique id |
phone |
number | phone number |
added |
string | creation date |
comment |
string | description |
Phone number exception
Type:
- Object
PhoneNumber
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
id |
number | unique id |
addressbook |
number | id of address book |
phone |
number | phone number |
normalphone |
number | phone number according to international standard |
variables |
string | personalization variables separated with semicolon |
status |
string | phone number status |
Phone number data
Type:
- Object
PhoneNumberSearchFields
- Source:
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
normalPhone |
module:epochta-client.SearchField |
<optional> |
|
phones |
module:epochta-client.SearchField |
<optional> |
|
idAddressBook |
module:epochta-client.SearchField |
<optional> |
|
variables |
module:epochta-client.SearchField |
<optional> |
|
status |
module:epochta-client.SearchField |
<optional> |
Search params object
Type:
- Object
SearchField
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
operation |
string | comparison operator, one of ('like', '=', '>', '>=', '<', '<=') |
value |
string | value to compare to |
Search field object
Type:
- Object
SenderName
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
id |
number | sender id |
name |
string | sender name |
country |
string | registration country |
status |
0 | 1 | 2 | 0-moderation; 1-approved; 2-rejected |
Sender name
Type:
- Object
SenderShortName
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
name_id |
number | sender name id |
status |
0 | 1 | 2 | 0-moderation; 1-approved; 2-rejected |
Sender name registration response
Type:
- Object
TaskInfo
- Source:
Properties:
| Name | Type | Description |
|---|---|---|
id |
number | campaign id |
phone |
number | phone number |
country |
number | country code |
parts |
number | number of campaign parts |
sentdate |
string | when was sent |
donedate |
string | when was done |
price |
number | campaign price |
status |
string | campaign status |
variable |
string | personalization variables |
currency |
string |
Task info
Type:
- Object
APIKeys
Properties:
| Name | Type | Description |
|---|---|---|
publicKey |
string | public API key |
privateKey |
string | private API key |
API keys provided by ePochta SMS service
Type:
- Object