Login

  • Sms
  • GET User Status

User Status

This method allows you to view the status of your account subscription.

Resource

Production environment:

  • https://software.messaggisms.com/api/user_status

Testing environment

  • https://software.test.messaggisms.com/api/user_status

Parameters

Request examples

Response

Response Format

If successful, the response header HTTP status code will be 200 OK and the request will be answered.

If you try to get a request without authorization, you will receive an error 401 Unauthorized.

Additionally you should also handle the 400 Bad request status. For more info on HTTP status handling see dedicated section in Integration best practices page.

Request Response

Parameter Type Description
success boolean True or false.
code int If the API call is successful, it will be 200, otherwise 4xx.
data DataResponseDetails Present only if the API call goes to good end, it will contain the answer data.
error_code string Present only if the API call fails, it contains an error code in string format.
message string Present only if the API call does not go to its end, it contains a message that can be shown by the user.

Data Response Details

Parameter Type Description
credit string The number of wildcards remaining in the account.
history HistoryResponseDetails Array with the list of operations performed about subscribing.

History Response Details

Parameter Type Description
date date (Y-m-d H:i:s) The date of the transaction.
payment_type string The payment method for the transaction.
user_generated boolean If true the operation was done by the user, otherwise from the platform admin.
currency string The currency used for payment operation.
price string The transaction price.
formatted_price string The formatted price, example: € 50.40.
operation string The operation carried out.
description string The description of the operation.