Login

  • Sms
  • PUT Single Sms

Send single message

This method allows you to send a single message instead of a campaign.

Resource

Production environment:

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

Testing environment

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

Parameters

Property name Type Required Description
id_sender int no* The id of the sender (see "GET sender") to be used for sending.
sender_name string no* The sender's name must be one string with less than 11 characters, can be an existing sender or not. If it does not exist it will be added.
message string yes The text of the SMS.
recipients** string, object or array yes The recipient (s). If you pass an object the "phone" attribute must be present.
test int no If past 1 the message will not be sent, if passed 0 (default) the message will be sent.

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.
data DataRespondeDetails Present only if the API call goes to good end, it will contain the answer data.
code int If the API call is successful, it will be 200, otherwise 4xx.
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 string The message sent.
credit int User Credits.
message_id int The message id to use to retrieve the status.
sms_total int The number of messages used.
test boolean Indicates whether the message was in test mode or no.