MMS Campaigns (1.0.0)

Everything about MMS

Send MMS Campaign

Create mms campaign

Properties

Name	Type	Required	Restrictions	Description
list_id	integer(int32)	true	none	Your list id.
name	string	true	none	Your campaign name.
body	string	true	none	Your campaign message.
from	string	true	yes	Your sender id
schedule	integer(int32)	false	none	Your schedule timestamp.
subject	string	true	none	Subject of MMS campaign.
media_file	string	true	none	URL pointing to media file.

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request

header Parameters

Content-Type

string

Example: application/json

Request Body schema: application/json

object

Responses

200

Successful response

post/v3/mms-campaigns/send

Request samples

application/json

"{\n  \"list_id\": {{listId}},\n  \"name\": \"Koala Campaign\",\n  \"from\": \"+61411111111\",\n  \"body\": \"Hey (First Name), I want to ask if this is your lastname: (Last Name)? Also, do you like koalas? Visit http://smsg.io/xxxxx for more details.\",\n  \"url_to_shorten\": \"http://test.com.au\",\n  \"subject\": \"New MMS campaign test\",\n  \"media_file\": \"https://www.ivertech.com/Articles/Images/KoalaBear200x200.jpg\"\n}"

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "MMS campaign has been created.",
"data": {"mms_campaign_id": 96,
"name": "Koala Campaign",
"user_id": 20807,
"subaccount_id": 15,
"list_id": 85262,
"from": "0451919865",
"subject": "New MMS campaign test",
"file_name": "8EA5FA8C-3216-4A5D-86EA-6BE78050E439.jpg",
"body": "Hey (First Name), I want to ask if this is your lastname: (Last Name)? Also, do you like koalas? Visit http://smsu.io/xxxxx for more details.",
"schedule": 1531800743,
"status": "Queued",
"date_added": 1531800745,
"_total_count": 1,
"_list_name": "test",
"_media_file_url": "http://rest.clicksend.clicksend/files/8EA5FA8C-3216-4A5D-86EA-6BE78050E439.jpg"
}
}

Calculate MMS Campaign Price

Calculate price for mms campaign

Properties

Name	Type	Required	Restrictions	Description
list_id	integer(int32)	true	none	Your list id.
name	string	true	none	Your campaign name.
body	string	true	none	Your campaign message.
from	string	true	yes	Your sender id
schedule	integer(int32)	false	none	Your schedule timestamp.
subject	string	true	none	Subject of MMS campaign.
media_file	string	true	none	URL pointing to media file.

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request

header Parameters

Content-Type

string

Example: application/json

Request Body schema: application/json

object

Responses

200

Successful response

post/v3/mms-campaigns/price

Request samples

application/json

"{\n  \"list_id\": {{listId}},\n  \"name\": \"Koala Campaign\",\n  \"from\": \"+61411111111\",\n  \"body\": \"Hey (First Name), I want to ask if this is your lastname: (Last Name)? Also, do you like koalas? Visit http://smsg.io/xxxxx for more details.\",\n  \"url_to_shorten\": \"http://test.com.au\",\n  \"subject\": \"New MMS campaign test\",\n  \"media_file\": \"https://www.ivertech.com/Articles/Images/KoalaBear200x200.jpg\",\n  \"schedule\": 1577833200\n}"

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your result.",
"data": {"total_count": 1,
"total_price": "0.429",
"data": {"from": "+61411111111",
"schedule": 1577833200,
"body": "Hey test, I want to ask if this is your lastname: ? Also, do you like koalas?"
},
"_currency": {"currency_name_short": "AUD",
"currency_prefix_d": "$",
"currency_prefix_c": "c",
"currency_name_long": "Australian Dollars"
}
}
}

Update MMS Campaign

Update mms campaign

Parameters

Parameter	In	Type	Required	Description
mms_campaign_id	path	integer(int32)	true	ID of MMS campaign to update

Properties

Name	Type	Required	Restrictions	Description
list_id	integer(int32)	true	none	Your list id.
name	string	true	none	Your campaign name.
body	string	true	none	Your campaign message.
from	string	true	yes	Your sender id
schedule	integer(int32)	false	none	Your schedule timestamp.
subject	string	true	none	Subject of MMS campaign.
media_file	string	true	none	URL pointing to media file.

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request

path Parameters

mms_campaign_id

required

string

header Parameters

Content-Type

string

Example: application/json

Request Body schema: application/json

object

Responses

200

Successful response

put/v3/mms-campaigns/{mms_campaign_id}

Request samples

application/json

{"list_id": "{{list_id}}",
"name": "My Campaign",
"from": "+61411111111",
"body": "Hey (First Name), I want to ask if this is your lastname: (Last Name)?"
}

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "MMS campaign has been updated.",
"data": {"mms_campaign_id": 96,
"name": "Koala Campaign",
"user_id": 20807,
"subaccount_id": 15,
"list_id": 85262,
"from": "0451919865",
"subject": "New MMS campaign test",
"file_name": "8EA5FA8C-3216-4A5D-86EA-6BE78050E439.jpg",
"body": "Hey (First Name), I want to ask if this is your lastname: (Last Name)? Also, do you like koalas? Visit http://smsu.io/xxxxx for more details.",
"schedule": 1531800743,
"status": "Queued",
"date_added": 1531800745,
"_total_count": 1,
"_list_name": "test",
"_media_file_url": "http://rest.clicksend.clicksend/files/8EA5FA8C-3216-4A5D-86EA-6BE78050E439.jpg"
}
}

View MMS Campaign

Get specific mms campaign

Parameters

Parameter	In	Type	Required	Description
mms_campaign_id	path	integer(int32)	true	ID of MMS campaign to retrieve

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request

path Parameters

mms_campaign_id

required

string

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

get/v3/mms-campaigns/{mms_campaign_id}

Request samples

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

'https://rest.clicksend.com/v3/mms-campaigns/{mms_campaign_id}'

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Here is your result.",
"data": {"mms_campaign_id": 96,
"name": "Koala Campaign",
"user_id": 20807,
"subaccount_id": 15,
"list_id": 85262,
"from": "0451919865",
"subject": "New MMS campaign test",
"file_name": "8EA5FA8C-3216-4A5D-86EA-6BE78050E439.jpg",
"body": "Hey (First Name), I want to ask if this is your lastname: (Last Name)? Also, do you like koalas? Visit http://smsu.io/xxxxx for more details.",
"schedule": 1531800743,
"status": "Queued",
"date_added": 1531800745,
"_total_count": 1,
"_list_name": "test",
"_media_file_url": "http://rest.clicksend.clicksend/files/8EA5FA8C-3216-4A5D-86EA-6BE78050E439.jpg"
}
}

Cancel MMS Campaign

Cancel mms campaign

Parameters

Parameter	In	Type	Required	Description
mms_campaign_id	path	integer(int32)	true	ID of MMS Campaign to cancel

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request

path Parameters

mms_campaign_id

required

string

header Parameters

Content-Type

string

Example: application/json

Request Body schema: application/json

object

Responses

200

Successful response

put/v3/mms-campaigns/{mms_campaign_id}/cancel

Request samples

application/json

{"list_id": "{{listId}}",
"name": "My Campaign",
"from": "+61411111111",
"body": "Hey (First Name), I want to ask if this is your lastname: (Last Name)?"
}

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Scheduled MMS campaign has been cancelled.",
"data": {"mms_campaign_id": 96,
"name": "Koala Campaign",
"user_id": 20807,
"subaccount_id": 15,
"list_id": 85262,
"from": "0451919865",
"subject": "New MMS campaign test",
"file_name": "8EA5FA8C-3216-4A5D-86EA-6BE78050E439.jpg",
"body": "Hey (First Name), I want to ask if this is your lastname: (Last Name)? Also, do you like koalas? Visit http://smsu.io/xxxxx for more details.",
"schedule": 1531800743,
"status": "Queued",
"date_added": 1531800745,
"_total_count": 1,
"_list_name": "test",
"_media_file_url": "http://rest.clicksend.clicksend/files/8EA5FA8C-3216-4A5D-86EA-6BE78050E439.jpg"
}
}

View All MMS Campaigns

Get list of mms campaigns

Parameters

Parameter	In	Type	Required	Description
page	query	integer(int32)	false	Page number
limit	query	integer(int32)	false	Number of records per page

Refer to Status Codes for definitions of HTTP status code responses.

This endpoint requires authentication, more info...

Request

header Parameters

Content-Type

string

Example: application/json

Responses

200

Successful response

get/v3/mms-campaigns

Request samples

curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

'https://rest.clicksend.com/v3/mms-campaigns'

Response samples

200

application/json

{"http_code": 200,
"response_code": "SUCCESS",
"response_msg": "Countries have been selected.",
"data": {"total": 2,
"per_page": 15,
"current_page": 1,
"last_page": 1,
"next_page_url": null,
"prev_page_url": null,
"from": 1,
"to": 2,
"data": [{"mms_campaign_id": 96,
"name": "Koala Campaign",
"user_id": 20807,
"subaccount_id": 15,
"list_id": 85262,
"from": "0451919865",
"subject": "New MMS campaign test",
"file_name": "8EA5FA8C-3216-4A5D-86EA-6BE78050E439.jpg",
"body": "Hey (First Name), I want to ask if this is your lastname: (Last Name)? Also, do you like koalas? Visit http://smsu.io/xxxxx for more details.",
"schedule": 1531800743,
"status": "Queued",
"date_added": 1531800745,
"_total_count": 1,
"_list_name": "test",
"_media_file_url": "http://rest.clicksend.clicksend/files/8EA5FA8C-3216-4A5D-86EA-6BE78050E439.jpg"
}
]
}
}