Developer Docs

Table of contents

Get SMS Senders status request

The method allows:

  • getting a list of all created applications for Sender registration for the SMS service
  • getting applications for SMS Sender registration satisfying the given input parameters.

To get SMS Senders status, make a request:


Request parameters:

page[offset]Nointeger0Get the Sender registration applications starting from offset
page[limit]Nointeger50Number of applications in the response
sortNostringidSort by conditions: id, sender, status, country_code, created at
wayNostringascSorting options: asc, desc
filter[status]NostringnoFilter for receiving applications in the selected status:
  • new – application created

  • accepted – accepted

  • in progress – in progress

  • registration completed – Sender registration completed

  • rejected – application for Sender registration rejected
filter[id]NointegernoFilter for getting an application by its identifier
filter[country_code]NostringnoFilter for getting applications by their Sender registration country.
Format according to ISO 3166-1 standard
filter[sender]NostringnoFilter for getting applications by their Sender SMS Sender name. 
Up to 15 characters
filter[created_at]NostringnullFilter to receive applications for the specified date of the application for registration, yyyy-mm-dd

Response parameters:

idintegerApplication for Seder registration ID
senderstringSMS Sender name
statusstringApplication status
created_atstringDate and time of creating the application for Sender registration. Format ISO 8601: yyyy-mm-dd hh:mm:ss
registered_atstring|nullSender registration date
status_changed_atstring|nullDate and time when the status of the application for Sender registration changed. Format ISO 8601: yyyy-mm-dd hh:mm:ss
country_codestringSender country, according to ISO 3166-1 Alpha-2 standard
code_of_companystringCompany code
tax_numberstringLegal entity ID
typestringSender type: sms
site_urlstring|nullCompany URL
namestring|nullLast name, first name, and middle name
legal_namestring|nullLegal entity name
addressstring|nullLegal entity address
informing_purposestring|nullPurpose of informing
rejection_reasonstring|nullReason for rejecting the application for Sender registration. Displayed only for the “rejected” application status
descriptionstring|nullService description

If the request is successful, you will receive a response:

  "data": [
      "id": 3152,
      "sender": "sender",
      "status": "new",
      "created_at": "2021-04-27 19:44:06",
      "registered_at": "2021-04-27 19:44:06",
      "status_changed_at": "2021-04-27 19:44:06",
      "country_code": "UA",
      "code_of_company": "123123123",
      "tax_number": "123123123",
      "type": "sms",
      "site_url": "",
      "name": "name",
      "legal_name": "juridical_name",
      "address": "juridical_address",
      "informing_purpose": "informing_purpose",
      "comment": "comment",
      "rejection_reason": "rejection_reason",
      "description": "description"
  "meta": {
    "page": {
      "total": 1,
      "offset": 20,
      "limit": 40