Messaging
/
MMS Campaigns

MMS Campaigns

Everything about MMS

Languages
Servers
https://rest.clicksend.com/

Send MMS Campaign

Request

Create mms campaign

Properties

NameTypeRequiredRestrictionsDescription
list_idinteger(int32)truenoneYour list id.
namestringtruenoneYour campaign name.
bodystringtruenoneYour campaign message.
fromstringtrueyesYour sender id
scheduleinteger(int32)falsenoneYour schedule timestamp.
subjectstringtruenoneSubject of MMS campaign.
media_filestringtruenoneURL pointing to media file.

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

This endpoint requires authentication,more info...
Headers
Content-Typestring
Example: application/json
Bodyapplication/json
list_idstring
Example: "{{listId}}"
namestring
Example: "Koala Campaign"
fromstring
Example: "+61411111111"
bodystring
Example: "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."
url_to_shortenstring
Example: "http://test.com.au"
subjectstring
Example: "New MMS campaign test"
media_filestring
Example: "https://www.ivertech.com/Articles/Images/KoalaBear200x200.jpg"
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request POST \

     --header "Content-Type: application/json" \
     --data-binary "{
    \"list_id\":428,
    \"name\":\"My Campaign 1\",
    \"from\":\"+61353787448\",
    \"body\":\"This is my new campaign message.\",
    \"schedule\":1444821615,
    \"subject\": \"test\",
    \"media_file\": \"http://yourdomain.com/tpLaX6A.gif\"
}" \
'https://rest.clicksend.com/v3/mms-campaigns/send'

Responses

Successful response

Bodyapplication/json
http_codeinteger

The HTTP status code of the response.

Example: 200
response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"
response_msgstring

A message describing the outcome of the operation.

Example: "MMS campaign has been created."
dataobject(mms_campaign)
Response
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

Request

Calculate price for mms campaign

Properties

NameTypeRequiredRestrictionsDescription
list_idinteger(int32)truenoneYour list id.
namestringtruenoneYour campaign name.
bodystringtruenoneYour campaign message.
fromstringtrueyesYour sender id
scheduleinteger(int32)falsenoneYour schedule timestamp.
subjectstringtruenoneSubject of MMS campaign.
media_filestringtruenoneURL pointing to media file.

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

This endpoint requires authentication,more info...
Headers
Content-Typestring
Example: application/json
Bodyapplication/json
object
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request POST \

     --header "Content-Type: application/json" \
     --data-binary "{
    \"list_id\":428,
    \"name\":\"My Campaign 1\",
    \"from\":\"+61353787448\",
    \"body\":\"(First Name), this is your new campaign message.\",
    \"subject\": \"test\",
    \"media_file\": \"http://yourdomain.com/tpLaX6A.gif\"
}" \
'https://rest.clicksend.com/v3/mms-campaigns/price'

Responses

Successful response

Bodyapplication/json
http_codeinteger

The HTTP status code of the response.

Example: 200
response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"
response_msgstring

A message describing the outcome of the operation.

Example: "Here is your result."
dataobject
Response
application/json
{
  "http_code": 200,
  "response_code": "SUCCESS",
  "response_msg": "Here is your result.",
  "data": {
    "total_count": 1,
    "total_price": "0.429",
    "data": { … },
    "_currency": { … }
  }
}

Update MMS Campaign

Request

Update mms campaign

Parameters

ParameterInTypeRequiredDescription
mms_campaign_idpathinteger(int32)trueID of MMS campaign to update

Properties

NameTypeRequiredRestrictionsDescription
list_idinteger(int32)truenoneYour list id.
namestringtruenoneYour campaign name.
bodystringtruenoneYour campaign message.
fromstringtrueyesYour sender id
scheduleinteger(int32)falsenoneYour schedule timestamp.
subjectstringtruenoneSubject of MMS campaign.
media_filestringtruenoneURL pointing to media file.

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

This endpoint requires authentication,more info...
Path
mms_campaign_idstringrequired
Headers
Content-Typestring
Example: application/json
Bodyapplication/json
list_idstring
Example: "{{list_id}}"
namestring
Example: "My Campaign"
fromstring
Example: "+61411111111"
bodystring
Example: "Hey (First Name), I want to ask if this is your lastname: (Last Name)?"
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request PUT \

     --header "Content-Type: application/json" \
     --data-binary "{
    \"list_id\":428,
    \"name\":\"Awesome campaign.\",
    \"from\":\"+61353787447\",
    \"body\":\"his is an awesome message.\",
    \"schedule\":1444821615,
    \"subject\": \"test\",
    \"media_file\": \"http://yourdomain.com/tpLaX6A.gif\"
}" \
'https://rest.clicksend.com/v3/mms-campaigns/{mms_campaign_id}'

Responses

Successful response

Bodyapplication/json
http_codeinteger

The HTTP status code of the response.

Example: 200
response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"
response_msgstring

A message describing the outcome of the operation.

Example: "MMS campaign has been updated."
dataobject(mms_campaign)
Response
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

Request

Get specific mms campaign

Parameters

ParameterInTypeRequiredDescription
mms_campaign_idpathinteger(int32)trueID of MMS campaign to retrieve

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

This endpoint requires authentication,more info...
Path
mms_campaign_idstringrequired
Headers
Content-Typestring
Example: application/json
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

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

Responses

Successful response

Bodyapplication/json
http_codeinteger

The HTTP status code of the response.

Example: 200
response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"
response_msgstring

A message describing the outcome of the operation.

Example: "Here is your result."
dataobject(mms_campaign)
Response
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

Request

Cancel mms campaign

Parameters

ParameterInTypeRequiredDescription
mms_campaign_idpathinteger(int32)trueID of MMS Campaign to cancel

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

This endpoint requires authentication,more info...
Path
mms_campaign_idstringrequired
Headers
Content-Typestring
Example: application/json
Bodyapplication/json
list_idstring
Example: "{{listId}}"
namestring
Example: "My Campaign"
fromstring
Example: "+61411111111"
bodystring
Example: "Hey (First Name), I want to ask if this is your lastname: (Last Name)?"
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \
     --request PUT \

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

Responses

Successful response

Bodyapplication/json
http_codeinteger

The HTTP status code of the response.

Example: 200
response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"
response_msgstring

A message describing the outcome of the operation.

Example: "Scheduled MMS campaign has been cancelled."
dataobject(mms_campaign)
Response
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

Request

Headers
Content-Typestring
Example: application/json
curl --include \
     --header "Authorization: Basic YXBpLXVzZXJuYW1lOmFwaS1wYXNzd29yZA=="  \

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

Responses

Successful response

Bodyapplication/json
http_codeinteger

The HTTP status code of the response.

Example: 200
response_codestring

The response code indicating the status of the operation.

Example: "SUCCESS"
response_msgstring

A message describing the outcome of the operation.

Example: "Countries have been selected."
dataobject
Response
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": [ … ]
  }
}