ClickSend REST API v3
  1. MMS
ClickSend REST API v3
  • Account
    • Get account
      GET
    • Create a new account
      POST
    • Update Account
      PUT
    • Send account activation token
      PUT
    • Verify new account
      PUT
    • Account Usage
      GET
  • Automation Rules
    • List Rules
      GET
    • Create a New Rule
      POST
    • Delete a Rule
      DELETE
    • Get a Specific Rule
      GET
    • Update a Rule
      PUT
    • List rules
      GET
    • Create a new rule
      POST
    • Delete a rule
      DELETE
    • Get a specific rule
      GET
    • Update a rule
      PUT
    • List Rules
      GET
    • Create a New Rule
      POST
    • Delete a Rule
      DELETE
    • Get a Specific Rule
      GET
    • Update a Rule
      PUT
    • List rules
      GET
    • Create a new rule
      POST
    • Delete a rule
      DELETE
    • Get a specific rule
      GET
    • Update a rule
      PUT
    • List rules
      GET
    • Create a new rule
      POST
    • Delete a rule
      DELETE
    • Get a specific rule
      GET
    • Update a rule
      PUT
    • List rules
      GET
    • Create a new rule
      POST
    • Delete a rule
      DELETE
    • Get a specific rule
      GET
    • Update a rule
      PUT
  • Contact Suggestions
    • List Contact Suggestions
  • Countries
    • Get all Countries
  • Delivery Issues
    • Get Delivery Issues
    • Create Delivery Issue
  • Email Marketing
    • Get All Email Campaigns
    • Calculate Price
    • Create Email Campaign
    • Get Specific Email Campaign History
    • Get Specific Email Campaign
    • Update Email Campaign
    • Cancel Email Campaign
    • Send Verification Token
    • Verify Allowed Email Address
    • Get All Allowed Email Addresses
    • Create Allowed Email Address
    • Delete Allowed Email Address
    • Get Specific Allowed Email Address
    • Get All Master Email Templates
    • Get All Master Template Categories
    • Get Specific Email Template Category
    • Get All Templates For Category
    • Get Specific Master Template
    • Get All Email Templates
    • Create New Email Template from Master Template
    • Upload Image to Specific Template
    • Delete Email Template
    • Get Specific Email Template
    • Update an Email Template
  • Transactional Email
    • Email History
    • Export History
    • Email Price
    • Add a Test Delivery Receipt
    • Email Send
  • Fax
    • Export Fax History
    • Get Fax History
    • Calculate Price
    • List of Fax Delivery Receipts
    • Add a Test Delivery Receipt
    • Mark Fax Delivery Receipts as read
    • Get a Specific Fax Delivery Receipt
    • Send Fax
  • Forgot Account
    • Forgot Password
    • Verify Forgot Password
    • Forgot Username
  • Contact Lists
    • Get all Contact Lists
    • Create a new contact list
    • Delete a specific contact list
    • Get a specific contact list
    • Update a specific contact list
    • Export Contacts List
    • Import Contacts to List
    • Show CSV Import File Preview
    • Get List of Acceptable Import Fields
    • Remove Duplicate Contacts
  • Contacts
    • Transfer a Contact
    • Get all Contacts in a List
    • Create a new contact
    • Delete a specific contact
    • Get a specific contact
    • Update a specific contact
    • Remove Opted Out Contacts
  • MMS
    • Cancel All MMS
      PUT
    • Export MMS History
      GET
    • Get MMS History
      GET
    • Get Price
      POST
    • Get all Delivery Receipts
      GET
    • Mark Receipts As Read
      PUT
    • Get Delivery Receipt
      GET
    • Send MMS
      POST
    • Cancel MMS
      PUT
  • Numbers
    • Get all Dedicated Numbers
    • Buy dedicated number
    • Search Dedicated Numbers by Country
  • Post Direct Mail
    • List Direct Mail Campaigns
    • Calculate Direct Mail Campaign Price
    • Create New Campaign
    • Search Locations
  • Post Address Detection
    • Detect Address
  • Post Letter
    • Get Post Letter History
    • Export Post Letter History
    • Calculate Price
    • Send Post Letter
    • Get List of Post Return Addresses
    • Create a Post Return Address
    • Delete Post Return Address
    • Get Post Return Address
    • Update Post Return Address
  • Postcards
    • Export Postcard History
    • Get Postcard History
    • Calculate Pricing
    • Send Postcard
  • Pricing
    • Get Country Pricing
  • Account Recharge
    • Get Credit Card info
    • Update Credit Card info
    • List of Packages
    • Purchase a Package
    • Get Transactions
    • Get a specific transaction
  • Referral Accounts
    • Get List of Referral Accounts
  • Reseller
    • Get Reseller Setting
    • Update Reseller Setting
    • Reseller By Subdomain
  • Reseller Accounts
    • List of Reseller Accounts
    • Create Reseller Account
    • Create Reseller Account - Public
    • Get Reseller Account
    • Update Reseller Account
    • Transfer Credit
  • SDK
    • SDK Download
  • Search
    • Search Contacts-Lists
  • SMS Campaigns
    • Get list of SMS Campaigns
    • Calculate Price for SMS Campaign
    • Use Short URL
    • Link Tracking Export
    • Link Statistics
    • Link Tracking
    • Get SMS Campaign
    • Update an SMS Campaign
    • Cancel an SMS Campaign
  • SMS
    • Cancel all Scheduled Messages
    • Export SMS History
    • Get all History
    • Get all Inbound SMS - Pull
    • Add a Test Inbound SMS
    • Mark all Inbound SMS as read
    • Mark a specific Inbound SMS as read
    • Get Specific Inbound - Pull
    • Calculate Price
    • Get all Delivery Receipts
    • Add a Test Delivery Receipt
    • Mark Delivery Receipts as read
    • Get a Specific Delivery Receipt
    • Send an SMS
    • Cancel a Scheduled Message
  • Email-to-SMS Allowed Address
    • List of Email-to-SMS Allowed Address
    • Create Email to SMS Allowed Address
    • Delete Email-to-SMS Allowed Address
    • Get specific Email-to-SMS Allowed Address
    • Update Email-to-SMS Allowed Address
  • Email-to-SMS Stripped Strings
    • List Stripped Strings
    • Create Stripped String
    • Delete Stripped String
    • Find Specific Stripped String
    • Update Stripped String
  • SMS Templates
    • List of Templates
    • Create a Template
    • Delete a Template
    • Update a Template
  • Statistics
    • Get SMS Statistics
    • Get Voice Statistics
  • Subaccounts
    • Get all Subaccounts
    • Create a new subaccount
    • Delete a specific subaccount
    • Get a specific subaccount
    • Update a specific subaccount
    • Regenerate API Key
  • Timezones
    • Get Timezones
  • Uploads
    • Upload a file
  • Voice
    • Cancel all Voice Calls
    • Export Voice History
    • Get Voice History
    • Voice Languages
    • Calculate Price
    • Get Voice receipts
    • Add a Test Delivery Receipt
    • Marked Voice Receipts as Read
    • Get Specific Voice Receipt
    • Send a Voice Call
    • Cancel a Specific Voice Call
  1. MMS

Get MMS History

GET
/mms/history
MMS
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://rest.clicksend.com/v3/mms/history?q={q}&order_by={order_by}&date_from={date_from}&date_to={date_to}'
Response Response Example
{
    "data": {
        "current_page": 1,
        "data": [
            {
                "_api_username": "my_api_username",
                "_media_file_url": "http://yourdomain.com/_mms/2D789145-3E66-4038-9BA5-EF3DEEE82386.gif",
                "body": "John This is a test message.",
                "carrier": "",
                "contact_id": 7,
                "country": "AU",
                "custom_string": "",
                "date_added": 1467356623,
                "direction": "out",
                "from": "+61298444213",
                "from_email": null,
                "list_id": 429,
                "message_id": "2453E085-C1F8-47EC-AD35-B793960B1313",
                "message_parts": "1.00",
                "message_price": "2.4200",
                "priority": 10,
                "schedule": "1467356623",
                "status": "Failed",
                "status_code": "301",
                "status_text": "Unable to process your MMS for sending.",
                "subaccount_id": 1,
                "subject": "This is a subject",
                "to": "+61298444214",
                "user_id": 1
            },
            {
                "_api_username": "my_api_username",
                "_media_file_url": "http://yourdomain.com/_mms/2D789145-3E66-4038-9BA5-EF3DEEE82386.gif",
                "body": "John This is a test message.",
                "carrier": "",
                "contact_id": 8,
                "country": "AU",
                "custom_string": "",
                "date_added": 1467356623,
                "direction": "out",
                "from": "+61298444213",
                "from_email": null,
                "list_id": 429,
                "message_id": "54889DC7-A840-4A21-A977-EBE8C51FC2F8",
                "message_parts": "1.00",
                "message_price": "2.4200",
                "priority": 10,
                "schedule": "1467356623",
                "status": "Queued:WaitSend",
                "status_code": null,
                "status_text": null,
                "subaccount_id": 1,
                "subject": "This is a subject",
                "to": "+61298444214",
                "user_id": 1
            },
            {
                "_api_username": "my_api_username",
                "_media_file_url": "http://yourdomain.com/_mms/2D789145-3E66-4038-9BA5-EF3DEEE82386.gif",
                "body": "John This is a test message.",
                "carrier": "",
                "contact_id": 9,
                "country": "AU",
                "custom_string": "",
                "date_added": 1467356623,
                "direction": "out",
                "from": "+61298444213",
                "from_email": null,
                "list_id": 429,
                "message_id": "F2E75443-35A4-4300-9D12-E67682E762DB",
                "message_parts": "1.00",
                "message_price": "2.4200",
                "priority": 10,
                "schedule": "1467356623",
                "status": "Queued:WaitSend",
                "status_code": null,
                "status_text": null,
                "subaccount_id": 1,
                "subject": "This is a subject",
                "to": "+61298444214",
                "user_id": 1
            },
            {
                "_api_username": "my_api_username",
                "_media_file_url": "http://yourdomain.com/_mms/2D789145-3E66-4038-9BA5-EF3DEEE82386.gif",
                "body": "John This is a test message.",
                "carrier": "",
                "contact_id": 10,
                "country": "AU",
                "custom_string": "",
                "date_added": 1467356623,
                "direction": "out",
                "from": "+61298444213",
                "from_email": null,
                "list_id": 429,
                "message_id": "26B77CD6-5C98-46C7-A6DF-F76F29B7E09F",
                "message_parts": "1.00",
                "message_price": "2.4200",
                "priority": 10,
                "schedule": "1467356623",
                "status": "Queued:WaitSend",
                "status_code": null,
                "status_text": null,
                "subaccount_id": 1,
                "subject": "This is a subject",
                "to": "+61298444214",
                "user_id": 1
            },
            {
                "_api_username": "my_api_username",
                "_media_file_url": "http://yourdomain.com/_mms/2D789145-3E66-4038-9BA5-EF3DEEE82386.gif",
                "body": "John This is a test message.",
                "carrier": "",
                "contact_id": 11,
                "country": "AU",
                "custom_string": "",
                "date_added": 1467356623,
                "direction": "out",
                "from": "+61298444213",
                "from_email": null,
                "list_id": 429,
                "message_id": "70BAB69D-8EA5-417C-A8EA-7F0D843E30F3",
                "message_parts": "1.00",
                "message_price": "2.4200",
                "priority": 10,
                "schedule": "1467356623",
                "status": "Sent",
                "status_code": "200",
                "status_text": "Sent",
                "subaccount_id": 1,
                "subject": "This is a subject",
                "to": "+61298444214",
                "user_id": 1
            },
            {
                "_api_username": "my_api_username",
                "_media_file_url": "http://yourdomain.com/_mms/601D3E45-49FD-4653-B8F7-ED70B5CB9A43.gif",
                "body": "John This is a test message.",
                "carrier": "",
                "contact_id": 4,
                "country": "AU",
                "custom_string": "",
                "date_added": 1467358732,
                "direction": "out",
                "from": "+61298444213",
                "from_email": null,
                "list_id": 429,
                "message_id": "42E3C025-FD9D-4C9F-B374-C7DF5337F6AF",
                "message_parts": "1.00",
                "message_price": "2.4200",
                "priority": 10,
                "schedule": "1467358732",
                "status": "Queued",
                "status_code": null,
                "status_text": null,
                "subaccount_id": 1,
                "subject": "This is a subject",
                "to": "+61298444214",
                "user_id": 1
            },
            {
                "_api_username": "my_api_username",
                "_media_file_url": "http://yourdomain.com/_mms/601D3E45-49FD-4653-B8F7-ED70B5CB9A43.gif",
                "body": "John This is a test message.",
                "carrier": "",
                "contact_id": 5,
                "country": "AU",
                "custom_string": "",
                "date_added": 1467358732,
                "direction": "out",
                "from": "+61298444213",
                "from_email": null,
                "list_id": 429,
                "message_id": "218D5034-89A0-4C6C-B8F9-006BEF50B92B",
                "message_parts": "1.00",
                "message_price": "2.4200",
                "priority": 10,
                "schedule": "1467358732",
                "status": "Queued",
                "status_code": null,
                "status_text": null,
                "subaccount_id": 1,
                "subject": "This is a subject",
                "to": "+61298444214",
                "user_id": 1
            },
            {
                "_api_username": "my_api_username",
                "_media_file_url": "http://yourdomain.com/_mms/601D3E45-49FD-4653-B8F7-ED70B5CB9A43.gif",
                "body": "John This is a test message.",
                "carrier": "",
                "contact_id": 6,
                "country": "AU",
                "custom_string": "",
                "date_added": 1467358732,
                "direction": "out",
                "from": "+61298444213",
                "from_email": null,
                "list_id": 429,
                "message_id": "EFCF9FAA-1BCA-4C58-884A-257C0D87124E",
                "message_parts": "1.00",
                "message_price": "2.4200",
                "priority": 10,
                "schedule": "1467358732",
                "status": "Queued",
                "status_code": null,
                "status_text": null,
                "subaccount_id": 1,
                "subject": "This is a subject",
                "to": "+61298444214",
                "user_id": 1
            },
            {
                "_api_username": "my_api_username",
                "_media_file_url": "http://yourdomain.com/_mms/601D3E45-49FD-4653-B8F7-ED70B5CB9A43.gif",
                "body": "John This is a test message.",
                "carrier": "",
                "contact_id": 7,
                "country": "AU",
                "custom_string": "",
                "date_added": 1467358732,
                "direction": "out",
                "from": "+61298444213",
                "from_email": null,
                "list_id": 429,
                "message_id": "3E0DC217-7D0F-4C20-A3F2-E3362B938CAF",
                "message_parts": "1.00",
                "message_price": "2.4200",
                "priority": 10,
                "schedule": "1467358732",
                "status": "Queued",
                "status_code": null,
                "status_text": null,
                "subaccount_id": 1,
                "subject": "This is a subject",
                "to": "+61298444214",
                "user_id": 1
            },
            {
                "_api_username": "my_api_username",
                "_media_file_url": "http://yourdomain.com/_mms/601D3E45-49FD-4653-B8F7-ED70B5CB9A43.gif",
                "body": "John This is a test message.",
                "carrier": "",
                "contact_id": 8,
                "country": "AU",
                "custom_string": "",
                "date_added": 1467358732,
                "direction": "out",
                "from": "+61298444213",
                "from_email": null,
                "list_id": 429,
                "message_id": "7827223E-0D73-49A1-95D0-8B85C3F5CC71",
                "message_parts": "1.00",
                "message_price": "2.4200",
                "priority": 10,
                "schedule": "1467358732",
                "status": "Queued",
                "status_code": null,
                "status_text": null,
                "subaccount_id": 1,
                "subject": "This is a subject",
                "to": "+61298444214",
                "user_id": 1
            },
            {
                "_api_username": "my_api_username",
                "_media_file_url": "http://yourdomain.com/_mms/601D3E45-49FD-4653-B8F7-ED70B5CB9A43.gif",
                "body": "John This is a test message.",
                "carrier": "",
                "contact_id": 9,
                "country": "AU",
                "custom_string": "",
                "date_added": 1467358732,
                "direction": "out",
                "from": "+61298444213",
                "from_email": null,
                "list_id": 429,
                "message_id": "0D902342-3873-4EE9-A86A-CA1B0B755BBA",
                "message_parts": "1.00",
                "message_price": "2.4200",
                "priority": 10,
                "schedule": "1467358732",
                "status": "Queued",
                "status_code": null,
                "status_text": null,
                "subaccount_id": 1,
                "subject": "This is a subject",
                "to": "+61298444214",
                "user_id": 1
            },
            {
                "_api_username": "my_api_username",
                "_media_file_url": "http://yourdomain.com/_mms/601D3E45-49FD-4653-B8F7-ED70B5CB9A43.gif",
                "body": "John This is a test message.",
                "carrier": "",
                "contact_id": 10,
                "country": "AU",
                "custom_string": "",
                "date_added": 1467358732,
                "direction": "out",
                "from": "+61298444213",
                "from_email": null,
                "list_id": 429,
                "message_id": "0549ADFD-9D70-4B1A-B62F-875A05B481D9",
                "message_parts": "1.00",
                "message_price": "2.4200",
                "priority": 10,
                "schedule": "1467358732",
                "status": "Queued",
                "status_code": null,
                "status_text": null,
                "subaccount_id": 1,
                "subject": "This is a subject",
                "to": "+61298444214",
                "user_id": 1
            },
            {
                "_api_username": "my_api_username",
                "_media_file_url": "http://yourdomain.com/_mms/601D3E45-49FD-4653-B8F7-ED70B5CB9A43.gif",
                "body": "John This is a test message.",
                "carrier": "",
                "contact_id": 11,
                "country": "AU",
                "custom_string": "",
                "date_added": 1467358732,
                "direction": "out",
                "from": "+61298444213",
                "from_email": null,
                "list_id": 429,
                "message_id": "1327677D-D2EF-4442-A0F3-B480C7E94359",
                "message_parts": "1.00",
                "message_price": "2.4200",
                "priority": 10,
                "schedule": "1467358732",
                "status": "Queued",
                "status_code": null,
                "status_text": null,
                "subaccount_id": 1,
                "subject": "This is a subject",
                "to": "+61298444214",
                "user_id": 1
            },
            {
                "_api_username": "my_api_username",
                "_media_file_url": "http://yourdomain.com/_mms/C755FD73-AD7A-4EB8-A521-FC10BB37F3B7.gif",
                "body": "This is a test message.",
                "carrier": "Telstra",
                "contact_id": null,
                "country": "AU",
                "custom_string": "",
                "date_added": 1467363093,
                "direction": "out",
                "from": "",
                "from_email": null,
                "list_id": null,
                "message_id": "42ABDB50-3DAE-41B5-8F48-6F227F38DB2E",
                "message_parts": "1.00",
                "message_price": "2.4200",
                "priority": 10,
                "schedule": "1467363093",
                "status": "Queued",
                "status_code": null,
                "status_text": null,
                "subaccount_id": 1,
                "subject": "This is a subject",
                "to": "+61437887633",
                "user_id": 1
            },
            {
                "_api_username": "my_api_username",
                "_media_file_url": "http://yourdomain.com/_mms/2289C892-7518-4FBB-9A1C-7C34A93F6328.gif",
                "body": "This is a test message.",
                "carrier": "Telstra",
                "contact_id": null,
                "country": "AU",
                "custom_string": "",
                "date_added": 1467363210,
                "direction": "out",
                "from": "",
                "from_email": null,
                "list_id": null,
                "message_id": "53271F40-EEB2-4DE9-A525-F0620211A4C9",
                "message_parts": "1.00",
                "message_price": "2.4200",
                "priority": 10,
                "schedule": "1467363210",
                "status": "Queued",
                "status_code": null,
                "status_text": null,
                "subaccount_id": 1,
                "subject": "This is a subject",
                "to": "+61437887633",
                "user_id": 1
            }
        ],
        "from": 1,
        "last_page": 3,
        "next_page_url": "/?page=2",
        "per_page": 15,
        "prev_page_url": null,
        "to": 15,
        "total": 31
    },
    "http_code": 200,
    "response_code": "SUCCESS",
    "response_msg": "Here is your history."
}

Request

Path Params
q
string 
required
A custom query.
Example:
list_id:429,direction:out
order_by
string 
required
Sort records by.
Example:
subject:desc
date_from
string 
required
Unix timestamp (from) used to show records by date.
Example:
1443501617
date_to
string 
required
Unix timestamp (to) used to show records by date.
Example:
1443501727
Query Params
q
string 
required
Example:
{q}
order_by
string 
required
Example:
{order_by}
date_from
string 
required
Example:
{date_from}
date_to
string 
required
Example:
{date_to}

Responses

🟢200OK
application/json
Body
object {0}
Previous
Export MMS History
Next
Get Price
Built with