Login

  • Sms
  • GET Campaing

List of campaign

This method allows you to view the list of campaigns scheduled by your account.

Resource

Production environment:

  • https://software.messaggisms.com/api/campaign
  • https://software.messaggisms.com/api/campaign/"code"

Testing environment

  • https://software.test.messaggisms.com/api/campaign
  • https://software.test.messaggisms.com/api/campaign/"code"

Parameters

Request Example

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

If the request is for all the campaigns:

Parameter Type Description
name string The name of the campaign.
state Enum(draft|sent) If "draft" the campaign is in draft. If "sent" the campaign is ready to send.
code string Unique code of the campaign.
send_dates array of dates (Y-m-d H:i:s) The array of dates for which the campaign is to be sent.

Data Response Details

If the request is for a specific campaign:

Parameter Type Description
name string The name of the campaign.
message string The text of the message.
sender string The sender number of the campaign.
state Enum(draft|sent) If "draft" the campaign is in draft. If "sent" the campaign is ready to send.
code string Unique code of the campaign.
send_dates array of dates (Y-m-d H:i:s) The array of dates for which the campaign is to be sent.
addressbooks array of string The list of address book to which the campaign is sent.

Additional examples

Request of a specific campaign:

Response