Login

  • Sms
  • GET Status

Message Status

This method allows you to view the status of the sent SMS.

Resource

Production environment:

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

Testing environment

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

Parameters

Property name Type Description
message_id int The id of the message whose status I want to display.

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
message_id string The id of the message.
message string The text of the message sent.
recipients RecipientsResponseDetails Array of objects containing recipient data.

Recipients Response Details

Parameter Type Description
recipients_number string Recipient's phone number.
state string The status of the message:
  • -1: send failed
  • 0: send in queue
  • 1: sent
  • 2: delivered
error_description string The description of the error in the case of state = -1.
fields FieldsResponseDetails List of recipient details.
sent_date datetime (Y-m-d H:i:s) Message sent date.
delivery_date datetime (Y-m-d H:i:s) Message delivery date.

Fields Response Details

Parameter Type Description
Name string Recipient's name.
Surname string Recipient's surname
Company string Recipient's company.
Gender string Recipient's gender.
BirthDate string Recipient's birth date.
Email string Recipient's email.
Address string Recipient's address.
ZipCode string Recipient's zip code.
City string Recipient's city.
Region string Recipient's region.
State string Recipient's state.
PhoneNumber string Recipient's phone number.
CustomField1 string Recipient's custom field 1.
CustomField2 string Recipient's custom field 2.
CustomField3 string Recipient's custom field 3.
CustomField4 string Recipient's custom field 4.