This documentation provides everything you need to successfully integrate with our API. Whether you’re looking to send SMS messages, emails, download your inbox or manage your account, our API offers secure and flexible endpoints to integrate your application with SMS functionality.
\nFollow these steps to generate an API key and send your first SMS via the 5c SMS API.
\nIn the API Key Management section, specify a Key Alias to help identify your key.
\nClick Create New API Key.
\nCopy the generated Key ID and Key Secret.
\n\n\n⚠️ Important: Store your credentials securely. The Key Secret will not be shown again after this step.
\n
Use the following Bash script to send a test SMS:
\ncurl -X POST https://www.5centsms.com.au/api/v5/sms \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"key-secret\": \"Paste Key Secret here\",\n \"key-id\": \"Paste Key ID here\",\n \"sender\": \"0404123123\",\n \"to\": \"Paste recipient number here\",\n \"message\": \"Hello World\"\n }'\n\nPostman is a powerful tool that allows you to explore, test, and interact with our API without writing any code. We provide a complete Postman collection that includes all available endpoints, sample requests, and descriptions of required parameters.
\nHere’s how to get started:
\nView Available Endpoints
\nOn the left-hand side, you’ll see a list of all API groups (e.g., Sending SMS, Manage Your Account). Click into any group to see individual endpoints such as Send SMS, Get Balance, or View Messages.
\nUnderstand the Request Details
\nIn the top-right corner of the request tab, click Documentation button on the right of the page to vew full details for the API request.
\nSet Your Request Variables
\nBefore testing any requests, set the request variables by selecting Body under the URL.
\nSend a Test Request
\nChoose an endpoint, enter required values (e.g., recipient number and message), and click “Send.” You’ll see the API response immediately in the bottom pane, including success status or any error messages.
\nGenerate Sample Code*_In the top-right corner of the request tab, click the *_\\Code button (it looks like a pair of angle brackets). This opens the “Generate Code Snippets” window.
On the left side of the popup, you’ll see a list of supported languages and libraries (e.g., cURL, Python (requests), Node.js (axios), PHP, Ruby, Java, etc.).
Retrieve the current account balance and payment details.
\nGET https://www.5centsms.com.au/api/v5/balance
Content-Type: application/json{\n \"key-secret\": \"your-secret-key\",\n \"key-id\": \"your-key-id\"\n}\n\n{\n \"error\": \"\",\n \"balance\": {\n \"postpaid\": true,\n \"credits\": 0\n }\n}\n\nA postpaid account will always return credits as 0.
Include your key-id and key-secret in every request for authentication.
Retrieve messages sent to your virtual numbers or replies in your account’s inbox.
\nGET https://www.5centsms.com.au/api/v5/inbox
Content-Type: application/json{\n \"key-secret\": \"your-secret-key\",\n \"key-id\": \"your-key-id\"\n}\n\n{\n \"error\": \"\",\n \"messages\": [\n {\n \"id\": \"68359bf59b2f56ef4502a746\",\n \"to\": \"61403754111\",\n \"from\": \"61404123444\",\n \"message\": Test Message\",\n \"date\": 1748343797,\n \"contact_name\": \"\"\n }\n // ... additional message objects ...\n ],\n \"next_page\": \"api/v5/inbox?after=68359bec798b46bcde0ee8d9\",\n \"count\": 4\n}\n\nThis endpoint uses pagination; use the next_page url provided to fetch subsequent results.
Message data is retained for a period of 365 days from the date of processing. After this retention period, the data will be permanently purged. If you require a different retention timeframe, please contact our support team.
\nAlways include your key-id and key-secret in the request body for authentication.
Delete a message from the account’s inbox.
\nDELETE https://www.5centsms.com.au/api/v5/inbox/{id}
Content-Type: application/json{\n \"key-secret\": \"your-secret-key\",\n \"key-id\": \"your-key-id\"\n}\n\n{\n \"error\": \"\",\n \"messages\": {\n \"id\": \"68359bf59b2f56ef4502a746\",\n \"to\": \"\",\n \"from\": \"\",\n \"message_text\": \"DELETED\",\n \"date\": \"\",\n \"contact_name\": \"\"\n }\n}\n\nSpecify the {id} of the inbox message you wish to delete in the URL path.
After deletion, the message fields will be blank except for \"DELETED\" in message_text.
Always include your key-id and key-secret in the request body for authentication.
Retrieve the list of Sender IDs associated with your account.
\nGET https://www.5centsms.com.au/api/v5/senderid
Content-Type: application/json{\n \"key-secret\": \"your-secret-key\",\n \"key-id\": \"your-key-id\"\n}\n\n{\n \"error\": \"\",\n \"senderids\": [\n {\n \"senderid\": \"61404111777\",\n \"status\": \"unverified\",\n \"id\": \"682b799beb14168194052566\"\n },\n {\n \"senderid\": \"TestID\",\n \"status\": \"approved\",\n \"id\": \"6835960db8e56fee7d02ab34\"\n },\n // ... additional senderid objects ...\n ]\n}\n\nInclude your key-id and key-secret in every request for authentication.
Sender ID status' include: 'pending', 'approved', 'disallowed' or 'unverified'. Only Sender IDs with \"approved\" status should be used to send messages.
\nCreate a new sender ID for your account.
\nPOST https://www.5centsms.com.au/api/v5/senderid
Content-Type: application/json{\n \"key-secret\": \"your-secret-key\",\n \"key-id\": \"your-key-id\",\n \"senderid\": \"MyCompany\"\n}\n\n{\n \"error\": \"\",\n \"message\": \"Sender ID created\"\n}\n\nPhone-number sender IDs must be verified via a link you’ll receive.
\nAlphanumeric sender IDs are manually reviewed and approved by 5c SMS.
\nYour requested ID must clearly represent a valid entity or brand, such as a sole trader, company, partnership, trust, co-operative, registered organisation, personal name, registered trademark, government body (with authorization), product or service name, or an acronym/initialism of at least three characters. Please email us details showing how your sender ID meets these criteria.
\n","urlObject":{"protocol":"https","path":["api","v5","senderid"],"host":["www","5centsms","com","au"],"query":[],"variable":[]}},"response":[],"_postman_id":"06c16433-59d6-4431-8558-499922dc6b02"},{"name":"Delete Sender ID","id":"7546e3e4-bbee-4a99-8f0a-539ac2ec522b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"key-secret\": \"\",\n \"key-id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://www.5centsms.com.au/api/v5/senderid/{id}","description":"Delete a sender ID from your account.
\nDELETE https://www.5centsms.com.au/api/v5/senderid/{id}
Content-Type: application/json{\n \"key-secret\": \"your-secret-key\",\n \"key-id\": \"your-key-id\"\n}\n\n{\n \"error\": \"\"\n}\n\nSpecify the Sender ID's ID to delete in the {id} path parameter.
Include your key-id and key-secret in every request for authentication.
Send a single SMS message
\nPOST https://www.5centsms.com.au/api/v5/sms
Content-Type: application/json{\n \"key-secret\": \"your-secret-key\",\n \"key-id\": \"your-key-id\",\n \"sender\": \"0404123123\",\n \"to\": \"0412333555\",\n \"message\": \"Hello World\",\n \"test\": false,\n \"unicode\": false,\n \"schedule\": 0\n}\n\n{\n \"error\": \"\",\n \"messages\": [\n {\n \"destination\": \"0412333555\",\n \"id\": \"683554c596937cc4b90f5cf7\",\n \"status\": 1011,\n \"status_text\": \"Sending...\",\n \"credits\": 1\n }\n ]\n}\n\nunicode must be enabled by customer service. When enabled, the message must be hex-encoded (e.g., Testing🎉 would be: 00540065007300740069006E0067D83CDF89).
schedule must be a valid UNIX timestamp (seconds since epoch), e.g., 1717000000. Messages cannot be scheduled more than 356 days in advance.
Message data is retained for a period of 365 days from the date of processing. After this retention period, the data will be permanently purged. If you require a different retention timeframe, please contact our support team.
\nTo test integration without sending an actual SMS, use \"test\": true.
Retrieve a list of SMS messages that have been sent.
\nGET https://www.5centsms.com.au/api/v5/sms
Content-Type: application/json{\n \"key-secret\": \"your-secret-key\",\n \"key-id\": \"your-key-id\"\n}\n\n{\n \"error\": \"\",\n \"messages\": [\n {\n \"destination\": \"0412333555\",\n \"id\": \"683554c596937cc4b90f5cf7\",\n \"status\": 1011,\n \"status_text\": \"Sending...\",\n \"message_text\": \"test message\",\n \"credits\": 1,\n \"send_timestamp\": 1748340857,\n \"delivery_timestamp\": 1756743007,\n \"delivery_carrier\": \"50502\"\n }\n // ... additional message objects ...\n ],\n \"next_page\": \"/api/v5/sms?after=682dfd80e6b94fbde5054b43\",\n \"count\": 11\n}\n\n| next_page | string | URL path to retrieve the next page of results (for pagination). |
| count | integer | Total number of messages returned in this response. |
This endpoint uses pagination; use the next_page url provided to fetch subsequent results.
Message data is retained for a period of 365 days from the date of processing. After this retention period, the data will be permanently purged. If you require a different retention timeframe, please contact our support team.
\nInclude your key-id and key-secret in every request for authentication.
Retrieve details for a specific SMS message by its ID.
\nGET https://www.5centsms.com.au/api/v5/sms/{id}
Content-Type: application/json{\n \"key-secret\": \"your-secret-key\",\n \"key-id\": \"your-key-id\"\n}\n\n{\n \"error\": \"\",\n \"message\": {\n \"destination\": \"0404123123\",\n \"id\": \"682dfd80e6b94fbde5054b43\",\n \"status\": 1011,\n \"status_text\": \"Sending...\",\n \"message_text\": \"Test Message\",\n \"credits\": 1,\n \"send_timestamp\": 1748340857,\n \"delivery_timestamp\": 1756743007,\n \"delivery_network\": \"50502\"\n }\n}\n\nInclude your key-id and key-secret in every request for authentication.
Message data is retained for a period of 365 days from the date of processing. After this retention period, the data will be permanently purged. If you require a different retention timeframe, please contact our support team.
\nRetrieve the list of phone numbers that have opted out of future messages.
\nGET https://www.5centsms.com.au/api/v5/optouts
Content-Type: application/json{\n \"key-secret\": \"your-secret-key\",\n \"key-id\": \"your-key-id\"\n}\n\n{\n \"error\": \"\",\n \"numbers\": [\n {\n \"id\": \"6835ad8c96937cc4b90f5cfa\",\n \"number\": \"6140412666\",\n \"timestamp\": 1748348300\n },\n {\n \"id\": \"6835ad854e419b2aeb07b5b6\",\n \"number\": \"6140412555\",\n \"timestamp\": 1748348293\n },\n {\n \"id\": \"6835a0cbac0feef54306ded5\",\n \"number\": \"61404123444\",\n \"timestamp\": 1748345035\n }\n ],\n \"count\": 3,\n \"next_page\": \"api/v5/optouts?after=6835a0cbac0feef54306ded5\"\n}\n\nThis endpoint uses pagination; use the next_page url provided to fetch subsequent results.
Include your key-id and key-secret in every request for authentication.
This page provides implementation details and requirements unique to the Delivery Webhook.
For information and requirements that apply to all webhooks (e.g., security, reliability, general troubleshooting), please refer to the Webhook Introduction.
The Delivery Webhook notifies your application in real-time when the delivery status of an SMS message changes. This allows your system to automatically update message status for users or internal processes.
\nThe following fields are included in each Delivery Webhook request:
\nYour webhook endpoint must return HTTP 200 OK to acknowledge receipt of each event.
Below are examples for parsing webhook POST data in Python, PHP, Java, and C#.
\nfrom flask import Flask, request\napp = Flask(__name__)\n@app.route('/webhook', methods=['POST'])\ndef webhook():\n # Flask automatically parses form data for urlencoded POST\n mid = request.form.get('MID')\n status = request.form.get('STATUS')\n text = request.form.get('TEXT')\n print(f\"MID: {mid}, STATUS: {status}, TEXT: {text}\")\n return {\"status\": \"received\"}, 200\nif __name__ == '__main__':\n app.run(port=5000)\n\n// PHP automatically parses urlencoded POST data into $_POST\n$mid = $_POST['MID'] ?? null;\n$status = $_POST['STATUS'] ?? null;\n$text = $_POST['TEXT'] ?? null;\nerror_log(\"MID: $mid, STATUS: $status, TEXT: $text\");\nhttp_response_code(200);\necho json_encode(['status' => 'received']);\n?>\n\nimport org.springframework.web.bind.annotation.*;\nimport java.util.Map;\n@RestController\npublic class WebhookController {\n @PostMapping(\"/webhook\")\n public Map<String, Object> receiveWebhook(\n @RequestParam Map<String, String> params\n ) {\n String mid = params.get(\"MID\");\n String status = params.get(\"STATUS\");\n String text = params.get(\"TEXT\");\n System.out.println(\"MID: \" + mid + \", STATUS: \" + status + \", TEXT: \" + text);\n return Map.of(\"status\", \"received\");\n }\n}\n\nusing Microsoft.AspNetCore.Builder;\nusing Microsoft.AspNetCore.Http;\nusing Microsoft.Extensions.Hosting;\nvar builder = WebApplication.CreateBuilder(args);\nvar app = builder.Build();\napp.MapPost(\"/webhook\", async (HttpRequest request) =>\n{\n if (!request.HasFormContentType)\n return Results.BadRequest(\"Content-Type must be application/x-www-form-urlencoded\");\n var form = await request.ReadFormAsync();\n var mid = form[\"MID\"].ToString();\n var status = form[\"STATUS\"].ToString();\n var text = form[\"TEXT\"].ToString();\n Console.WriteLine($\"MID: {mid}, STATUS: {status}, TEXT: {text}\");\n return Results.Json(new { status = \"received\" });\n});\napp.Run();\n\nThe ID of the message
\n","type":"text/plain"},"key":"MID","value":"abc12345"},{"description":{"content":"The updated status code of the message
\n","type":"text/plain"},"key":"STATUS","value":"1002"},{"description":{"content":"The updated status text
\n","type":"text/plain"},"key":"TEXT","value":"Delivered"}],"variable":[]}},"response":[],"_postman_id":"7570a6cf-ce99-494c-a631-1c0675b12913"},{"name":"SMS Message Webhook","id":"5fd7e717-3ef2-44e5-8c9d-e5e475410930","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"?MID=683554c596937cc4b90f5cf7&FROM=61411222333&TO=6147666444&TIMESTAMP=1717518220&MESSAGE=Hello, world!&REPLY_TO=555554c596937cc4b90f5444&IMAGES=[\"https://url-to-image/image.jpg\"]","description":"This page provides implementation details and requirements unique to the Message Webhook.
For information and requirements that apply to all webhooks (such as general security and error handling), please refer to the Webhook Introduction.
The Message Webhook notifies your application in real time when a reply message is received or when an incoming message arrives at a virtual mobile number. This enables immediate processing or response within your system.
\nEach Message Webhook event will include the following parameters in the HTTP POST request:
\n\n\nNote:
\n
TheREPLY_TOfield may not be present or may be empty if the inbound message cannot be matched to an outbound message.
Your webhook endpoint must return HTTP 200 OK to acknowledge receipt of each event.
Below are examples for parsing Message Webhook data in Python, PHP, Java, and C#.
\nfrom flask import Flask, request\napp = Flask(__name__)\n@app.route('/webhook', methods=['POST'])\ndef webhook():\n mid = request.form.get('MID')\n from_num = request.form.get('FROM')\n to_num = request.form.get('TO')\n timestamp = request.form.get('TIMESTAMP')\n message = request.form.get('MESSAGE')\n reply_to = request.form.get('REPLY_TO')\n print(f\"MID: {mid}, FROM: {from_num}, TO: {to_num}, TIMESTAMP: {timestamp}, MESSAGE: {message}, REPLY_TO: {reply_to}\")\n return {\"status\": \"received\"}, 200\nif __name__ == '__main__':\n app.run(port=5000)\n\n// PHP automatically parses urlencoded POST data into $_POST\n$mid = $_POST['MID'] ?? null;\n$from = $_POST['FROM'] ?? null;\n$to = $_POST['TO'] ?? null;\n$timestamp = $_POST['TIMESTAMP'] ?? null;\n$message = $_POST['MESSAGE'] ?? null;\n$reply_to = $_POST['REPLY_TO'] ?? null;\nerror_log(\"MID: $mid, FROM: $from, TO: $to, TIMESTAMP: $timestamp, MESSAGE: $message, REPLY_TO: $reply_to\");\nhttp_response_code(200);\necho json_encode(['status' => 'received']);\n?>\n\nimport org.springframework.web.bind.annotation.*;\nimport java.util.Map;\n@RestController\npublic class WebhookController {\n @PostMapping(\"/webhook\")\n public Map<String, Object> receiveWebhook(\n @RequestParam Map<String, String> params\n ) {\n String mid = params.get(\"MID\");\n String from = params.get(\"FROM\");\n String to = params.get(\"TO\");\n String timestamp = params.get(\"TIMESTAMP\");\n String message = params.get(\"MESSAGE\");\n String replyTo = params.get(\"REPLY_TO\");\n System.out.println(\"MID: \" + mid + \", FROM: \" + from + \", TO: \" + to +\n \", TIMESTAMP: \" + timestamp + \", MESSAGE: \" + message + \", REPLY_TO: \" + replyTo);\n return Map.of(\"status\", \"received\");\n }\n}\n\nusing Microsoft.AspNetCore.Builder;\nusing Microsoft.AspNetCore.Http;\nusing Microsoft.Extensions.Hosting;\nvar builder = WebApplication.CreateBuilder(args);\nvar app = builder.Build();\napp.MapPost(\"/webhook\", async (HttpRequest request) =>\n{\n if (!request.HasFormContentType)\n return Results.BadRequest(\"Content-Type must be application/x-www-form-urlencoded\");\n var form = await request.ReadFormAsync();\n var mid = form[\"MID\"].ToString();\n var from = form[\"FROM\"].ToString();\n var to = form[\"TO\"].ToString();\n var timestamp = form[\"TIMESTAMP\"].ToString();\n var message = form[\"MESSAGE\"].ToString();\n var replyTo = form[\"REPLY_TO\"].ToString();\n Console.WriteLine($\"MID: {mid}, FROM: {from}, TO: {to}, TIMESTAMP: {timestamp}, MESSAGE: {message}, REPLY_TO: {replyTo}\");\n return Results.Json(new { status = \"received\" });\n});\napp.Run();\n\nThe unique ID of the incoming message
\n","type":"text/plain"},"key":"MID","value":"683554c596937cc4b90f5cf7"},{"description":{"content":"The sender of the message (originating phone number)
\n","type":"text/plain"},"key":"FROM","value":"61411222333"},{"description":{"content":"The virtual number that received the message
\n","type":"text/plain"},"key":"TO","value":"6147666444"},{"description":{"content":"The time the message was received (Unix epoch timestamp format)
\n","type":"text/plain"},"key":"TIMESTAMP","value":"1717518220"},{"description":{"content":"The content of the message
\n","type":"text/plain"},"key":"MESSAGE","value":"Hello, world!"},{"description":{"content":"The message ID this message is in reply to (if applicable)
\n","type":"text/plain"},"key":"REPLY_TO","value":"555554c596937cc4b90f5444"},{"description":{"content":"Links to images attached to MMS messages will be returned in this parameter
\n","type":"text/plain"},"key":"IMAGES","value":"[\"https://url-to-image/image.jpg\"]"}],"variable":[]}},"response":[],"_postman_id":"5fd7e717-3ef2-44e5-8c9d-e5e475410930"},{"name":"SMS Balance Webhook","id":"0d882511-2d04-4266-af88-3278ecb60c41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"?BALANCE=50","description":"This page provides implementation details and requirements unique to the Balance Webhook.
For information and requirements that apply to all webhooks (such as general security, reliability, and error handling), please refer to the Webhook Introduction.
The Balance Webhook notifies your application in real time when your account balance falls below a pre-defined threshold. This allows your system to take action, such as sending alerts or triggering an automated top-up.
\nEach Balance Webhook event will include the following parameter in the HTTP POST request:
\nYour webhook endpoint must return HTTP 200 OK to acknowledge receipt of each event.
Below are examples for parsing Balance Webhook data in Python, PHP, Java, and C#.
\nfrom flask import Flask, request\napp = Flask(__name__)\n@app.route('/webhook', methods=['POST'])\ndef webhook():\n balance = request.form.get('BALANCE')\n print(f\"BALANCE: {balance}\")\n return {\"status\": \"received\"}, 200\nif __name__ == '__main__':\n app.run(port=5000)\n\n// PHP automatically parses urlencoded POST data into $_POST\n$balance = $_POST['BALANCE'] ?? null;\nerror_log(\"BALANCE: $balance\");\nhttp_response_code(200);\necho json_encode(['status' => 'received']);\n?>\n\nimport org.springframework.web.bind.annotation.*;\nimport java.util.Map;\n@RestController\npublic class WebhookController {\n @PostMapping(\"/webhook\")\n public Map<String, Object> receiveWebhook(\n @RequestParam Map<String, String> params\n ) {\n String balance = params.get(\"BALANCE\");\n System.out.println(\"BALANCE: \" + balance);\n return Map.of(\"status\", \"received\");\n }\n}\n\nusing Microsoft.AspNetCore.Builder;\nusing Microsoft.AspNetCore.Http;\nusing Microsoft.Extensions.Hosting;\nvar builder = WebApplication.CreateBuilder(args);\nvar app = builder.Build();\napp.MapPost(\"/webhook\", async (HttpRequest request) =>\n{\n if (!request.HasFormContentType)\n return Results.BadRequest(\"Content-Type must be application/x-www-form-urlencoded\");\n var form = await request.ReadFormAsync();\n var balance = form[\"BALANCE\"].ToString();\n Console.WriteLine($\"BALANCE: {balance}\");\n return Results.Json(new { status = \"received\" });\n});\napp.Run();\n\nYour current account balance
\n","type":"text/plain"},"key":"BALANCE","value":"50"}],"variable":[]}},"response":[],"_postman_id":"0d882511-2d04-4266-af88-3278ecb60c41"},{"name":"Send Email","id":"c9d127f5-b691-4799-87f5-706e30333920","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"key-id\": \"\",\n \"key-secret\": \"\",\n \"SenderEmail\": \"\",\n \"Recipient\": \"\",\n \"SenderName\": \"\",\n \"Subject\": \"\",\n \"Text\": \"\",\n \"Html\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dingomail.com.au/api/v5/email","description":"Send a single email
\nPOST https://api.dingomail.com.au/api/v5/email
Content-Type: application/jsonRecipient rules:
\nAt least one of Recipient, CC, or BCC must be provided.
Maximum 50 total recipients across all fields combined.
\nEach attachment object has the following fields:
\n{\n \"key-id\": \"YOUR_KEY_ID\",\n \"key-secret\": \"YOUR_KEY_SECRET\",\n \"SenderEmail\": \"sender@yourdomain.com\",\n \"Recipient\": \"recipient@example.com\",\n \"SenderName\": \"Your Name\",\n \"ReplyTo\": \"replies@yourdomain.com\",\n \"Subject\": \"Test Email\",\n \"Text\": \"This is a test email\",\n \"Html\": \"<strong class='preserveHtml' class='preserveHtml'>This is a test email</b>\"\n}\n\n{\n \"key-id\": \"YOUR_KEY_ID\",\n \"key-secret\": \"YOUR_KEY_SECRET\",\n \"SenderEmail\": \"sender@yourdomain.com\",\n \"Recipient\": [\"recipient1@example.com\", \"recipient2@example.com\"],\n \"CC\": \"cc@example.com\",\n \"BCC\": [\"bcc1@example.com\", \"bcc2@example.com\"],\n \"SenderName\": \"Your Name\",\n \"Subject\": \"Team Update\",\n \"Text\": \"Here is the latest update.\"\n}\n\n{\n \"key-id\": \"YOUR_KEY_ID\",\n \"key-secret\": \"YOUR_KEY_SECRET\",\n \"SenderEmail\": \"sender@yourdomain.com\",\n \"Recipient\": \"recipient@example.com\",\n \"Subject\": \"Invoice Attached\",\n \"Text\": \"Please find the invoice attached.\",\n \"Html\": \"<p class='preserveHtml' class='preserveHtml'>Please find the invoice attached.</p>\",\n \"Attachments\": [\n {\n \"url\": \"https://example.com/files/invoice.pdf\",\n \"filename\": \"invoice-2025.pdf\"\n }\n ]\n}\n\n{\n \"error\": \"\",\n \"messages\": [\n {\n \"Id\": \"691a88b85bdae4d8680f16d2\",\n \"Status\": \"new\",\n \"Recipients\": {\n \"To\": [\"recipient1@example.com\", \"recipient2@example.com\"],\n \"CC\": [\"cc@example.com\"],\n \"TotalCount\": 5\n }\n }\n ]\n}\n\nList of emails sent
\nGET https://api.dingomail.com.au/api/v5/email
Content-Type: application/jsonGET /api/v5/email?key-id=YOUR_KEY_ID&key-secret=YOUR_KEY_SECRET&limit=10
\nGET /api/v5/email?key-id=YOUR_KEY_ID&key-secret=YOUR_KEY_SECRET&after=691a88b85bdae4d8680f16d2
\n{
\"error\": \"\",
\"emails\": [
{
\"id\": \"691a88b85bdae4d8680f16d2\",
\"status\": \"sent\",
\"from\": \"sender@yourdomain.com\",
\"sender_name\": \"Your Name\",
\"to\": [\"recipient@example.com\"],
\"cc\": [],
\"subject\": \"Test Email\",
\"created_at\": 1749504000,
\"method\": \"api\"
}
],
\"count\": 1,
\"next_page\": \"/api/v5/email?after=691a88b85bdae4d8680f16d2\"
}
Results are sorted newest first.
\nThe list response does not include email body (text, html), bcc, or attachments. Use the single email endpoint to retrieve the full email.
Pagination is cursor-based using the after parameter. Do not use numeric page offsets.
Retrieve a single email by ID.
\nGET https://api.dingomail.com.au/api/v5/email/{id}
Content-Type: application/jsonGET /api/v5/email/691a88b85bdae4d8680f16d2?key-id=YOUR_KEY_ID&key-secret=YOUR_KEY_SECRET
\n{\n \"error\": \"\",\n \"email\": {\n \"id\": \"691a88b85bdae4d8680f16d2\",\n \"status\": \"sent\",\n \"from\": \"sender@yourdomain.com\",\n \"sender_name\": \"Your Name\",\n \"to\": [\"recipient@example.com\"],\n \"cc\": [],\n \"subject\": \"Test Email\",\n \"text\": \"This is a test email\",\n \"html\": \"This is a test email\",\n \"reply_to\": \"replies@yourdomain.com\",\n \"created_at\": 1749504000,\n \"method\": \"api\"\n }\n}
\ntext, html) and additional fields not returned by the list endpoint.List logins
\nReturns all logins that have access to your account, including their name, email, and current role.
\nGET https://www.5centsms.com.au/api/v5/logins
Content-Type: application/jsonGET https://www.5centsms.com.au/api/v5/logins?key-id=YOUR_KEY_ID&key-secret=YOUR_KEY_SECRET\n\n{\n \"error\": \"\",\n \"logins\": [\n {\n \"login_id\": \"6961a0619df33d11df0d0449\",\n \"name\": \"John Smith\",\n \"email\": \"john@example.com\",\n \"role\": \"admin\"\n },\n {\n \"login_id\": \"699b1d49953149ddb50ba725\",\n \"name\": \"Jane Doe\",\n \"email\": \"jane@example.com\",\n \"role\": \"sender\"\n }\n ],\n \"count\": 2\n}\n\nCreate a login
\nCreate a new login on your account. A login is a person who can sign in to your account on the dashboard. Each login has a role that controls what they can access.
\nIf the email address already belongs to an existing login on another account, they will be added to your account without creating a new login. A welcome email is automatically sent to the new login.
\nPOST https://www.5centsms.com.au/api/v5/logins
Content-Type: application/json{\n \"key-id\": \"YOUR_KEY_ID\",\n \"key-secret\": \"YOUR_KEY_SECRET\",\n \"name\": \"John Smith\",\n \"email\": \"john@example.com\",\n \"mobile\": \"0412345678\",\n \"role\": \"manager\"\n}\n{\n \"error\": \"\",\n \"login_id\": \"699b1d6be62d8bb3ea032639\",\n \"is_new\": true,\n \"message\": \"Login created and welcome email sent\"\n}\nChange login role
\nChange the role of an existing login on your account. Roles control what areas of the dashboard a login can access:
\nPOST https://www.5centsms.com.au/api/v5/logins/{login_id}
Content-Type: application/json{\n \"key-id\": \"YOUR_KEY_ID\",\n \"key-secret\": \"YOUR_KEY_SECRET\",\n \"action\": \"change_role\",\n \"role\": \"sender\"\n}\n{\n \"error\": \"\",\n \"login_id\": \"699b1d6be62d8bb3ea032639\",\n \"role\": \"sender\",\n \"message\": \"Role updated\"\n}\nDelete a login
\nRemove a login from your account. The login will no longer be able to access your account on the dashboard.
\nIf the login is also linked to other accounts, they will continue to exist and can still access those accounts. If your account is their only account, the login will be permanently deleted.
\nDELETE https://www.5centsms.com.au/api/v5/logins/{login_id}
Content-Type: application/json{\n \"key-id\": \"YOUR_KEY_ID\",\n \"key-secret\": \"YOUR_KEY_SECRET\"\n}\n\n{\n \"error\": \"\",\n \"login_id\": \"699b1d6be62d8bb3ea032639\",\n \"message\": \"Login removed from account\"\n}\n\nRemoving a login only removes it from your account. If the login is linked to other accounts, it will continue to exist.
\nIf the login has no remaining accounts after removal, it will be permanently deleted.
\n