Petstore logo
API docs by Redocly

RESTAPI description (6.4)

Download OpenAPI specification:Download

Jo Mobile Support: [email protected]

OAuth2.0 auth token

Information about client's profile via RESTAPI

Request Body schema: application/json
username
string
password
string

Responses

Request samples

Content type
application/json
{
  • "username": "LoginName",
  • "password": "Pass"
}

Generating Token via RESTAPI

Request Body schema: application/json
authorization_code
string
password
string

Responses

Request samples

Content type
application/json
{
  • "authorization_code": "b2cdedb10785e36928727a1ffb73aa42"
}

About me

Information about client's profile via RESTAPI

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Responses

Register a customer

Register a new customer via RESTAPI

Register a new customer
By params:
- login - login pf a new account (required)
- password - login pf a new account (required)
- name - name of the responsbale person pf a new account (required)
- phone - phone pf a new account (required)
- email - email pf a new account (required)
- company_name - a company name pf a new account
- skype - skype pf a new account
`

Request Body schema: application/json
login
string
password
string
name
string
phone
string
email
string
skype
string
company_name
integer

Responses

Request samples

Content type
application/json
{
  • "login": "restap141i",
  • "password": "restapirestapi",
  • "name": "Dennis",
  • "phone": "380662185299",
  • "skype": "desrodman",
  • "email": "[email protected]",
  • "company_name": "tralala LTD"
}

Send SMS

Send single and bulk SMS via RESTAPI

Send SMS using access token.
By params:
- number - list of the phone numbers (required)
- senderID - sender ID from which your sms will be send (required)
- text - content of the message (required)
- type - type of message (SMS, HLR, WAPPUSH, FLASHSMS)
- beginDate - plan date where message will go
- beginTime - plan time where message will go
- lifetime - period how long message will live
- delivery - enbale of authomatical back of DLR reports

WARNING: Not more then 100 messages by one package

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Request Body schema: application/json
number
string
senderID
string
text
string
type
string
beginDate
string
beginTime
string
lifetime
integer
delivery
boolean

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get info about sent SMS

Search info about existing SMS for last few days via RESTAPI

Search info about existing SMS for last few days
By params:
- MCC - MCC for search
- MNC - MNC for search (better use togather with MCC)
- sender - senderID
- phone - array of phone numbers
- id_base - array of IDs of the DB
- time_period - time period fpr check
- type_sms - type of the message
- limit - limit of sms in respinse

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Request Body schema: application/json
MCC
integer
MNC
integer
sender
string
phone
string
id_base
string
time_period
string
type_sms
string
limit
integer

Responses

Request samples

Content type
application/json
{
  • "MCC": 224,
  • "MNC": 2,
  • "sender": "SenderID",
  • "phone": [
    ],
  • "id_base": [
    ],
  • "limit": null,
  • "time_period": "2023-02-12 00:00:00 - 2023-02-12 23:59:59",
  • "type_sms": "sms"
}

Working with Group of numbers

View the list of Groups via RESTAPI

Get info about Group of numbers.
By params:
- id_group - id of selected Group
- limit - limit of Groups for view
- offset - page of view

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Request Body schema: application/json
id_group
integer
limit
integer
offset
integer

Responses

Request samples

Content type
application/json
{
  • "id_group": 0,
  • "offset": 0,
  • "limit": 10
}

Create a new Group via RESTAPI

Create a new Group with next credentials
By params:
- name_group - Group name
- time_birth - time sending birthday greetings
- originator_birth - SenderID for birthday greetings
- text_birth - text for birthday greetings
- on_birth - switch of birthday greetings

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Request Body schema: application/json
name_group
string
time_birth
string
originator_birth
string
text_birth
string
on_birth
boolean

Responses

Request samples

Content type
application/json
{
  • "name_group": "bigRest",
  • "time_birth": "23:22",
  • "originator_birth": "aadfd",
  • "text_birth": "Hello #first_name#! Good luck",
  • "on_birth": false
}

Delete the Groups by ID via RESTAPI

Delete the Groups
By params:
- id_group - the list of IDs

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Request Body schema: application/json
id_group
string

Responses

Request samples

Content type
application/json
{
  • "id_group": [
    ]
}

Working with Numbers for Group

Add phone numbers in Group via RESTAPI

Get the list of numbers of Group.
By params:
- id_group - id of Group
- numbers - array of numbers
-- number - the number
-- name - the first name of this number
-- surname - the last name of this number
-- patronymic - the middle name of this number
-- date_birth - the birthdat of this number
-- male - the sex (m or f) of this number
-- note_1 - the additinal field 1 of this number
-- note_2 - the additinal field 2 of this number
-- note_3 - the additinal field 3 of this number
-- note_4 - the additinal field 4 of this number
-- note_5 - the additinal field 5 of this number
-- note_6 - the additinal field 6 of this number
-- note_7 - the additinal field 7 of this number
-- note_8 - the additinal field 8 of this number
-- note_9 - the additinal field 9 of this number
-- note_10 - the additinal field 10 of this number

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Request Body schema: application/json
id_group
integer
numbers
string

Responses

Request samples

Content type
application/json
{
  • "id_group": 13,
  • "numbers": [
    ]
}

Search phone numbers in Group via RESTAPI

Search the list of numbers of Group.
By params:
- id_group - id of Group
- numbers - array of numbers
-- numbers - the numbers list for search

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Request Body schema: application/json
id_group
integer
numbers
string

Responses

Request samples

Content type
application/json
{
  • "id_group": 13,
  • "numbers": [
    ]
}

Delete phone numbers in Group via RESTAPI

Delete the list of numbers of Group.
By params:
- id_group - id of Group
- numbers - array of numbers
-- numbers - the numbers list for search

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Request Body schema: application/json
id_group
integer
numbers
string

Responses

Request samples

Content type
application/json
{
  • "id_group": 13,
  • "numbers": [
    ]
}

Make SMS sending by Group's numbers via RESTAPI

Make SMS sending by Group's numbers.
By params:
- senderID - Sender for sending
- text - Content of SMS
- dateStart - Date of sending
- timeStart - Time of sending begin
- timeStop - Time of sending stop
- phone - the number - id_group - array of groups for sending - id_group_excluded - array of groups for blocking sending

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Request Body schema: application/json
senderID
string
text
string
dateStart
string
timeStart
string
timeStop
string
phone
string
id_group
string
id_group_excluded
string

Responses

Request samples

Content type
application/json
{
  • "senderID": "SMS",
  • "text": "Hello #first_name#, We send sms to #number#",
  • "dateStart": "2022-12-14",
  • "timeStart": "22:30",
  • "timeStop": "22:30",
  • "phone": "12345678822",
  • "id_group": [
    ],
  • "id_group_excluded": [
    ]
}

Working with Personal Black list

Working with list Black list numbers via RESTAPI

Working with list Black list numbers
By params:
- numbers - array of numbers

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Request Body schema: application/json
numbers
string

Responses

Request samples

Content type
application/json
{
  • "numbers": [
    ]
}

Search existing list of numbers in Black list via RESTAPI

Search existing list of numbers in Black list
By params:
- numbers - array of numbers

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Request Body schema: application/json
numbers
string

Responses

Request samples

Content type
application/json
{
  • "numbers": [
    ]
}

Delete existing list of numbers in Black list via RESTAPI

Delete existing list of numbers in Black list
By params:
- numbers - array of numbers

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Request Body schema: application/json
numbers
string

Responses

Request samples

Content type
application/json
{
  • "numbers": [
    ]
}

Refactoring SMS credentials

Make refactoring of SMS data via GET API

Delete existing list of numbers in Black list
By params:
- number - array of numbers - senderID - sender of SMS - text - content of SMS

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Request Body schema: application/json
number
string
senderID
string
text
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Logout (token destroy)

Logout via RESTAPI

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Responses

Additinal REST APIs

Get list of prices by Products via RESTAPI

Get list of prices by Products via
By params:
- ISO - can be set ISO code of country (like US), but not required - MCC - can be set MCC code of country (like 310), but not required - MNC - can be set MNC code of country (like 1), but not required (better use with MCC)

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Request Body schema: application/json
numbers
string

Responses

Request samples

Content type
application/json
{
  • "ISO": "full"
}

Get list of prices by Products via RESTAPI

Get list of prices by Products via
By params:
- ISO - can be set ISO code of country (like US), but not required - MCC - can be set MCC code of country (like 310), but not required - MNC - can be set MNC code of country (like 1), but not required (better use with MCC)

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Request Body schema: application/json
numbers
string

Responses

Request samples

Content type
application/json
{
  • "ISO": "full"
}

Get list of prices by Country via RESTAPI

Get list of prices by Country via
By params:
- ISO - can be set ISO code of country (like US), but not required
- MCC - can be set MCC code of country (like 310), but not required

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Request Body schema: application/json
ISO
string

Responses

Request samples

Content type
application/json
{
  • "ISO": "full"
}

Get list of contries by continents via RESTAPI

Get list of countries by continent

header Parameters
X-Access-Token
required
any
Example: gbBX8dB7kDvBeo0H-VN2CX0bAXXbyJ

Token for RESTAPI

Responses