Justsend API Documentation

Using the API is possible after prior registration on justsend.pl and activating the account. In addition to the following documentation, API documentation has been prepared based on the Swagger framework. This documentation has been made available at https://justsend.io/api/swagger-ui/index.html

The interface to the justsend application is available at https://justsend.io/api. It has been implemented in accordance with the REST architecture. Communication consists in sending an HTTP request to the above-mentioned address and forwarding the required data. The required data, depending on the method called, is passed in the URL parameters of the GET request or in JSON format for POST and PUT requests. The response is always returned in JSON format.

All requests sent to the API should contain a unique API access key (appKey), assigned at the time of registration to justsend.pl. This key can be changed at any time in user's panel. AppKey is given by the header in the request (request header).

Methods

[ Jump to Models ]

Table of Contents

Blacklist

BulkSMS

Payment

SendHistory

SingleSMS

Blacklist

Up 
post /blacklist/add
Add user blacklisted recipients. (addRecipientsToBlacklist)
Add user blacklisted recipients provided as JSON table. MSISDN numbers in invalid format are skipped.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter —

Query parameters

forUserId (optional)
Query Parameter — format: int64

Responses

200

OK
Up 
get /blacklist/get
Get user blacklisted recipients with pagination (getBlacklistedRecipients)

Query parameters

page (optional)
Query Parameter — Page number (0-based) format: int32
size (optional)
Query Parameter — Page size (default 25) format: int32
sortField (optional)
Query Parameter — Sorting field
sortDirection (optional)
Query Parameter — Sorting direction (ASC or DESC)

Return type

PageableResponseString

Example data

Content-Type: application/json
{
  "totalPages" : 0,
  "content" : [ "content", "content" ],
  "totalElements" : 6
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PageableResponseString
Up 
put /blacklist/remove
Remove user blacklisted recipients. (removeRecipientsFromBlacklist)
Remove user blacklisted recipients provided as JSON table.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter —

Responses

200

OK

BulkSMS

Up 
delete /sender/bulk/{uuid}
Cancel bulk (cancelBulk)
Cancel a bulk by its ID if the bulk belongs to the user.

Path parameters

uuid (required)
Path Parameter — ID of the bulk to be canceled format: uuid

Responses

200

Bulk successfully canceled

400

Bulk cancellation error

403

User is not the owner of the bulk

404

Bulk not found
Up 
post /upload/bulk
Upload file and bulk data (fileUpload)
Uploads a file and bulk data as JSON.

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

request (required)
Form Parameter —
file (required)
Form Parameter — format: binary

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful operation

400

Invalid request parameters ProblemDetail

500

Internal server error ProblemDetail
Up 
get /upload/bulk/descriptors
Get bulk file descriptors (getBulkFileDescriptors)
Fetch paginated list of bulk file descriptors with optional filters.

Query parameters

days (optional)
Query Parameter — format: int32
importStatus (optional)
Query Parameter —
page (required)
Query Parameter — Page number, zero-based format: int32
size (required)
Query Parameter — Page size format: int32
sortDirection (optional)
Query Parameter — ASC or DESC
sortField (optional)
Query Parameter —

Return type

PageableResponseBulkFileDescriptor

Example data

Content-Type: application/json
{
  "totalPages" : 1,
  "content" : [ {
    "originalFileName" : "originalFileName",
    "path" : "path",
    "importStatus" : "PENDING",
    "importResult" : {
      "code" : "code",
      "success" : true,
      "message" : "message"
    },
    "uploadType" : "blacklist",
    "bulkUploadDetails" : {
      "requestMetadata" : {
        "userAgent" : "userAgent",
        "requestSource" : "requestSource"
      },
      "sender" : "sender",
      "sendDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "bulkPriority" : "NORMAL",
      "to" : "to",
      "bulkVariant" : "ECO",
      "message" : "message",
      "bulkType" : "STANDARD"
    },
    "id" : 0,
    "userId" : 6,
    "uuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "createDate" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "originalFileName" : "originalFileName",
    "path" : "path",
    "importStatus" : "PENDING",
    "importResult" : {
      "code" : "code",
      "success" : true,
      "message" : "message"
    },
    "uploadType" : "blacklist",
    "bulkUploadDetails" : {
      "requestMetadata" : {
        "userAgent" : "userAgent",
        "requestSource" : "requestSource"
      },
      "sender" : "sender",
      "sendDate" : "2000-01-23T04:56:07.000+00:00",
      "name" : "name",
      "bulkPriority" : "NORMAL",
      "to" : "to",
      "bulkVariant" : "ECO",
      "message" : "message",
      "bulkType" : "STANDARD"
    },
    "id" : 0,
    "userId" : 6,
    "uuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "createDate" : "2000-01-23T04:56:07.000+00:00"
  } ],
  "totalElements" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfully fetched bulk file descriptors PageableResponseBulkFileDescriptor

400

Invalid request parameters ProblemDetail

500

Internal server error ProblemDetail
Up 
post /sender/bulk/send
Save and start bulk process (saveAndStartProcessBulk)
Saves the bulk details and starts the process with the provided recipients.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body RestBulkData (required)
Body Parameter —

Return type

String

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Bulk process started successfully String

400

Invalid input data String

Payment

Up 
get /payment/transaction
Get payment transactions (getPaymentTransactions)
Get logged user payment transactions in JSON format

Query parameters

paymentProvider (optional)
Query Parameter —
paymentMethod (optional)
Query Parameter —
transactionStatus (optional)
Query Parameter —
startDate (required)
Query Parameter — format: date-time
endDate (required)
Query Parameter — format: date-time
search (optional)
Query Parameter — Like search for id field. Min 3 characters long
page (optional)
Query Parameter — Page number (0-based) format: int32
size (optional)
Query Parameter — Page size (default 25) format: int32
sortField (optional)
Query Parameter — Sorting field
sortDirection (optional)
Query Parameter — Sorting direction (ASC or DESC)

Return type

PageableResponsePaymentTransactionEntity

Example data

Content-Type: application/json
{
  "totalPages" : 4,
  "content" : [ {
    "transactionError" : "NONE",
    "amountInPoints" : 5.962133916683182,
    "transactionStatus" : "PENDING",
    "platformType" : "PL",
    "accountBalanceInPoints" : 5.637376656633329,
    "transactionDate" : "2000-01-23T04:56:07.000+00:00",
    "userId" : 6,
    "version" : 7,
    "invoicingStatus" : "INITIALIZE",
    "transactionType" : "CHARGE",
    "bulkId" : 2,
    "paymentProvider" : "PAYU",
    "modifiedDate" : "2000-01-23T04:56:07.000+00:00",
    "paymentMethod" : "BLIK",
    "internalTransactionId" : "internalTransactionId",
    "id" : 0,
    "externalTransactionId" : "externalTransactionId",
    "invoice" : {
      "proformaId" : 2,
      "invoiceNumber" : "invoiceNumber",
      "invoiceId" : 3,
      "id" : 9,
      "proformaNumber" : "proformaNumber"
    },
    "transactionValue" : {
      "amount" : 1.4658129805029452,
      "currency" : "PLN"
    },
    "createDate" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "transactionError" : "NONE",
    "amountInPoints" : 5.962133916683182,
    "transactionStatus" : "PENDING",
    "platformType" : "PL",
    "accountBalanceInPoints" : 5.637376656633329,
    "transactionDate" : "2000-01-23T04:56:07.000+00:00",
    "userId" : 6,
    "version" : 7,
    "invoicingStatus" : "INITIALIZE",
    "transactionType" : "CHARGE",
    "bulkId" : 2,
    "paymentProvider" : "PAYU",
    "modifiedDate" : "2000-01-23T04:56:07.000+00:00",
    "paymentMethod" : "BLIK",
    "internalTransactionId" : "internalTransactionId",
    "id" : 0,
    "externalTransactionId" : "externalTransactionId",
    "invoice" : {
      "proformaId" : 2,
      "invoiceNumber" : "invoiceNumber",
      "invoiceId" : 3,
      "id" : 9,
      "proformaNumber" : "proformaNumber"
    },
    "transactionValue" : {
      "amount" : 1.4658129805029452,
      "currency" : "PLN"
    },
    "createDate" : "2000-01-23T04:56:07.000+00:00"
  } ],
  "totalElements" : 7
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PageableResponsePaymentTransactionEntity

SendHistory

Up 
get /overview/bulks/{uuid}/invalid-recipients
(exportInvalidRecipientsToCsv)

Path parameters

uuid (required)
Path Parameter — format: uuid

Query parameters

userId (required)
Query Parameter — format: int64

Responses

200

OK
Up 
get /overview/singlemessages
(getAggregatedSingleMessages)

Query parameters

startDate (optional)
Query Parameter — format: date-time
endDate (optional)
Query Parameter — format: date-time
showSlave (optional)
Query Parameter — default: false
page (optional)
Query Parameter — Page number, zero-based default: 0 format: int32
size (optional)
Query Parameter — Page size default: 10 format: int32

Return type

PageableResponseSingleMessageOverviewAggregation

Example data

Content-Type: application/json
{
  "totalPages" : 9,
  "content" : [ {
    "chargedPoints" : 5.962133916683182,
    "messageCount" : 5,
    "sendDate" : "2000-01-23T04:56:07.000+00:00",
    "recordCount" : 1,
    "undeliveredCount" : 7,
    "userId" : 0,
    "userMasterId" : 6,
    "acknowledgeStatus" : "DELIVERED",
    "sender" : "sender",
    "userEmail" : "userEmail",
    "deliveredCount" : 2,
    "userAccountType" : "SLAVE",
    "bulkVariant" : "ECO",
    "userPlatformType" : "PL"
  }, {
    "chargedPoints" : 5.962133916683182,
    "messageCount" : 5,
    "sendDate" : "2000-01-23T04:56:07.000+00:00",
    "recordCount" : 1,
    "undeliveredCount" : 7,
    "userId" : 0,
    "userMasterId" : 6,
    "acknowledgeStatus" : "DELIVERED",
    "sender" : "sender",
    "userEmail" : "userEmail",
    "deliveredCount" : 2,
    "userAccountType" : "SLAVE",
    "bulkVariant" : "ECO",
    "userPlatformType" : "PL"
  } ],
  "totalElements" : 3
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PageableResponseSingleMessageOverviewAggregation
Up 
get /overview/bulks
(getAllBulks)

Query parameters

showSlave (optional)
Query Parameter — default: false
fromDate (optional)
Query Parameter — format: date-time
toDate (optional)
Query Parameter — format: date-time
bulkStatus (optional)
Query Parameter —
page (optional)
Query Parameter — Page number, zero-based default: 0 format: int32
size (optional)
Query Parameter — Page size default: 10 format: int32
sortDirection (optional)
Query Parameter — ASC or DESC
sortField (optional)
Query Parameter —

Return type

PageableResponseBulkOverviewEntity

Example data

Content-Type: application/json
{
  "totalPages" : 1,
  "content" : [ {
    "sendDate" : "2000-01-23T04:56:07.000+00:00",
    "predictedFinishDate" : "2000-01-23T04:56:07.000+00:00",
    "undeliveredCount" : 2,
    "uuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sentCount" : 7,
    "recipientsCount" : 2,
    "notSentCount" : 4,
    "userEmail" : "userEmail",
    "pointsPerSms" : 7,
    "id" : 0,
    "userPlatformType" : "PL",
    "createDate" : "2000-01-23T04:56:07.000+00:00",
    "chargedPoints" : 5.962133916683182,
    "reportId" : 1,
    "totalMessageCount" : 5,
    "reportStatus" : "IN_PROGRESS",
    "sentUnconfirmedCount" : 3,
    "message" : "message",
    "userId" : 6,
    "userMasterId" : 1,
    "bulkType" : "STANDARD",
    "bulkStatus" : "bulkStatus",
    "sender" : "sender",
    "name" : "name",
    "deliveredCount" : 9,
    "userAccountType" : "SLAVE",
    "bulkVariant" : "ECO"
  }, {
    "sendDate" : "2000-01-23T04:56:07.000+00:00",
    "predictedFinishDate" : "2000-01-23T04:56:07.000+00:00",
    "undeliveredCount" : 2,
    "uuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sentCount" : 7,
    "recipientsCount" : 2,
    "notSentCount" : 4,
    "userEmail" : "userEmail",
    "pointsPerSms" : 7,
    "id" : 0,
    "userPlatformType" : "PL",
    "createDate" : "2000-01-23T04:56:07.000+00:00",
    "chargedPoints" : 5.962133916683182,
    "reportId" : 1,
    "totalMessageCount" : 5,
    "reportStatus" : "IN_PROGRESS",
    "sentUnconfirmedCount" : 3,
    "message" : "message",
    "userId" : 6,
    "userMasterId" : 1,
    "bulkType" : "STANDARD",
    "bulkStatus" : "bulkStatus",
    "sender" : "sender",
    "name" : "name",
    "deliveredCount" : 9,
    "userAccountType" : "SLAVE",
    "bulkVariant" : "ECO"
  } ],
  "totalElements" : 1
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PageableResponseBulkOverviewEntity
Up 
get /overview/bulks/{uuid}
(getBulkByUuid)

Path parameters

uuid (required)
Path Parameter —

Return type

BulkOverviewEntity

Example data

Content-Type: application/json
{
  "sendDate" : "2000-01-23T04:56:07.000+00:00",
  "predictedFinishDate" : "2000-01-23T04:56:07.000+00:00",
  "undeliveredCount" : 2,
  "uuid" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "sentCount" : 7,
  "recipientsCount" : 2,
  "notSentCount" : 4,
  "userEmail" : "userEmail",
  "pointsPerSms" : 7,
  "id" : 0,
  "userPlatformType" : "PL",
  "createDate" : "2000-01-23T04:56:07.000+00:00",
  "chargedPoints" : 5.962133916683182,
  "reportId" : 1,
  "totalMessageCount" : 5,
  "reportStatus" : "IN_PROGRESS",
  "sentUnconfirmedCount" : 3,
  "message" : "message",
  "userId" : 6,
  "userMasterId" : 1,
  "bulkType" : "STANDARD",
  "bulkStatus" : "bulkStatus",
  "sender" : "sender",
  "name" : "name",
  "deliveredCount" : 9,
  "userAccountType" : "SLAVE",
  "bulkVariant" : "ECO"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK BulkOverviewEntity
Up 
get /overview/user-history
(getSendStats)

Query parameters

showSlave (optional)
Query Parameter — default: false
fromDate (required)
Query Parameter — format: date-time
toDate (required)
Query Parameter — format: date-time
bulkVariant (optional)
Query Parameter —
msisdn (required)
Query Parameter —
page (optional)
Query Parameter — Page number, zero-based default: 0 format: int32
size (optional)
Query Parameter — Page size default: 14 format: int32
sortDirection (optional)
Query Parameter — ASC or DESC
sortField (optional)
Query Parameter —

Return type

PageableResponseUserHistory

Example data

Content-Type: application/json
{
  "totalPages" : 5,
  "content" : [ {
    "messageCount" : 1,
    "sendDate" : "2000-01-23T04:56:07.000+00:00",
    "type" : "type",
    "userId" : 0,
    "userMasterId" : 6,
    "content" : "content",
    "acknowledgeStatus" : "DELIVERED",
    "sender" : "sender",
    "name" : "name",
    "userEmail" : "userEmail",
    "bulkVariant" : "ECO",
    "msisdn" : "msisdn",
    "carrierId" : 5,
    "deliveryDate" : "2000-01-23T04:56:07.000+00:00"
  }, {
    "messageCount" : 1,
    "sendDate" : "2000-01-23T04:56:07.000+00:00",
    "type" : "type",
    "userId" : 0,
    "userMasterId" : 6,
    "content" : "content",
    "acknowledgeStatus" : "DELIVERED",
    "sender" : "sender",
    "name" : "name",
    "userEmail" : "userEmail",
    "bulkVariant" : "ECO",
    "msisdn" : "msisdn",
    "carrierId" : 5,
    "deliveryDate" : "2000-01-23T04:56:07.000+00:00"
  } ],
  "totalElements" : 2
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PageableResponseUserHistory
Up 
get /overview/send-stats
(getSendStats1)

Query parameters

showSlave (optional)
Query Parameter — default: false
fromDate (required)
Query Parameter — format: date-time
toDate (required)
Query Parameter — format: date-time
bulkVariant (optional)
Query Parameter —
page (optional)
Query Parameter — Page number, zero-based default: 0 format: int32
size (optional)
Query Parameter — Page size default: 14 format: int32
sortDirection (optional)
Query Parameter — ASC or DESC
sortField (optional)
Query Parameter —

Return type

PageableResponseSendStatistics

Example data

Content-Type: application/json
{
  "totalPages" : 2,
  "content" : [ {
    "recipientsCount" : 0,
    "sendDate" : "2000-01-23T04:56:07.000+00:00",
    "deliveredCount" : 5,
    "messagesCount" : 6,
    "sentCount" : 1,
    "notDeliveredCount" : 5
  }, {
    "recipientsCount" : 0,
    "sendDate" : "2000-01-23T04:56:07.000+00:00",
    "deliveredCount" : 5,
    "messagesCount" : 6,
    "sentCount" : 1,
    "notDeliveredCount" : 5
  } ],
  "totalElements" : 7
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK PageableResponseSendStatistics
Up 
get /overview/send-stats/sum
(getSendStatsSum)

Query parameters

showSlave (optional)
Query Parameter — default: false
fromDate (required)
Query Parameter — format: date-time
toDate (required)
Query Parameter — format: date-time
bulkVariant (optional)
Query Parameter —

Return type

SendStatistics

Example data

Content-Type: application/json
{
  "recipientsCount" : 0,
  "sendDate" : "2000-01-23T04:56:07.000+00:00",
  "deliveredCount" : 5,
  "messagesCount" : 6,
  "sentCount" : 1,
  "notDeliveredCount" : 5
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK SendStatistics

SingleSMS

Up 
post /sender/singlemessage/send
Send a single message (sendSingleMessage)
Allows an authenticated user to send a single message.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body SingleMessage (required)
Body Parameter — Example request body supporting JSON and XML

Responses

204

Message sent successfully.

400

Invalid input data.

500

Unexpected server error.

Models

[ Jump to Methods ]

Table of Contents

  1. BulkFileDescriptor
  2. BulkOverviewEntity
  3. BulkUploadDetails
  4. FileUploadRequest
  5. ImportResult
  6. InvoiceEntity
  7. Money
  8. PageableResponseBulkFileDescriptor
  9. PageableResponseBulkOverviewEntity
  10. PageableResponsePaymentTransactionEntity
  11. PageableResponseSendStatistics
  12. PageableResponseSingleMessageOverviewAggregation
  13. PageableResponseString
  14. PageableResponseUserHistory
  15. PaymentTransactionEntity
  16. ProblemDetail
  17. RequestMetadata
  18. RestBulkData
  19. RestRecipient
  20. SendStatistics
  21. SingleMessage
  22. SingleMessageOverviewAggregation
  23. UserHistory
  24. upload_bulk_body

BulkFileDescriptor Up

Bulk file descriptor details
id (optional)
Long ID of the bulk file format: int64
path (optional)
String Path to the file
createDate (optional)
Date Date when the file was created format: date-time
uploadType (optional)
String Type of upload
Enum:
blacklist
blacklist-to-remove
group
bulk
importStatus (optional)
String Import status
Enum:
PENDING
SUCCESS
CANCELED
originalFileName (optional)
String Original file name
userId (optional)
Long ID of the user who uploaded the file format: int64
uuid (optional)
UUID Unique identifier format: uuid
importResult (optional)
ImportResult
bulkUploadDetails (optional)
BulkUploadDetails

BulkOverviewEntity Up

List of content items
id (optional)
Long format: int64
userId (optional)
Long format: int64
userEmail (optional)
String
userAccountType (optional)
String
Enum:
SLAVE
MASTER
ADMIN
userMasterId (optional)
Long format: int64
userPlatformType (optional)
String
Enum:
PL
FR
name (optional)
String
uuid (optional)
UUID format: uuid
bulkType (optional)
String
Enum:
STANDARD
PERSONALIZED
PARAMETRIZED
bulkVariant (optional)
String
Enum:
ECO
FULL
PRO
ECO_RESP
PRO_RESP
bulkStatus (optional)
String
sender (optional)
String
message (optional)
String
chargedPoints (optional)
BigDecimal
sendDate (optional)
Date format: date-time
createDate (optional)
Date format: date-time
totalMessageCount (optional)
Long format: int64
recipientsCount (optional)
Long format: int64
sentCount (optional)
Long format: int64
deliveredCount (optional)
Long format: int64
sentUnconfirmedCount (optional)
Long format: int64
undeliveredCount (optional)
Long format: int64
notSentCount (optional)
Long format: int64
predictedFinishDate (optional)
Date format: date-time
pointsPerSms (optional)
Long format: int64
reportId (optional)
Long format: int64
reportStatus (optional)
String
Enum:
IN_PROGRESS
COMPLETED
FAILED

BulkUploadDetails Up

Details of the bulk upload
name (optional)
String
bulkType (optional)
String
Enum:
STANDARD
PERSONALIZED
PARAMETRIZED
bulkVariant (optional)
String
Enum:
ECO
FULL
PRO
ECO_RESP
PRO_RESP
bulkPriority (optional)
String
Enum:
NORMAL
ALERT
sender (optional)
String
to (optional)
String
message (optional)
String
sendDate (optional)
Date format: date-time
requestMetadata (optional)
RequestMetadata

FileUploadRequest Up

name
String
sender
String
to (optional)
array[String]
message (optional)
String
groupId (optional)
Long format: int64
bulkType
String
Enum:
STANDARD
PERSONALIZED
PARAMETRIZED
bulkVariant
String
Enum:
ECO
FULL
PRO
ECO_RESP
PRO_RESP
bulkPriority (optional)
String
Enum:
NORMAL
ALERT
sendDate
Date format: date-time

ImportResult Up

Result of the import operation
message (optional)
String
code (optional)
String
success (optional)
Boolean

InvoiceEntity Up

id (optional)
Long format: int64
invoiceId (optional)
Long format: int64
invoiceNumber (optional)
String
proformaId (optional)
Long format: int64
proformaNumber (optional)
String

Money Up

Field for money deposit operation only. For charge operation is zero - charge is always in points
amount
BigDecimal
currency
String
Enum:
PLN

PageableResponseBulkFileDescriptor Up

Paginated response
content (optional)
array[BulkFileDescriptor] List of content items
totalPages (optional)
Integer Total number of pages format: int32
totalElements (optional)
Long Total number of elements format: int64

PageableResponseBulkOverviewEntity Up

Paginated response
content (optional)
array[BulkOverviewEntity] List of content items
totalPages (optional)
Integer Total number of pages format: int32
totalElements (optional)
Long Total number of elements format: int64

PageableResponsePaymentTransactionEntity Up

Paginated response
content (optional)
array[PaymentTransactionEntity] List of content items
totalPages (optional)
Integer Total number of pages format: int32
totalElements (optional)
Long Total number of elements format: int64

PageableResponseSendStatistics Up

Paginated response
content (optional)
array[SendStatistics] List of content items
totalPages (optional)
Integer Total number of pages format: int32
totalElements (optional)
Long Total number of elements format: int64

PageableResponseSingleMessageOverviewAggregation Up

Paginated response
content (optional)
array[SingleMessageOverviewAggregation] List of content items
totalPages (optional)
Integer Total number of pages format: int32
totalElements (optional)
Long Total number of elements format: int64

PageableResponseString Up

Paginated response
content (optional)
array[String] List of content items
totalPages (optional)
Integer Total number of pages format: int32
totalElements (optional)
Long Total number of elements format: int64

PageableResponseUserHistory Up

Paginated response
content (optional)
array[UserHistory] List of content items
totalPages (optional)
Integer Total number of pages format: int32
totalElements (optional)
Long Total number of elements format: int64

PaymentTransactionEntity Up

List of content items
id (optional)
Long format: int64
userId
Long format: int64
transactionDate (optional)
Date format: date-time
transactionValue (optional)
Money
amountInPoints (optional)
BigDecimal Amount of purchased/charged points
accountBalanceInPoints (optional)
BigDecimal Account balance in points after deposit/charge operation
transactionType (optional)
String Deposit, charge or refund
Enum:
CHARGE
DEPOSIT
REFUND
paymentProvider (optional)
String Provider for making account deposits
Enum:
PAYU
DVP
JUSTSEND
paymentMethod (optional)
String
Enum:
BLIK
CARD
POINTS
PROFORMA
PBL
UNKNOWN
transactionStatus (optional)
String
Enum:
PENDING
SUCCESS
ERROR
transactionError (optional)
String Specific reason for transaction failure
Enum:
NONE
USER_ABORTED
WRONG_CODE
CODE_EXPIRED
TRANSACTION_TIMEOUT
INSUFFICIENT_FUNDS
OTHER
UNKNOWN
internalTransactionId (optional)
String Internal transaction identification
externalTransactionId (optional)
String Transaction id assigned by the payment provider
bulkId (optional)
Long Reference to the bulk which was charged after sending format: int64
platformType (optional)
String
Enum:
PL
FR
version (optional)
Long Field for optimistic locking purpose format: int64
createDate (optional)
Date format: date-time
modifiedDate (optional)
Date format: date-time
invoicingStatus (optional)
String Status of the invoicing process
Enum:
INITIALIZE
SENT_CREATION_REQUEST
NOTIFICATION_PROCESSED
invoice (optional)
InvoiceEntity

ProblemDetail Up

type (optional)
String format: uri
title (optional)
String
status (optional)
Integer format: int32
detail (optional)
String
instance (optional)
String format: uri
properties (optional)
map[String, Object]

RequestMetadata Up

requestSource (optional)
String
userAgent (optional)
String

RestBulkData Up

name
String
bulkType
String
Enum:
STANDARD
PERSONALIZED
PARAMETRIZED
bulkVariant
String
Enum:
ECO
FULL
PRO
ECO_RESP
PRO_RESP
bulkPriority (optional)
String
Enum:
NORMAL
ALERT
sender
String
message (optional)
String
groupId (optional)
Long format: int64
sendDate
Date format: date-time
recipients
array[RestRecipient]

RestRecipient Up

msisdn
String
content (optional)
String

SendStatistics Up

List of content items
sendDate (optional)
Date format: date-time
recipientsCount (optional)
Long format: int64
messagesCount (optional)
Long format: int64
sentCount (optional)
Long format: int64
deliveredCount (optional)
Long format: int64
notDeliveredCount (optional)
Long format: int64

SingleMessage Up

sender
String
msisdn
String
bulkVariant
String
Enum:
ECO
FULL
PRO
ECO_RESP
PRO_RESP
content
String

SingleMessageOverviewAggregation Up

List of content items
sendDate (optional)
Date format: date-time
userId (optional)
Long format: int64
userEmail (optional)
String
userAccountType (optional)
String
Enum:
SLAVE
MASTER
ADMIN
userMasterId (optional)
Long format: int64
userPlatformType (optional)
String
Enum:
PL
FR
bulkVariant (optional)
String
Enum:
ECO
FULL
PRO
ECO_RESP
PRO_RESP
sender (optional)
String
acknowledgeStatus (optional)
String
Enum:
DELIVERED
NOT_DELIVERED
recordCount (optional)
Long format: int64
chargedPoints (optional)
BigDecimal
messageCount (optional)
Long format: int64
deliveredCount (optional)
Long format: int64
undeliveredCount (optional)
Long format: int64

UserHistory Up

List of content items
userId (optional)
Long format: int64
userMasterId (optional)
Long format: int64
userEmail (optional)
String
bulkVariant (optional)
String
Enum:
ECO
FULL
PRO
ECO_RESP
PRO_RESP
name (optional)
String
sender (optional)
String
msisdn (optional)
String
content (optional)
String
messageCount (optional)
Integer format: int32
sendDate (optional)
Date format: date-time
carrierId (optional)
Integer format: int32
acknowledgeStatus (optional)
String
Enum:
DELIVERED
NOT_DELIVERED
deliveryDate (optional)
Date format: date-time
type (optional)
String

upload_bulk_body Up

request
FileUploadRequest
file
byte[] format: binary