{ "info": { "_postman_id": "76a5a0fc-5d6b-41a9-8c26-0ca44d363733", "name": "Transmit SMS API", "description": "

With so many SMS APIs on the market today, you might think that they all do the same thing: send text messages. But with our flexible and powerful suite of APIs, you can do more than that.

", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "lastUpdatedBy": "35240", "uid": "35240-76a5a0fc-5d6b-41a9-8c26-0ca44d363733" }, "item": [ { "name": "send-sms.json", "item": [ { "name": "Send SMS", "id": "85ee2940-46ae-45c6-85fd-031dd91781fe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Message Content Can be up to 612 alphanumeric characters. A part is 160 characters for a single SMS or 153 characters per part for multi-part SMS. If the message contains Unicode UTF8 encoded characters such as emoji\u2019s or non latin character sets, then a single part is 70 characters or 67 characters for multiple parts. More information on message length and encoding: SMS message length and character count", "key": "message", "value": "" }, { "description": "(Required) Recipient Number/s Single number or set of up to 500 comma separated numbers to send the SMS to. Invalid numbers will be ignored. Number must be defined in E.164 international format. You can use countrycode parameter to format numbers that are in local format.", "key": "to", "value": "" }, { "description": "Recipient list This ID is the numerical reference to one of your recipient lists. It is found in the URL and displayed on a destination list page in your account. A list ID can also be created using the add-list call.", "key": "list_id", "value": "" }, { "description": "Format the to number in international format. 2 letter ISO 3166 format country code or country name. Automatically formats numbers to international format required for reliable SMS delivery. eg. In Australia 0422222222 will become 6142222222 when set to AU or Australia. If not set to numbers must be defined in E.164 international format.\n\n| COUNTRY | COUNTRY CODE | LOCAL | INTERNATIONAL |\n|--------|--------------|----------------------|----------------------|\n| Australia | au | 0491570156 |61491570156 |\n| New Zealand | nz | 0212670129 |64212670129 |\n| United Kingdom | gb | 0750017696 |44750017696 |\n| United States | us | 2513551145 |12513551145 |\n", "key": "countrycode", "value": "" }, { "description": "Sender ID Usually a dedicated virtual mobile number (VMN) or short code found in the NUMBERS section of your account. If no value is set here, it will default to the shared Sender ID for the country you are sending to. Can also be an 11 character alphanumeric sender if available for the destination country. You will need to click on the Add Sender ID button found in the NUMBERS section of your account in order to request the use of an Alphanumeric Sender ID. Sender ID functionality varies by country. Global Sender ID Information Mobile and dedicated VMN's should be in international format. Alphanumeric senders (cannot be replied to) can have a maximum of 11 characters. No spaces. If opt out is required, using Custom Sender ID, use parameter [unsub-reply-link] in message to insert opt out link.", "key": "from", "value": "" }, { "description": "Schedule a message at a specific time. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilising UTC Timezone. Eg. 2020-04-27 06:00:00", "key": "send_at", "value": "" }, { "description": "Expire a message send if it is undeliverable Specify the maximum time to attempt to deliver. In minutes, 0 (zero) or not set implies maximum validity period. If a message is not delivered and not failed it is given a PENDING status in the system. These messages can be requested to be expired by the carrier after a certain time. This will return a DLR with a soft-bounce value. If no value is set, messages that remain in a PENDING state will be expired by the system automatically after 72hrs. What does a message with a pending status mean?", "key": "validity", "value": "" }, { "description": "Send Replies to this Email Specify an email address to send responses to this message. Email will come from the email address @transmitsms.com eg. 0456789010@transmitsms.com NOTE: If expectation is for replies to this email to be returned to the recipient as SMS then the email address must be authorised to send messages in your account under the 'EMAIL SMS' section. Emails can also be authorised using the add-email call. How to set up Email SMS", "key": "replies_to_email", "value": "" }, { "description": "Converts this URL into a unique shortened tracking link Converts this URL to unique tapth.is/xxxxxx tracking link for each contact. Inserted into message with variable [tracked-link]. Only one [tracked-link] can be defined per message.", "key": "tracked_link_url", "value": "" }, { "description": "Send a link hit notification to this callback URL A URL on your system which we can call to notify you of a hit on your [tracked-link]. If required, this parameter can be different for each message sent. Will override the default DLR Callback URL if set in the SETTINGS section of your account.", "key": "link_hits_callback", "value": "" }, { "description": "Send a delivery notification to this callback URL A URL on your system which we can call to notify you of Delivery Receipts. If required, this parameter can be different for each message sent. Will override the default DLR Callback URL if set in the SETTINGS section of your account.", "key": "dlr_callback", "value": "" }, { "description": "Send a reply notification to a callback URL A URL on your system which we can call to notify you of incoming messages. If required, this parameter can be different for each message sent. Will override the default Reply Callback URL if set in the SETTINGS section of your account.", "key": "reply_callback", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/send-sms.json", "host": [ "{{baseUrl}}" ], "path": [ "send-sms.json" ] }, "description": "You can elect to pass us the recipient numbers from your database each time you make a call, or you can elect to store recipient data in a contact list and submit only the list_id to trigger the send. This is best for large databases. To add a list please refer to the add-list call." }, "response": [ { "id": "4af9ca49-3026-4df5-a131-a6ce2142bf47", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Message Content Can be up to 612 alphanumeric characters. A part is 160 characters for a single SMS or 153 characters per part for multi-part SMS. If the message contains Unicode UTF8 encoded characters such as emoji\u2019s or non latin character sets, then a single part is 70 characters or 67 characters for multiple parts. More information on message length and encoding: SMS message length and character count", "key": "message", "value": "" }, { "description": "(Required) Recipient Number/s Single number or set of up to 500 comma separated numbers to send the SMS to. Invalid numbers will be ignored. Number must be defined in E.164 international format. You can use countrycode parameter to format numbers that are in local format.", "key": "to", "value": "" }, { "description": "Recipient list This ID is the numerical reference to one of your recipient lists. It is found in the URL and displayed on a destination list page in your account. A list ID can also be created using the add-list call.", "key": "list_id", "value": "" }, { "description": "Format the to number in international format. 2 letter ISO 3166 format country code or country name. Automatically formats numbers to international format required for reliable SMS delivery. eg. In Australia 0422222222 will become 6142222222 when set to AU or Australia. If not set to numbers must be defined in E.164 international format.\n\n| COUNTRY | COUNTRY CODE | LOCAL | INTERNATIONAL |\n|--------|--------------|----------------------|----------------------|\n| Australia | au | 0491570156 |61491570156 |\n| New Zealand | nz | 0212670129 |64212670129 |\n| United Kingdom | gb | 0750017696 |44750017696 |\n| United States | us | 2513551145 |12513551145 |\n", "key": "countrycode", "value": "" }, { "description": "Sender ID Usually a dedicated virtual mobile number (VMN) or short code found in the NUMBERS section of your account. If no value is set here, it will default to the shared Sender ID for the country you are sending to. Can also be an 11 character alphanumeric sender if available for the destination country. You will need to click on the Add Sender ID button found in the NUMBERS section of your account in order to request the use of an Alphanumeric Sender ID. Sender ID functionality varies by country. Global Sender ID Information Mobile and dedicated VMN's should be in international format. Alphanumeric senders (cannot be replied to) can have a maximum of 11 characters. No spaces. If opt out is required, using Custom Sender ID, use parameter [unsub-reply-link] in message to insert opt out link.", "key": "from", "value": "" }, { "description": "Schedule a message at a specific time. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilising UTC Timezone. Eg. 2020-04-27 06:00:00", "key": "send_at", "value": "" }, { "description": "Expire a message send if it is undeliverable Specify the maximum time to attempt to deliver. In minutes, 0 (zero) or not set implies maximum validity period. If a message is not delivered and not failed it is given a PENDING status in the system. These messages can be requested to be expired by the carrier after a certain time. This will return a DLR with a soft-bounce value. If no value is set, messages that remain in a PENDING state will be expired by the system automatically after 72hrs. What does a message with a pending status mean?", "key": "validity", "value": "" }, { "description": "Send Replies to this Email Specify an email address to send responses to this message. Email will come from the email address @transmitsms.com eg. 0456789010@transmitsms.com NOTE: If expectation is for replies to this email to be returned to the recipient as SMS then the email address must be authorised to send messages in your account under the 'EMAIL SMS' section. Emails can also be authorised using the add-email call. How to set up Email SMS", "key": "replies_to_email", "value": "" }, { "description": "Converts this URL into a unique shortened tracking link Converts this URL to unique tapth.is/xxxxxx tracking link for each contact. Inserted into message with variable [tracked-link]. Only one [tracked-link] can be defined per message.", "key": "tracked_link_url", "value": "" }, { "description": "Send a link hit notification to this callback URL A URL on your system which we can call to notify you of a hit on your [tracked-link]. If required, this parameter can be different for each message sent. Will override the default DLR Callback URL if set in the SETTINGS section of your account.", "key": "link_hits_callback", "value": "" }, { "description": "Send a delivery notification to this callback URL A URL on your system which we can call to notify you of Delivery Receipts. If required, this parameter can be different for each message sent. Will override the default DLR Callback URL if set in the SETTINGS section of your account.", "key": "dlr_callback", "value": "" }, { "description": "Send a reply notification to a callback URL A URL on your system which we can call to notify you of incoming messages. If required, this parameter can be different for each message sent. Will override the default Reply Callback URL if set in the SETTINGS section of your account.", "key": "reply_callback", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/send-sms.json", "host": [ "{{baseUrl}}" ], "path": [ "send-sms.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message_id\": \"\",\n \"send_at\": \"\",\n \"recipients\": \"\",\n \"cost\": \"\",\n \"sms\": \"\",\n \"list\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"delivery_stats\": {\n \"delivered\": \"\",\n \"pending\": \"\",\n \"bounced\": \"\",\n \"responses\": \"\",\n \"optouts\": \"\"\n },\n \"error\": {\n \"code\": \"\",\n \"header\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-4af9ca49-3026-4df5-a131-a6ce2142bf47" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-85ee2940-46ae-45c6-85fd-031dd91781fe" } ], "id": "f5287e16-87c8-4204-a7af-db5cd36d70f4", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-f5287e16-87c8-4204-a7af-db5cd36d70f4" }, { "name": "add-contacts-bulk.json", "item": [ { "name": "Bulk Add Contacts from CSV File", "id": "29ce4d54-cf84-4ded-bc4b-a31bb4ac7181", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) ID of the list to be added to. This ID is the numerical reference to one of your recipient lists. Required if name is not set.", "key": "list_id", "value": "" }, { "description": "(Required) Name of the list to create and add contacts to. If set, a new list will be created with this name. The list ID will be returned in the API response. Required if list_id is not set.", "key": "name", "value": "" }, { "description": "Format the number in international format. 2-letter ISO 3166 format country code or country name. Automatically formats numbers to international format required for reliable SMS delivery.", "key": "countrycode", "value": "" }, { "description": "URL location of the CSV file containing the contact list.\n\n- Must be a direct URL to the file, cannot be a redirected URL. \n- Cannot be a file on a local machine.\n- File must contain a column with the header \u2018mobile\u2019\n- To maximise API performance no error will be returned if call fails. ID returned in response will be automatically deleted.\n- To get status of call use add-contacts-bulk-progress\n- Basic auth can be used to secure file eg. https://username:password@domain.com/file\n", "key": "file_url", "value": "" }, { "description": "Create or map a custom field.\n\n- There are 10 custom field slots available. The value n is the number of the custom field slot 1 through 10.\n- Create a field name using field_n=name e.g. field_1=email.\n- Headers in your file that match the custom field name will be automatically mapped. e.g. Column in CSV file named email will be automatically mapped to field_1=email.\n- If name contains spaces or symbols, other than letters or numbers, these must be URL encoded\n", "key": "field_n", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/add-contacts-bulk.json", "host": [ "{{baseUrl}}" ], "path": [ "add-contacts-bulk.json" ] }, "description": "Add bulk contacts to a list from a file\n\nThe add-contacts-bulk request can be used to add a CSV file of contacts to an existing list. It can also be used to create a new list and upload a CSV file of contacts to it. If a contact is added that already exists in a list, any existing data will be updated.\n\n**The return code 200 is only used to indicate that the API call has successfully hit our server. It in no way indicates if the contacts have been added\\updated successfully.\nTo find the status of an upload, including error messages, you must use the add-contacts-bulk-progress endpoint.**\n\n```\nCSV File Format and Example:\n Firstname,Lastname,Mobile,\"Custom Field 1\"\n Jane,Doe,61412345678,10.44\n\nThe minimum required for successful import is Mobile.\n\nThe order above must be followed.\n```" }, "response": [ { "id": "383bac54-9fe5-48a5-b7f5-5831ec2b11a6", "name": "Successful response containing the list ID and error details.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) ID of the list to be added to. This ID is the numerical reference to one of your recipient lists. Required if name is not set.", "key": "list_id", "value": "" }, { "description": "(Required) Name of the list to create and add contacts to. If set, a new list will be created with this name. The list ID will be returned in the API response. Required if list_id is not set.", "key": "name", "value": "" }, { "description": "Format the number in international format. 2-letter ISO 3166 format country code or country name. Automatically formats numbers to international format required for reliable SMS delivery.", "key": "countrycode", "value": "" }, { "description": "URL location of the CSV file containing the contact list.\n\n- Must be a direct URL to the file, cannot be a redirected URL. \n- Cannot be a file on a local machine.\n- File must contain a column with the header \u2018mobile\u2019\n- To maximise API performance no error will be returned if call fails. ID returned in response will be automatically deleted.\n- To get status of call use add-contacts-bulk-progress\n- Basic auth can be used to secure file eg. https://username:password@domain.com/file\n", "key": "file_url", "value": "" }, { "description": "Create or map a custom field.\n\n- There are 10 custom field slots available. The value n is the number of the custom field slot 1 through 10.\n- Create a field name using field_n=name e.g. field_1=email.\n- Headers in your file that match the custom field name will be automatically mapped. e.g. Column in CSV file named email will be automatically mapped to field_1=email.\n- If name contains spaces or symbols, other than letters or numbers, these must be URL encoded\n", "key": "field_n", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/add-contacts-bulk.json", "host": [ "{{baseUrl}}" ], "path": [ "add-contacts-bulk.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"list_id\": \"\",\n \"error\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-383bac54-9fe5-48a5-b7f5-5831ec2b11a6" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-29ce4d54-cf84-4ded-bc4b-a31bb4ac7181" } ], "id": "30ad44f6-4e4d-4ac7-9e1a-8b9abe61826c", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-30ad44f6-4e4d-4ac7-9e1a-8b9abe61826c" }, { "name": "cancel-sms.json", "item": [ { "name": "Cancel SMS", "id": "cfec47a2-33ed-4668-895d-197bf34c4b47", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID assigned to the message sent.", "key": "id", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/cancel-sms.json", "host": [ "{{baseUrl}}" ], "path": [ "cancel-sms.json" ] }, "description": "Messages scheduled can be cancelled using the message ID. Return a JSON or XML response by adding the appropriate extension to the base url (See examples)." }, "response": [ { "id": "c2dd0739-a145-415f-8d84-65973c337876", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID assigned to the message sent.", "key": "id", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/cancel-sms.json", "host": [ "{{baseUrl}}" ], "path": [ "cancel-sms.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Date", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Type", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Transfer-Encoding", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Connection", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Server", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Expires", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Cache-Control", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Pragma", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Mashape-Billing", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Content-Encoding", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Vary", "value": "" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-c2dd0739-a145-415f-8d84-65973c337876" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-cfec47a2-33ed-4668-895d-197bf34c4b47" } ], "id": "ec450487-fb4f-48ae-aa61-ba03c20230db", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-ec450487-fb4f-48ae-aa61-ba03c20230db" }, { "name": "format-number.json", "item": [ { "name": "Format Number", "id": "249d2324-ecd9-4433-82fd-6b0bdc951da2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric to check Badly formatted number coming from source such as CRM or exported list.", "key": "msisdn", "value": "" }, { "description": "(Required) 2 letter ISO countrycode or country name Global SMS delivery list", "key": "countrycode", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/format-number.json", "host": [ "{{baseUrl}}" ], "path": [ "format-number.json" ] }, "description": "In the majority of cases, mobile phone number data coming from external systems is not ideal for SMS delivery. For highest reliability and to be able to route correctly a mobile number should be formatted in international format E.164\nNormally however a number is stored in a CRM or contact database in local format, with spaces, hyphens and other types of unwanted characters that can cause a delivery to fail. The format-number call is used to sanitise a number by combining the country and the number. eg.\n> Australia 0438 333 061 will become 61438333061\n> New Zealand 0212172782 will become 64212172782\n> USA (281) 869-1226 will become 12818691226" }, "response": [ { "id": "4e529803-eb50-4f04-9bea-615fb597b6e8", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric to check Badly formatted number coming from source such as CRM or exported list.", "key": "msisdn", "value": "" }, { "description": "(Required) 2 letter ISO countrycode or country name Global SMS delivery list", "key": "countrycode", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/format-number.json", "host": [ "{{baseUrl}}" ], "path": [ "format-number.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"number\": {\n \"countrycode\": \"\",\n \"nationalnumber\": \"\",\n \"national_leading_zeroes\": \"\",\n \"rawinput\": \"\",\n \"international\": \"\",\n \"type\": \"\",\n \"isValid\": \"\"\n },\n \"error\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-4e529803-eb50-4f04-9bea-615fb597b6e8" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-249d2324-ecd9-4433-82fd-6b0bdc951da2" } ], "id": "8bb3687f-1b8d-4765-ba94-515d72185426", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-8bb3687f-1b8d-4765-ba94-515d72185426" }, { "name": "get-sms-responses.json", "item": [ { "name": "Get Responses by MessageID, Keyword or Mobile", "id": "077da969-ae12-4c07-b0a6-ba24f4fc013a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID assigned to the message sent. Required if **keyword_id** or **keyword is** not set.", "key": "message_id", "value": "" }, { "description": "(Required) Numeric ID assigned to the keyword. ID is assigned on creation of keyword in your account. A keyword can be created using add-keyword request. Keyword ID can be returned using the get-keyword request. NOTE A keyword IS NOT a specific string within the message. Required if **message_id** or **keyword** not set", "key": "keyword_id", "value": "" }, { "description": "(Required) Keyword name. Name is assigned on creation of keyword in your account. A keyword can be created using add-keyword request. Keyword name can be returned using the get-keyword request. NOTE A keyword IS NOT a specific string within the message. Required if **message_id** or **keyword** not set", "key": "keyword", "value": "" }, { "description": "(Required) Filter results by Virtual Mobile Number (VMN). Get responses for messages containing a keyword received on a specific VMN. Numbers can be returned using the get-numbers request. Required if **keyword** not set", "key": "number", "value": "" }, { "description": "A date within the last 12 months to start the report from. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. If start and end date not supplied, will get everything from the last 30 days only.", "key": "start", "value": "" }, { "description": "A date within the last 12 months to end the report at. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. If start and end date not supplied, will get everything from the last 30 days only.", "key": "end", "value": "" }, { "description": "Filter results by Responder Mobile Number (VMN). Get responses to messages that were from a specific mobile number.", "key": "msisdn", "value": "" }, { "description": "Include text of message that reply was sent to.", "key": "include_original", "value": "" }, { "description": "Page number, for pagination.", "key": "page", "value": "" }, { "description": "Maximum results returned per page.", "key": "max", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-sms-responses.json", "host": [ "{{baseUrl}}" ], "path": [ "get-sms-responses.json" ] }, "description": "Responses to your outgoing messages can be picked up in a few different ways. Your DLR Callback URL in your account settings, is the default URL we post incoming DLR's to. You can also set the DLR Callback URL separately for individual messages, using a parameter on the send-sms call. You can also poll the following endpoints for responses." }, "response": [ { "id": "efd992cd-bee3-4b4d-84ac-cfe9b034fe29", "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID assigned to the message sent. Required if **keyword_id** or **keyword is** not set.", "key": "message_id", "value": "" }, { "description": "(Required) Numeric ID assigned to the keyword. ID is assigned on creation of keyword in your account. A keyword can be created using add-keyword request. Keyword ID can be returned using the get-keyword request. NOTE A keyword IS NOT a specific string within the message. Required if **message_id** or **keyword** not set", "key": "keyword_id", "value": "" }, { "description": "(Required) Keyword name. Name is assigned on creation of keyword in your account. A keyword can be created using add-keyword request. Keyword name can be returned using the get-keyword request. NOTE A keyword IS NOT a specific string within the message. Required if **message_id** or **keyword** not set", "key": "keyword", "value": "" }, { "description": "(Required) Filter results by Virtual Mobile Number (VMN). Get responses for messages containing a keyword received on a specific VMN. Numbers can be returned using the get-numbers request. Required if **keyword** not set", "key": "number", "value": "" }, { "description": "A date within the last 12 months to start the report from. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. If start and end date not supplied, will get everything from the last 30 days only.", "key": "start", "value": "" }, { "description": "A date within the last 12 months to end the report at. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. If start and end date not supplied, will get everything from the last 30 days only.", "key": "end", "value": "" }, { "description": "Filter results by Responder Mobile Number (VMN). Get responses to messages that were from a specific mobile number.", "key": "msisdn", "value": "" }, { "description": "Include text of message that reply was sent to.", "key": "include_original", "value": "" }, { "description": "Page number, for pagination.", "key": "page", "value": "" }, { "description": "Maximum results returned per page.", "key": "max", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-sms-responses.json", "host": [ "{{baseUrl}}" ], "path": [ "get-sms-responses.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-efd992cd-bee3-4b4d-84ac-cfe9b034fe29" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-077da969-ae12-4c07-b0a6-ba24f4fc013a" } ], "id": "7cc21348-c3a6-4f59-b5ff-297c789f59e0", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-7cc21348-c3a6-4f59-b5ff-297c789f59e0" }, { "name": "get-user-sms-responses.json", "item": [ { "name": "Get Responses by Time Frame", "id": "00c62b5b-2619-4c1f-abaf-ff79ff337684", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/get-user-sms-responses.json?mobile=&countrycode=&start=&end=&sort_field=&order=&page=&max=", "host": [ "{{baseUrl}}" ], "path": [ "get-user-sms-responses.json" ], "query": [ { "description": "(Required) The mobile number of the recipient. Number must be defined in E.164 international format. You can use countrycode parameter to format numbers that are in local format.", "key": "mobile", "value": "" }, { "description": "Format the mobile number to international format using 2-letter ISO 3166 country code or country name. 2 letter ISO 3166 format country code or country name. Automatically formats numbers to international format required for reliable SMS delivery. eg. In Australia 0422222222 will become 6142222222 when set to AU or Australia. If not set to numbers must be defined in E.164 international format.\n| COUNTRY | COUNTRY CODE | LOCAL | INTERNATIONAL |\n|----------------|--------------|------------|---------------|\n| Australia | au | 0491570156 | 61491570156 |\n| New Zealand | nz | 0212670129 | 64212670129 |\n| United Kingdom | gb | 0750017696 | 44750017696 |\n| United States | us | 2513551145 | 12513551145 |\n", "key": "countrycode", "value": "" }, { "description": "The start date and time to filter messages. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. If start and end date not supplied, will get everything from the account registration to current date.", "key": "start", "value": "" }, { "description": "The end date and time to filter messages. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. If start and end date not supplied, will get everything from the account registration to current date.", "key": "end", "value": "" }, { "description": "Sort by one of the following fields: delivery_status, message_id, datetime_send.\n", "key": "sort_field", "value": "" }, { "description": "Order by either ascending (asc) or descending (desc).", "key": "order", "value": "" }, { "description": "Page number for pagination.", "key": "page", "value": "" }, { "description": "Maximum results returned per page.", "key": "max", "value": "" } ] }, "description": "Gets the messsages from a defined timeframe.\n\n## Pagination\n\nThis endpoint supports pagination using the page/max pattern:\n\n**Parameters:**\n- `page`: Page number starting from 1 (default: 1)\n- `max`: Maximum results per page (default: 10, recommended: 10-100)\n- `mobile`: Required mobile number filter (E.164 format)\n- `start`/`end`: Optional date range filters\n\n**Response Structure:**\nThe response includes pagination metadata:\n- `page.count`: Total number of pages available\n- `page.number`: Current page number\n- `total`: Total count of SMS responses matching the filters\n\n**Navigation Examples:**\n```\n# First page of responses for a mobile number (default)\nGET /get-user-sms-responses.json?mobile=61478038915\n\n# Second page with 25 results per page\nGET /get-user-sms-responses.json?mobile=61478038915&page=2&max=25\n\n# Responses within date range with pagination\nGET /get-user-sms-responses.json?mobile=61478038915&start=2020-04-01T00:00:00Z&end=2020-04-30T23:59:59Z&max=50\n\n# Navigate through all pages\nGET /get-user-sms-responses.json?mobile=61478038915&page=1&max=20\nGET /get-user-sms-responses.json?mobile=61478038915&page=2&max=20\n# Continue until page.number >= page.count\n```\n\n**Best Practices:**\n- Use max=10-25 for UI display of conversation history\n- Use max=50-100 for data export or analysis tasks\n- Always specify date ranges for large datasets to improve performance\n- Check page.count to determine if more pages exist\n- Use sorting parameters (sort_field, order) to organize results effectively\n- Consider the mobile number is required - this endpoint is designed for per-contact message history" }, "response": [ { "id": "33770ae9-483d-4c39-b48a-9c98c1d095cb", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/get-user-sms-responses.json?mobile=&countrycode=&start=&end=&sort_field=&order=&page=&max=", "host": [ "{{baseUrl}}" ], "path": [ "get-user-sms-responses.json" ], "query": [ { "description": "(Required) The mobile number of the recipient. Number must be defined in E.164 international format. You can use countrycode parameter to format numbers that are in local format.", "key": "mobile", "value": "" }, { "description": "Format the mobile number to international format using 2-letter ISO 3166 country code or country name. 2 letter ISO 3166 format country code or country name. Automatically formats numbers to international format required for reliable SMS delivery. eg. In Australia 0422222222 will become 6142222222 when set to AU or Australia. If not set to numbers must be defined in E.164 international format.\n| COUNTRY | COUNTRY CODE | LOCAL | INTERNATIONAL |\n|----------------|--------------|------------|---------------|\n| Australia | au | 0491570156 | 61491570156 |\n| New Zealand | nz | 0212670129 | 64212670129 |\n| United Kingdom | gb | 0750017696 | 44750017696 |\n| United States | us | 2513551145 | 12513551145 |\n", "key": "countrycode", "value": "" }, { "description": "The start date and time to filter messages. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. If start and end date not supplied, will get everything from the account registration to current date.", "key": "start", "value": "" }, { "description": "The end date and time to filter messages. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. If start and end date not supplied, will get everything from the account registration to current date.", "key": "end", "value": "" }, { "description": "Sort by one of the following fields: delivery_status, message_id, datetime_send.\n", "key": "sort_field", "value": "" }, { "description": "Order by either ascending (asc) or descending (desc).", "key": "order", "value": "" }, { "description": "Page number for pagination.", "key": "page", "value": "" }, { "description": "Maximum results returned per page.", "key": "max", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"message_id\": \"\",\n \"list_id\": \"\",\n \"received_at\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"msisdn\": \"\",\n \"error\": {\n \"CODE\": \"\",\n \"HEADER\": \"\",\n \"DESCRIPTION\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-33770ae9-483d-4c39-b48a-9c98c1d095cb" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-00c62b5b-2619-4c1f-abaf-ff79ff337684" } ], "id": "5a3ebc8f-b2a9-4412-9f00-2977841ce680", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-5a3ebc8f-b2a9-4412-9f00-2977841ce680" }, { "name": "get-sms.json", "item": [ { "name": "Get Message/Campaign Information", "id": "c1857766-abd4-449e-b67f-b122e48d4eb6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID assigned to the message sent.\nThis ID was returned in the send-sms response.\n", "key": "message_id", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-sms.json", "host": [ "{{baseUrl}}" ], "path": [ "get-sms.json" ] }, "description": "\nThis will return information about the campaign, including the message, list etc. It will not however return individual messages with populated variables or tracking links. To retrieve final individual messages use **get-sms-delivery-status.**" }, "response": [ { "id": "dcdf69db-7a42-4135-91b7-a42fe8a4e026", "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID assigned to the message sent.\nThis ID was returned in the send-sms response.\n", "key": "message_id", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-sms.json", "host": [ "{{baseUrl}}" ], "path": [ "get-sms.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message_id\": \"\",\n \"send_at\": \"\",\n \"recipients\": \"\",\n \"cost\": \"\",\n \"sms\": \"\",\n \"message\": \"\",\n \"list\": \"\",\n \"delivery_stats\": {\n \"delivered\": \"\",\n \"pending\": \"\",\n \"bounced\": \"\",\n \"responses\": \"\",\n \"optouts\": \"\"\n },\n \"error\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-dcdf69db-7a42-4135-91b7-a42fe8a4e026" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-c1857766-abd4-449e-b67f-b122e48d4eb6" } ], "id": "14e8cff2-5cfc-4d6c-9d55-b419f89d2af6", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-14e8cff2-5cfc-4d6c-9d55-b419f89d2af6" }, { "name": "get-sms-delivery-status.json", "item": [ { "name": "Get SMS Delivery Status", "id": "b6e2524c-67fd-41c9-ba63-1ed62db0fc05", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID assigned to the message sent. This ID was returned in the send-sms response.", "key": "message_id", "value": "" }, { "description": "(Required) Mobile number of recipient", "key": "msisdn", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-sms-delivery-status.json", "host": [ "{{baseUrl}}" ], "path": [ "get-sms-delivery-status.json" ] }, "description": "\nRetrieves detailed information about messages sent to a specific recipient. This included full message content including populated variables." }, "response": [ { "id": "3dbcf3c0-ff84-4e4f-ab1c-41aef4d74e79", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID assigned to the message sent. This ID was returned in the send-sms response.", "key": "message_id", "value": "" }, { "description": "(Required) Mobile number of recipient", "key": "msisdn", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-sms-delivery-status.json", "host": [ "{{baseUrl}}" ], "path": [ "get-sms-delivery-status.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message_id\": \"\",\n \"sender_id\": \"\",\n \"mobile\": \"\",\n \"send_at\": \"\",\n \"datetime\": \"\",\n \"message\": \"\",\n \"status\": {\n \"delivered\": \"\",\n \"failed\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-3dbcf3c0-ff84-4e4f-ab1c-41aef4d74e79" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-b6e2524c-67fd-41c9-ba63-1ed62db0fc05" } ], "id": "c56819dc-c647-4017-9b81-d1dbb79e0c38", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-c56819dc-c647-4017-9b81-d1dbb79e0c38" }, { "name": "get-sms-sent-count.json", "item": [ { "name": "Get SMS Sent Count", "id": "34d13962-fee5-403e-a0a5-3e89180c34a2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "A date to start the report from. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. Start and end date must be within 7 days. If start and end date are not supplied, the report will cover the last 24 hours only.", "key": "start", "value": "" }, { "description": "A date to end the report at. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. Start and end date must be within 7 days. If start and end date are not supplied, the report will cover the last 24 hours only.", "key": "end", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-sms-sent-count.json", "host": [ "{{baseUrl}}" ], "path": [ "get-sms-sent-count.json" ] }, "description": "Retrieves total number of SMS sent in a given timeframe" }, "response": [ { "id": "995b3c5d-0c75-41c0-ad1a-e2f772d11001", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "A date to start the report from. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. Start and end date must be within 7 days. If start and end date are not supplied, the report will cover the last 24 hours only.", "key": "start", "value": "" }, { "description": "A date to end the report at. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. Start and end date must be within 7 days. If start and end date are not supplied, the report will cover the last 24 hours only.", "key": "end", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-sms-sent-count.json", "host": [ "{{baseUrl}}" ], "path": [ "get-sms-sent-count.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"count\": \"\",\n \"error\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-995b3c5d-0c75-41c0-ad1a-e2f772d11001" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-34d13962-fee5-403e-a0a5-3e89180c34a2" } ], "id": "99683f20-31a4-409b-a5b2-14d54f81891b", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-99683f20-31a4-409b-a5b2-14d54f81891b" }, { "name": "get-user-sms-sent.json", "item": [ { "name": "Get Activity Report", "id": "57b4ea3c-9c0b-499e-8d72-64cfe29796df", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) A date to start the report from. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. Eg. 2020-04-27 06:00:00", "key": "start", "value": "" }, { "description": "(Required) A date to end the report at. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. Eg. 2020-04-27 06:00:00", "key": "end", "value": "" }, { "description": "Mobile number of contact being queried", "key": "msisdn", "value": "" }, { "description": "Page number, for pagination", "key": "page", "value": "" }, { "description": "Maximum results returned per page", "key": "max", "value": "" }, { "description": "response_style = 'array' returns custom field lists as an array", "key": "response_style", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-user-sms-sent.json", "host": [ "{{baseUrl}}" ], "path": [ "get-user-sms-sent.json" ] }, "description": "Retrieve information on messages sent during a period of time" }, "response": [ { "id": "0bcd311d-ceaa-48f2-941e-82fae31ba05e", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) A date to start the report from. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. Eg. 2020-04-27 06:00:00", "key": "start", "value": "" }, { "description": "(Required) A date to end the report at. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. Eg. 2020-04-27 06:00:00", "key": "end", "value": "" }, { "description": "Mobile number of contact being queried", "key": "msisdn", "value": "" }, { "description": "Page number, for pagination", "key": "page", "value": "" }, { "description": "Maximum results returned per page", "key": "max", "value": "" }, { "description": "response_style = 'array' returns custom field lists as an array", "key": "response_style", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-user-sms-sent.json", "host": [ "{{baseUrl}}" ], "path": [ "get-user-sms-sent.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"page\": {\n \"count\": \"\",\n \"number\": \"\"\n },\n \"total\": \"\",\n \"messages\": [\n {\n \"id\": \"\",\n \"message_id\": \"\",\n \"message\": \"\",\n \"sent_at\": \"\",\n \"msisdn\": \"\",\n \"caller_id\": \"\",\n \"status\": \"\"\n },\n {\n \"id\": \"\",\n \"message_id\": \"\",\n \"message\": \"\",\n \"sent_at\": \"\",\n \"msisdn\": \"\",\n \"caller_id\": \"\",\n \"status\": \"\"\n }\n ],\n \"error\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-0bcd311d-ceaa-48f2-941e-82fae31ba05e" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-57b4ea3c-9c0b-499e-8d72-64cfe29796df" } ], "id": "0727e560-da84-4329-8bc4-c6178a0e3552", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-0727e560-da84-4329-8bc4-c6178a0e3552" }, { "name": "get-contact-sms-stats.json", "item": [ { "name": "Get SMS Sent to Account", "id": "3b5a038f-3230-40c8-b761-9c1b355c0be0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The mobile number of the recipient. Number must be defined in E.164 international format. You can use countrycode parameter to format numbers that are in local format.", "key": "mobile", "value": "" }, { "description": "Format the mobile number to international format using 2-letter ISO 3166 country code or country name. 2 letter ISO 3166 format country code or country name. Automatically formats numbers to international format required for reliable SMS delivery. eg. In Australia 0422222222 will become 6142222222 when set to AU or Australia. If not set to numbers must be defined in E.164 international format.\n\n| COUNTRY | COUNTRY CODE | LOCAL | INTERNATIONAL |\n|----------------|--------------|------------|---------------|\n| Australia | au | 0491570156 | 61491570156 |\n| New Zealand | nz | 0212670129 | 64212670129 |\n| United Kingdom | gb | 0750017696 | 44750017696 |\n| United States | us | 2513551145 | 12513551145 |\n", "key": "countrycode", "value": "" }, { "description": "The start date and time to filter messages. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. If start and end date not supplied, will get everything from the account registration to current date.", "key": "start", "value": "" }, { "description": "The end date and time to filter messages. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. If start and end date not supplied, will get everything from the account registration to current date.", "key": "end", "value": "" }, { "description": "Sort by one of the following fields\\\":\"\" delivery_status, message_id, datetime_send.", "key": "sort_field", "value": "" }, { "description": "Order by either ascending (asc) or descending (desc).", "key": "order", "value": "" }, { "description": "Page number for pagination.", "key": "page", "value": "" }, { "description": "Maximum results returned per page.", "key": "max", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-contact-sms-stats.json", "host": [ "{{baseUrl}}" ], "path": [ "get-contact-sms-stats.json" ] }, "description": "This will return paginated information regarding individual messages sent to provided mobile number." }, "response": [ { "id": "4be4790f-f1f4-44e3-9e96-b6d5201dac65", "name": "OK", "originalRequest": { "method": "GET", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The mobile number of the recipient. Number must be defined in E.164 international format. You can use countrycode parameter to format numbers that are in local format.", "key": "mobile", "value": "" }, { "description": "Format the mobile number to international format using 2-letter ISO 3166 country code or country name. 2 letter ISO 3166 format country code or country name. Automatically formats numbers to international format required for reliable SMS delivery. eg. In Australia 0422222222 will become 6142222222 when set to AU or Australia. If not set to numbers must be defined in E.164 international format.\n\n| COUNTRY | COUNTRY CODE | LOCAL | INTERNATIONAL |\n|----------------|--------------|------------|---------------|\n| Australia | au | 0491570156 | 61491570156 |\n| New Zealand | nz | 0212670129 | 64212670129 |\n| United Kingdom | gb | 0750017696 | 44750017696 |\n| United States | us | 2513551145 | 12513551145 |\n", "key": "countrycode", "value": "" }, { "description": "The start date and time to filter messages. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. If start and end date not supplied, will get everything from the account registration to current date.", "key": "start", "value": "" }, { "description": "The end date and time to filter messages. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. If start and end date not supplied, will get everything from the account registration to current date.", "key": "end", "value": "" }, { "description": "Sort by one of the following fields\\\":\"\" delivery_status, message_id, datetime_send.", "key": "sort_field", "value": "" }, { "description": "Order by either ascending (asc) or descending (desc).", "key": "order", "value": "" }, { "description": "Page number for pagination.", "key": "page", "value": "" }, { "description": "Maximum results returned per page.", "key": "max", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-contact-sms-stats.json", "host": [ "{{baseUrl}}" ], "path": [ "get-contact-sms-stats.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"page\": {\n \"count\": \"\",\n \"number\": \"\"\n },\n \"total\": \"\",\n \"records\": [\n {\n \"message_id\": \"\",\n \"datetime_send\": \"\",\n \"delivery_status\": \"\"\n },\n {\n \"message_id\": \"\",\n \"datetime_send\": \"\",\n \"delivery_status\": \"\"\n }\n ],\n \"error\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-4be4790f-f1f4-44e3-9e96-b6d5201dac65" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-3b5a038f-3230-40c8-b761-9c1b355c0be0" } ], "id": "20eee3d3-5add-42d7-906d-dc58b395fa00", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-20eee3d3-5add-42d7-906d-dc58b395fa00" }, { "name": "get-sms-stats.json", "item": [ { "name": "Get Message/Campaign Report", "id": "ad420150-c6ea-48a5-a9f7-32736005fdda", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID assigned to the message sent.", "key": "message_id", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-sms-stats.json", "host": [ "{{baseUrl}}" ], "path": [ "get-sms-stats.json" ] }, "description": "Get the delivery status of a message or campaign that you have sent.\nCount of different reporting stats we collect. Delivery reports are marked using a DLR (Delivery Receipt) or Acknowledgement (ACK) returned from the carrier, a DLR is a handset level report and an ACK is simply a response from the carrier that the request was received. Global carriers have different functionality available. See our Global Delivery List for details." }, "response": [ { "id": "2a3e2457-d1bb-4548-a2ea-165878b7fcc8", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID assigned to the message sent.", "key": "message_id", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-sms-stats.json", "host": [ "{{baseUrl}}" ], "path": [ "get-sms-stats.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"stats\": {\n \"hard_bounced\": \"\",\n \"soft_bounced\": \"\",\n \"total\": \"\",\n \"recipientCount\": \"\",\n \"delivered\": \"\",\n \"pending\": \"\",\n \"bounced\": \"\",\n \"responses\": \"\",\n \"opt-outs\": \"\",\n \"link_hits\": \"\"\n },\n \"error\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-2a3e2457-d1bb-4548-a2ea-165878b7fcc8" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-ad420150-c6ea-48a5-a9f7-32736005fdda" } ], "id": "0a362ef0-6190-46e2-a2d6-0a1dab69d561", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-0a362ef0-6190-46e2-a2d6-0a1dab69d561" }, { "name": "get-sms-sent.json", "item": [ { "name": "Get Message/Campaign Recipients", "id": "c2bb24ea-9bf7-4894-8c07-6ba7e717f573", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID assigned to the message sent. This ID was returned in the send-sms response.\n", "key": "message_id", "value": "" }, { "description": "Recipient list ID. Provide list_id if contact is not associated with a campaign send. It will look up custom data on this list for the contact and return it in the response.\n", "key": "list_id", "value": "" }, { "description": "Page number, for pagination.\n", "key": "page", "value": "" }, { "description": "Maximum results returned per page.\n", "key": "max", "value": "" }, { "description": "Only show messages with specific delivery status.\n\n| VALUE | DESCRIPTION |\n|---------|---------------------------------|\n| delivered | Only return delivered messages |\n| failed | Only return failed messages |\n| pending | Only return pending messages |\n", "key": "delivery", "value": "" }, { "description": "Whether to include opt outs.\n\n| VALUE | DESCRIPTION |\n|-------|-------------------------|\n| true | Only return opt outs |\n| false | Do not include opt outs |\n", "key": "optouts", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-sms-sent.json", "host": [ "{{baseUrl}}" ], "path": [ "get-sms-sent.json" ] }, "description": "Get information about a message send and it's recipients\nThis will return paginated information regarding individual recipients on a campaign or message send." }, "response": [ { "id": "6a291803-78ea-44a6-9541-4add8383225a", "name": "Successful response containing information about the sent message or campaign.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID assigned to the message sent. This ID was returned in the send-sms response.\n", "key": "message_id", "value": "" }, { "description": "Recipient list ID. Provide list_id if contact is not associated with a campaign send. It will look up custom data on this list for the contact and return it in the response.\n", "key": "list_id", "value": "" }, { "description": "Page number, for pagination.\n", "key": "page", "value": "" }, { "description": "Maximum results returned per page.\n", "key": "max", "value": "" }, { "description": "Only show messages with specific delivery status.\n\n| VALUE | DESCRIPTION |\n|---------|---------------------------------|\n| delivered | Only return delivered messages |\n| failed | Only return failed messages |\n| pending | Only return pending messages |\n", "key": "delivery", "value": "" }, { "description": "Whether to include opt outs.\n\n| VALUE | DESCRIPTION |\n|-------|-------------------------|\n| true | Only return opt outs |\n| false | Do not include opt outs |\n", "key": "optouts", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-sms-sent.json", "host": [ "{{baseUrl}}" ], "path": [ "get-sms-sent.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"message\": {\n \"message_id\": \"\",\n \"send_at\": \"\",\n \"recipients\": \"\",\n \"cost\": \"\",\n \"sms\": \"\",\n \"message_content\": \"\",\n \"list\": {},\n \"delivery_stats\": {\n \"delivered\": \"\",\n \"pending\": \"\",\n \"bounced\": \"\",\n \"responses\": \"\",\n \"optouts\": \"\"\n }\n },\n \"recipients\": {\n \"msisdn\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"delivery_status\": {\n \"delivered\": \"\",\n \"pending\": \"\",\n \"bounced\": \"\",\n \"responses\": \"\"\n },\n \"optout\": \"\"\n },\n \"error\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-6a291803-78ea-44a6-9541-4add8383225a" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-c2bb24ea-9bf7-4894-8c07-6ba7e717f573" } ], "id": "3ce92368-4ac9-4ede-a61b-70178412de71", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-3ce92368-4ac9-4ede-a61b-70178412de71" }, { "name": "get-message-report.json", "item": [ { "name": "Get Message Report", "id": "2b8f6d8a-ca99-483b-ba16-9f7f3ac4ea63", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "A date to start the report from. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. Eg. 2020-04-27 06:00:00. Start and end date must be within 30 days. If start and end date not supplied will get everything from last 24 hrs only.\n", "key": "start", "value": "" }, { "description": "A date to end the report at. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. Eg. 2020-04-27 06:00:00. Start and end date must be within 30 days. If start and end date not supplied will get everything from last 24 hrs only.\n", "key": "end", "value": "" }, { "description": "Recipient list. Provide list_id to look up custom data on this list for the contact and return it in the response.\n", "key": "list_id", "value": "" }, { "description": "Virtual mobile number assigned to your account.", "key": "number", "value": "" }, { "description": "Message type, available options:\n\n- all\n- api\n- campaign\n- quick_sms\n- email_sms\n- keyword\n- test_sms\n", "key": "type", "value": "" }, { "description": "Page number, for pagination.", "key": "page", "value": "" }, { "description": "Maximum results returned per page.", "key": "max", "value": "" }, { "description": "response_style = 'array' returns custom field lists as an array.\n", "key": "response_style", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-message-report.json", "host": [ "{{baseUrl}}" ], "path": [ "get-message-report.json" ] }, "description": "Retrieve information on messages sent during a period of time\nIt will also return all custom data fields associated to contacts in the list" }, "response": [ { "id": "d0b01e6f-f90e-4c80-9309-97c2dfabc5ae", "name": "Successful response containing information about the sent messages.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "A date to start the report from. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. Eg. 2020-04-27 06:00:00. Start and end date must be within 30 days. If start and end date not supplied will get everything from last 24 hrs only.\n", "key": "start", "value": "" }, { "description": "A date to end the report at. Must be in ISO8601 format YYYY-MM-DD HH:MM:SS utilizing UTC Timezone. Eg. 2020-04-27 06:00:00. Start and end date must be within 30 days. If start and end date not supplied will get everything from last 24 hrs only.\n", "key": "end", "value": "" }, { "description": "Recipient list. Provide list_id to look up custom data on this list for the contact and return it in the response.\n", "key": "list_id", "value": "" }, { "description": "Virtual mobile number assigned to your account.", "key": "number", "value": "" }, { "description": "Message type, available options:\n\n- all\n- api\n- campaign\n- quick_sms\n- email_sms\n- keyword\n- test_sms\n", "key": "type", "value": "" }, { "description": "Page number, for pagination.", "key": "page", "value": "" }, { "description": "Maximum results returned per page.", "key": "max", "value": "" }, { "description": "response_style = 'array' returns custom field lists as an array.\n", "key": "response_style", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-message-report.json", "host": [ "{{baseUrl}}" ], "path": [ "get-message-report.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"page\": {\n \"count\": \"\",\n \"number\": \"\"\n },\n \"messages_total\": \"\",\n \"sms_total\": \"\",\n \"messages\": [\n {\n \"type\": \"\",\n \"id\": \"\",\n \"sms\": \"\",\n \"cost\": \"\",\n \"sent_at\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"pending\": \"\",\n \"delivered\": \"\",\n \"soft_bounced\": \"\",\n \"hard_bounced\": \"\",\n \"optouts\": \"\",\n \"responses\": \"\",\n \"msisdn\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"fields\": {\n \"sed_b3\": \"\"\n }\n },\n {\n \"type\": \"\",\n \"id\": \"\",\n \"sms\": \"\",\n \"cost\": \"\",\n \"sent_at\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"pending\": \"\",\n \"delivered\": \"\",\n \"soft_bounced\": \"\",\n \"hard_bounced\": \"\",\n \"optouts\": \"\",\n \"responses\": \"\",\n \"msisdn\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"fields\": {\n \"nostrud8bc\": \"\",\n \"aliqua_c\": \"\"\n }\n }\n ],\n \"error\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-d0b01e6f-f90e-4c80-9309-97c2dfabc5ae" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-2b8f6d8a-ca99-483b-ba16-9f7f3ac4ea63" } ], "id": "1b02b559-dc41-4134-9020-449ef4f4712b", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-1b02b559-dc41-4134-9020-449ef4f4712b" }, { "name": "get-list.json", "item": [ { "name": "Get Information About A List", "id": "8107b597-e7d0-44ba-97cb-b7fa9b51d337", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID assigned to the list being queried. List ID's can be retrieved using get-lists.", "key": "list_id", "value": "" }, { "description": "Page number, for pagination.", "key": "page", "value": "" }, { "description": "Maximum results returned per page.", "key": "max", "value": "" }, { "description": "Only show contacts with specific status. Returns all contacts if not specified.\n\n| VALUE | DESCRIPTION |\n|---------|--------------------------------------------------------|\n| active | Only return active contacts |\n| inactive| Only return deleted contacts |\n| none | Do not get contacts, just list metadata |\n", "key": "members", "value": "" }, { "description": "'array' returns custom field lists as an array.", "key": "response_style", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-list.json", "host": [ "{{baseUrl}}" ], "path": [ "get-list.json" ] }, "description": "Get detailed information about a list, return custom fields and its contacts. \nThis will return paginated information regarding individual contacts on a list and their data." }, "response": [ { "id": "93c1eb3d-6384-4272-8ff3-c9748a1083f8", "name": "Successful response containing information about the list and its members.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID assigned to the list being queried. List ID's can be retrieved using get-lists.", "key": "list_id", "value": "" }, { "description": "Page number, for pagination.", "key": "page", "value": "" }, { "description": "Maximum results returned per page.", "key": "max", "value": "" }, { "description": "Only show contacts with specific status. Returns all contacts if not specified.\n\n| VALUE | DESCRIPTION |\n|---------|--------------------------------------------------------|\n| active | Only return active contacts |\n| inactive| Only return deleted contacts |\n| none | Do not get contacts, just list metadata |\n", "key": "members", "value": "" }, { "description": "'array' returns custom field lists as an array.", "key": "response_style", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-list.json", "host": [ "{{baseUrl}}" ], "path": [ "get-list.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"members_total\": \"\",\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"members_active\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"members\": [\n {\n \"list_id\": \"\",\n \"msisdn\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"created_at\": \"\",\n \"status\": \"active\",\n \"fields\": {\n \"Ut_e\": \"\",\n \"ex452\": \"\"\n }\n },\n {\n \"list_id\": \"\",\n \"msisdn\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"created_at\": \"\",\n \"status\": \"active\",\n \"fields\": {\n \"incididuntf7\": \"\",\n \"cupidatat_9\": \"\"\n }\n }\n ]\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-93c1eb3d-6384-4272-8ff3-c9748a1083f8" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-8107b597-e7d0-44ba-97cb-b7fa9b51d337" } ], "id": "f571bb2e-7b38-41c3-8156-15d63646b1f2", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-f571bb2e-7b38-41c3-8156-15d63646b1f2" }, { "name": "get-lists.json", "item": [ { "name": "Get Information About All Lists", "id": "44ba240c-fd9e-4cd3-b43a-31fe0477276c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/get-lists.json?page=&max=&response_style=array", "host": [ "{{baseUrl}}" ], "path": [ "get-lists.json" ], "query": [ { "description": "Page number for pagination.", "key": "page", "value": "" }, { "description": "Maximum results returned per page.", "key": "max", "value": "" }, { "description": "Response style. Set to 'array' to return custom field lists as an array.\n", "key": "response_style", "value": "array" } ] }, "description": "Get information about all lists in your account\nThis will return metadata on all your lists\n\n## Pagination\n\nThis endpoint supports pagination using the page/max pattern:\n\n**Parameters:**\n- `page`: Page number starting from 1 (default: 1)\n- `max`: Maximum results per page (default: varies, recommended: 10-50)\n\n**Response Structure:**\nThe response includes pagination metadata:\n- `page.count`: Total number of pages available\n- `page.number`: Current page number\n- `lists_total`: Total count of lists in your account\n\n**Navigation Examples:**\n```\n# First page of lists (default)\nGET /get-lists.json\n\n# Second page with 20 results per page\nGET /get-lists.json?page=2&max=20\n\n# Get all lists with larger page size\nGET /get-lists.json?max=50\n\n# Navigate through all pages\nGET /get-lists.json?page=1&max=25\nGET /get-lists.json?page=2&max=25\n# Continue until page.number >= page.count\n```\n\n**Best Practices:**\n- Use max=10-25 for UI display purposes\n- Use max=50 for administrative tasks or bulk operations\n- Check page.count to determine if more pages exist\n- For accounts with many lists, use appropriate page sizes to balance performance and usability\n- Consider filtering or searching if you need specific lists rather than paginating through all" }, "response": [ { "id": "13da43fc-7c03-478f-995d-2ef177cffea1", "name": "Successful response containing information about the lists in your account.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/get-lists.json?page=&max=&response_style=array", "host": [ "{{baseUrl}}" ], "path": [ "get-lists.json" ], "query": [ { "description": "Page number for pagination.", "key": "page", "value": "" }, { "description": "Maximum results returned per page.", "key": "max", "value": "" }, { "description": "Response style. Set to 'array' to return custom field lists as an array.\n", "key": "response_style", "value": "array" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"lists_total\": \"\",\n \"lists\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"members_active\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"members_total\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"members_active\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"members_total\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-13da43fc-7c03-478f-995d-2ef177cffea1" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-44ba240c-fd9e-4cd3-b43a-31fe0477276c" } ], "id": "3be59229-69f2-4721-8ab5-8287d69c7416", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-3be59229-69f2-4721-8ab5-8287d69c7416" }, { "name": "get-contact.json", "item": [ { "name": "Get Contact Information", "id": "706b0be0-887b-4820-9492-cfe23af395bf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID of the list contact is on.", "key": "list_id", "value": "" }, { "description": "(Required) Mobile number of contact being queried.", "key": "msisdn", "value": "" }, { "description": "Indicates the response style. Use 'array' to return custom field lists as an array.\n", "key": "response_style", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-contact.json", "host": [ "{{baseUrl}}" ], "path": [ "get-contact.json" ] }, "description": "Get information about a contact on a list" }, "response": [ { "id": "280107a7-a792-4926-8132-33c046e61097", "name": "Successful response containing information about the contact.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID of the list contact is on.", "key": "list_id", "value": "" }, { "description": "(Required) Mobile number of contact being queried.", "key": "msisdn", "value": "" }, { "description": "Indicates the response style. Use 'array' to return custom field lists as an array.\n", "key": "response_style", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-contact.json", "host": [ "{{baseUrl}}" ], "path": [ "get-contact.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"list_id\": \"\",\n \"msisdn\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"created_at\": \"\",\n \"status\": \"inactive\",\n \"fields\": {\n \"culpae\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-280107a7-a792-4926-8132-33c046e61097" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-706b0be0-887b-4820-9492-cfe23af395bf" } ], "id": "18192472-f34b-45f9-bcc5-28cfc977d797", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-18192472-f34b-45f9-bcc5-28cfc977d797" }, { "name": "add-list.json", "item": [ { "name": "Add List", "id": "f7bd6262-9d78-4ec6-8ef0-200648f924e1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) A unique name for the list.", "key": "name", "value": "" }, { "description": "Custom field name. Firstname and lastname are created by default. There can be up to 10 extra custom fields. 'n' is an integer between 1 and 10.", "key": "field_n", "value": "" }, { "description": "Indicates the response style. response_style = 'array' returns custom field lists as an array.", "key": "response_style", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/add-list.json", "host": [ "{{baseUrl}}" ], "path": [ "add-list.json" ] }, "description": "Create New Contact List" }, "response": [ { "id": "98fd0fdc-ef89-4419-96c6-ce843a5a69de", "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) A unique name for the list.", "key": "name", "value": "" }, { "description": "Custom field name. Firstname and lastname are created by default. There can be up to 10 extra custom fields. 'n' is an integer between 1 and 10.", "key": "field_n", "value": "" }, { "description": "Indicates the response style. response_style = 'array' returns custom field lists as an array.", "key": "response_style", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/add-list.json", "host": [ "{{baseUrl}}" ], "path": [ "add-list.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"created\": \"\",\n \"members_active\": \"\",\n \"fields\": [\n \"\",\n \"\"\n ],\n \"errors\": [\n {\n \"CODE\": \"\",\n \"HEADER\": \"\",\n \"DESCRIPTION\": \"\"\n },\n {\n \"CODE\": \"\",\n \"HEADER\": \"\",\n \"DESCRIPTION\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-98fd0fdc-ef89-4419-96c6-ce843a5a69de" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-f7bd6262-9d78-4ec6-8ef0-200648f924e1" } ], "id": "c4b66631-8e2d-4200-84ea-eab94f75c05a", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-c4b66631-8e2d-4200-84ea-eab94f75c05a" }, { "name": "add-field-to-list.json", "item": [ { "name": "Add Field to List", "id": "1d0bf564-1525-4b6c-ba57-21d8b4c11409", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) ID of the list to add to.", "key": "list_id", "value": "" }, { "description": "(Required) Custom field names. Firstname and lastname are created by default. There can be up to 10 extra custom fields. 'n' is an integer between 1 and 10.", "key": "field_n", "value": "" }, { "description": "Indicates the response style. If set to response_style='array', custom field lists are returned as an array.", "key": "response_style", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/add-field-to-list.json", "host": [ "{{baseUrl}}" ], "path": [ "add-field-to-list.json" ] }, "description": "Add or update custom fields on an existing list" }, "response": [ { "id": "8dbad0a4-e74c-4c7a-95b4-7c59be1e67e9", "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) ID of the list to add to.", "key": "list_id", "value": "" }, { "description": "(Required) Custom field names. Firstname and lastname are created by default. There can be up to 10 extra custom fields. 'n' is an integer between 1 and 10.", "key": "field_n", "value": "" }, { "description": "Indicates the response style. If set to response_style='array', custom field lists are returned as an array.", "key": "response_style", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/add-field-to-list.json", "host": [ "{{baseUrl}}" ], "path": [ "add-field-to-list.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"custom_n\": [\n \"\",\n \"\"\n ],\n \"id\": \"\",\n \"error\": {\n \"code\": \"\",\n \"header\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-8dbad0a4-e74c-4c7a-95b4-7c59be1e67e9" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-1d0bf564-1525-4b6c-ba57-21d8b4c11409" } ], "id": "d19d2738-494a-4b1f-91df-ad8a35e6db50", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-d19d2738-494a-4b1f-91df-ad8a35e6db50" }, { "name": "remove-list.json", "item": [ { "name": "Remove List", "id": "2847c3b4-5ab5-4308-90ff-c2cb6d0451f2", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID of the list to be removed. List IDs can be retrieved with the get-lists request.", "key": "list_id", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/remove-list.json", "host": [ "{{baseUrl}}" ], "path": [ "remove-list.json" ] }, "description": "Delete a list and its contacts" }, "response": [ { "id": "681be0ca-ce3e-4b4c-ad4b-9ac306c94e5a", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID of the list to be removed. List IDs can be retrieved with the get-lists request.", "key": "list_id", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/remove-list.json", "host": [ "{{baseUrl}}" ], "path": [ "remove-list.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-681be0ca-ce3e-4b4c-ad4b-9ac306c94e5a" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-2847c3b4-5ab5-4308-90ff-c2cb6d0451f2" } ], "id": "a94b2946-b0e5-4cf8-b7fd-c574365c917b", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-a94b2946-b0e5-4cf8-b7fd-c574365c917b" }, { "name": "add-to-list.json", "item": [ { "name": "Add Contact to List", "id": "151de8e4-7897-4723-8d20-b93f8be16ec4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID of the list to be added to. List IDs can be retrieved with the get-lists request.", "key": "list_id", "value": "" }, { "description": "(Required) Mobile number being added to the list. Invalid numbers will be ignored. Number must be defined in E.164 international format. You can use the countrycode parameter to format numbers that are in local format.", "key": "msisdn", "value": "" }, { "description": "2 letter ISO 3166 format country code or country name. Automatically formats numbers to international format required for reliable SMS delivery. eg. In Australia 0422222222 will become 6142222222 when set to AU or Australia. If not set to numbers must be defined in E.164 international format.\n\n| COUNTRY | COUNTRY CODE | LOCAL | INTERNATIONAL |\n|---------------|--------------|-------------|----------------|\n| Australia | au | 0491570156 | 61491570156 |\n| New Zealand | nz | 0212670129 | 64212670129 |\n| United Kingdom| gb | 0750017696 | 44750017696 |\n| United States | us | 2513551145 | 12513551145 |\n", "key": "countrycode", "value": "" }, { "description": "First name of the contact being added.", "key": "first_name", "value": "" }, { "description": "Last name of the contact being added.", "key": "last_name", "value": "" }, { "description": "Custom field name. Firstname and lastname are created by default. There can be up to 10 extra custom fields. n is an integer between 1 and 10.\n", "key": "field_n", "value": "" }, { "description": "Determines the response style. 'array' returns custom field lists as an array.\n", "key": "response_style", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/add-to-list.json", "host": [ "{{baseUrl}}" ], "path": [ "add-to-list.json" ] }, "description": "Adds a new contact to a list\nIf a contact is added that already exists it will be ignored, not updated." }, "response": [ { "id": "d5770f08-4cc8-47de-9819-f9ff11c74008", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID of the list to be added to. List IDs can be retrieved with the get-lists request.", "key": "list_id", "value": "" }, { "description": "(Required) Mobile number being added to the list. Invalid numbers will be ignored. Number must be defined in E.164 international format. You can use the countrycode parameter to format numbers that are in local format.", "key": "msisdn", "value": "" }, { "description": "2 letter ISO 3166 format country code or country name. Automatically formats numbers to international format required for reliable SMS delivery. eg. In Australia 0422222222 will become 6142222222 when set to AU or Australia. If not set to numbers must be defined in E.164 international format.\n\n| COUNTRY | COUNTRY CODE | LOCAL | INTERNATIONAL |\n|---------------|--------------|-------------|----------------|\n| Australia | au | 0491570156 | 61491570156 |\n| New Zealand | nz | 0212670129 | 64212670129 |\n| United Kingdom| gb | 0750017696 | 44750017696 |\n| United States | us | 2513551145 | 12513551145 |\n", "key": "countrycode", "value": "" }, { "description": "First name of the contact being added.", "key": "first_name", "value": "" }, { "description": "Last name of the contact being added.", "key": "last_name", "value": "" }, { "description": "Custom field name. Firstname and lastname are created by default. There can be up to 10 extra custom fields. n is an integer between 1 and 10.\n", "key": "field_n", "value": "" }, { "description": "Determines the response style. 'array' returns custom field lists as an array.\n", "key": "response_style", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/add-to-list.json", "host": [ "{{baseUrl}}" ], "path": [ "add-to-list.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"list_id\": \"\",\n \"msisdn\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"created_at\": \"\",\n \"status\": \"\",\n \"fields\": {},\n \"errors\": {\n \"BAD_MOBILE\": \"\",\n \"BAD_MOBILE_COUNTRY\": \"\",\n \"OPTOUT\": \"\",\n \"DUPLICATE_DELETED\": \"\",\n \"KEY_EXISTS\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-d5770f08-4cc8-47de-9819-f9ff11c74008" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-151de8e4-7897-4723-8d20-b93f8be16ec4" } ], "id": "0a4f1130-8041-48fe-8097-cbad2518e30c", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-0a4f1130-8041-48fe-8097-cbad2518e30c" }, { "name": "edit-list-member.json", "item": [ { "name": "Update Contact", "id": "c4b19dd7-e421-4790-be44-f09aacb57d5a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID of the list to be added to. This ID is the numerical reference to one of your recipient lists. It can be found in the URL and displayed on a destination list page in your account. A list ID can also be created using the add-list call.", "key": "list_id", "value": "" }, { "description": "(Required) Mobile number of contact being updated. Invalid numbers will be ignored. Number must be defined in E.164 international format.", "key": "msisdn", "value": "" }, { "description": "First name of contact being added.", "key": "first_name", "value": "" }, { "description": "Last name of contact being added.", "key": "last_name", "value": "" }, { "description": "Custom field name. Firstname and lastname are created by default. There can be up to 10 extra custom fields. n is an integer between 1 and 10.", "key": "field_n", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/edit-list-member.json", "host": [ "{{baseUrl}}" ], "path": [ "edit-list-member.json" ] }, "description": "Edit a contact that exists on a list\nUsed for adding new or updated custom data to a contact on a list." }, "response": [ { "id": "0e184831-c229-4616-894f-47894d4de23f", "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Numeric ID of the list to be added to. This ID is the numerical reference to one of your recipient lists. It can be found in the URL and displayed on a destination list page in your account. A list ID can also be created using the add-list call.", "key": "list_id", "value": "" }, { "description": "(Required) Mobile number of contact being updated. Invalid numbers will be ignored. Number must be defined in E.164 international format.", "key": "msisdn", "value": "" }, { "description": "First name of contact being added.", "key": "first_name", "value": "" }, { "description": "Last name of contact being added.", "key": "last_name", "value": "" }, { "description": "Custom field name. Firstname and lastname are created by default. There can be up to 10 extra custom fields. n is an integer between 1 and 10.", "key": "field_n", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/edit-list-member.json", "host": [ "{{baseUrl}}" ], "path": [ "edit-list-member.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"list_id\": \"\",\n \"msisdn\": \"\",\n \"firstname\": \"\",\n \"lastname\": \"\",\n \"created_at\": \"\",\n \"status\": \"\",\n \"fields\": {},\n \"errors\": {\n \"BAD_MOBILE\": \"\",\n \"BAD_MOBILE_COUNTRY\": \"\",\n \"OPTOUT\": \"\",\n \"DUPLICATE_DELETED\": \"\",\n \"KEY_EXISTS\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-0e184831-c229-4616-894f-47894d4de23f" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-c4b19dd7-e421-4790-be44-f09aacb57d5a" } ], "id": "920fee13-6fe2-42a4-a9ea-b1504bd1279d", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-920fee13-6fe2-42a4-a9ea-b1504bd1279d" }, { "name": "delete-from-list.json", "item": [ { "name": "Remove Contact", "id": "14035e2e-ebb4-4128-9927-f03bee976733", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Mobile number of contact being removed. Number must be defined in E.164 international format. You can use countrycode parameter to format numbers that are in local format.", "key": "msisdn", "value": "" }, { "description": "Numeric ID of list to remove contact from. If set to 0 (zero), the contact will be removed from all lists.", "key": "list_id", "value": "" }, { "description": "Format the to number in international format. 2 letter ISO 3166 format country code or country name. Automatically formats numbers to international format required for reliable SMS delivery. If not set, numbers must be defined in E.164 international format.\n\n| COUNTRY | COUNTRY CODE | LOCAL | INTERNATIONAL |\n| -------------- | ------------ | ---------- | -------------- |\n| Australia | au | 0491570156 | 61491570156 |\n| New Zealand | nz | 0212670129 | 64212670129 |\n| United Kingdom | gb | 0750017696 | 44750017696 |\n| United States | us | 2513551145 | 12513551145 |\n", "key": "countrycode", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/delete-from-list.json", "host": [ "{{baseUrl}}" ], "path": [ "delete-from-list.json" ] }, "description": "Delete contact from one or all lists" }, "response": [ { "id": "09fba8ff-9b32-43c1-a658-071f856b9f7a", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Mobile number of contact being removed. Number must be defined in E.164 international format. You can use countrycode parameter to format numbers that are in local format.", "key": "msisdn", "value": "" }, { "description": "Numeric ID of list to remove contact from. If set to 0 (zero), the contact will be removed from all lists.", "key": "list_id", "value": "" }, { "description": "Format the to number in international format. 2 letter ISO 3166 format country code or country name. Automatically formats numbers to international format required for reliable SMS delivery. If not set, numbers must be defined in E.164 international format.\n\n| COUNTRY | COUNTRY CODE | LOCAL | INTERNATIONAL |\n| -------------- | ------------ | ---------- | -------------- |\n| Australia | au | 0491570156 | 61491570156 |\n| New Zealand | nz | 0212670129 | 64212670129 |\n| United Kingdom | gb | 0750017696 | 44750017696 |\n| United States | us | 2513551145 | 12513551145 |\n", "key": "countrycode", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/delete-from-list.json", "host": [ "{{baseUrl}}" ], "path": [ "delete-from-list.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"list_ids\": [\n \"\",\n \"\"\n ],\n \"error\": {\n \"NOT_FOUND\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-09fba8ff-9b32-43c1-a658-071f856b9f7a" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-14035e2e-ebb4-4128-9927-f03bee976733" } ], "id": "a420b863-d5ae-4996-af1e-fe7f14350082", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-a420b863-d5ae-4996-af1e-fe7f14350082" }, { "name": "optout-list-member.json", "item": [ { "name": "Opt Out/Unsubscribe Contact", "id": "d7ce7b5b-db87-4b91-9d0f-3cec64f95db1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Mobile number of contact being opted out. Number must be defined in E.164 international format.", "key": "msisdn", "value": "" }, { "description": "Numeric ID of list to opt out contact from. If set to 0 (zero), the contact will be opted out from all lists. If your Global Opt Out (GOO) list is switched on, unsubscribing from a single list will unsubscribe from all lists and add to your GOO list.\n[How to manage your Global Opt Out list (GOO)](https://support.transmitsms.com/support/solutions/articles/44001940660-how-to-manage-your-global-opt-out-list-goo-)\n", "key": "list_id", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/optout-list-member.json", "host": [ "{{baseUrl}}" ], "path": [ "optout-list-member.json" ] }, "description": "Opt Out List Member\n\nUnsubscribe contact from one or all lists \nIf sending marketing by law you must enable an unsubscribe method. [Anti-Spam Policy](https://help.kudosity.com/s/article/44001077041-anti-spam-policy)" }, "response": [ { "id": "513cfcf2-14bf-4a1b-aa8d-f41242b667a8", "name": "Successful response.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Mobile number of contact being opted out. Number must be defined in E.164 international format.", "key": "msisdn", "value": "" }, { "description": "Numeric ID of list to opt out contact from. If set to 0 (zero), the contact will be opted out from all lists. If your Global Opt Out (GOO) list is switched on, unsubscribing from a single list will unsubscribe from all lists and add to your GOO list.\n[How to manage your Global Opt Out list (GOO)](https://support.transmitsms.com/support/solutions/articles/44001940660-how-to-manage-your-global-opt-out-list-goo-)\n", "key": "list_id", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/optout-list-member.json", "host": [ "{{baseUrl}}" ], "path": [ "optout-list-member.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"list_ids\": [\n \"\",\n \"\"\n ],\n \"error\": {\n \"CODE\": \"\",\n \"HEADER\": \"\",\n \"DESCRIPTION\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-513cfcf2-14bf-4a1b-aa8d-f41242b667a8" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-d7ce7b5b-db87-4b91-9d0f-3cec64f95db1" } ], "id": "0d2ef689-9457-431b-adfe-60948bb87735", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-0d2ef689-9457-431b-adfe-60948bb87735" }, { "name": "add-contacts-bulk-progress.json", "item": [ { "name": "Check Progress Of Import", "id": "18b6959d-1c41-409b-bf02-7258badd696d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) ID of the list to be checked. This ID is the numerical reference to the list you uploaded the file to.", "key": "list_id", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/add-contacts-bulk-progress.json", "host": [ "{{baseUrl}}" ], "path": [ "add-contacts-bulk-progress.json" ] }, "description": "For large lists in excess of 50,000 contacts, it can take some time to process. This request will let you see the progress of the import." }, "response": [ { "id": "21dc0392-4823-41a9-9446-c4ade8b4dba7", "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) ID of the list to be checked. This ID is the numerical reference to the list you uploaded the file to.", "key": "list_id", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/add-contacts-bulk-progress.json", "host": [ "{{baseUrl}}" ], "path": [ "add-contacts-bulk-progress.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"list_id\": \"\",\n \"status\": \"failed\",\n \"importlength\": \"\",\n \"completed\": \"\",\n \"duplicates\": \"\",\n \"skipped\": \"\",\n \"optout\": \"\",\n \"imported\": \"\"\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-21dc0392-4823-41a9-9446-c4ade8b4dba7" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-18b6959d-1c41-409b-bf02-7258badd696d" } ], "id": "d555e6bb-9e4f-4695-b61a-fb803113ec09", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-d555e6bb-9e4f-4695-b61a-fb803113ec09" }, { "name": "lease-number.json", "item": [ { "name": "Add Dedicated Virtual Number", "id": "d1fa9cbe-2218-423f-b813-6164ec04bb0a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "Number to lease. Omit this field to be given a random number. Use \"get-numbers\" to find out which numbers are currently available.", "key": "number", "value": "" }, { "description": "Assign a callback URL to the number. A URL on your system which we can call to notify you of incoming messages. If required, this parameter can be different for each message sent. Will override the default Reply Callback URL if set in the SETTINGS section of your account.", "key": "forward_url", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/lease-number.json", "host": [ "{{baseUrl}}" ], "path": [ "lease-number.json" ] }, "description": "Lease Number\n\nDedicated virtual numbers are used to receive MO (Mobile Originated) messages. They also make sure that all of your messages are sent from a number that is always the same. Dedicated Virtual Number availability is limited to certain countries. Check [Global Sender ID Information](https://portal.transmitsms.com/s/article/Global-Sender-ID-Information) for availability for your destination coutry." }, "response": [ { "id": "569851d2-919f-4151-8ae5-6020ecd79469", "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "Number to lease. Omit this field to be given a random number. Use \"get-numbers\" to find out which numbers are currently available.", "key": "number", "value": "" }, { "description": "Assign a callback URL to the number. A URL on your system which we can call to notify you of incoming messages. If required, this parameter can be different for each message sent. Will override the default Reply Callback URL if set in the SETTINGS section of your account.", "key": "forward_url", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/lease-number.json", "host": [ "{{baseUrl}}" ], "path": [ "lease-number.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"number\": \"\",\n \"price\": \"\",\n \"next_charge\": \"\",\n \"auto_renew\": \"\"\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-569851d2-919f-4151-8ae5-6020ecd79469" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-d1fa9cbe-2218-423f-b813-6164ec04bb0a" } ], "id": "478bb7c2-4163-4b4d-b1ed-f3fd19c4a707", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-478bb7c2-4163-4b4d-b1ed-f3fd19c4a707" }, { "name": "get-numbers.json", "item": [ { "name": "Get Numbers", "id": "a389e3e0-2938-48ab-b6b6-8cb090aef0be", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/get-numbers.json?filter=owned&page=&max=", "host": [ "{{baseUrl}}" ], "path": [ "get-numbers.json" ], "query": [ { "description": "Choose owned or available. Default is owned.", "key": "filter", "value": "owned" }, { "description": "Page number for pagination.", "key": "page", "value": "" }, { "description": "Maximum results returned per page.", "key": "max", "value": "" } ] }, "description": "Edit inbound options for a dedicated virtual number.\n\n**Get a list of numbers leased by you or available to be leased.**\n\nDedicated virtual numbers are used to receive MO (Mobile Originated) messages. They also make sure that all of your messages are sent from a number that is always the same. Dedicated Virtual Number availability is limited to certain countries. Check [Global SMS delivery list](https://support.transmitsms.com/support/solutions/articles/44001940675-global-sms-delivery-list) for availability for your destination country.\n\n## Pagination\n\nThis endpoint supports pagination using the page/max pattern:\n\n**Parameters:**\n- `page`: Page number starting from 1 (default: 1)\n- `max`: Maximum results per page (default: varies, recommended: 10-100)\n- `filter`: Choose 'owned' or 'available' (default: owned)\n\n**Response Structure:**\nThe response includes pagination metadata:\n- `page.count`: Total number of pages available\n- `page.number`: Current page number\n- `numbers_total`: Total count of numbers matching the filter\n\n**Navigation Examples:**\n```\n# First page of owned numbers (default)\nGET /get-numbers.json\n\n# Second page with 20 results per page\nGET /get-numbers.json?page=2&max=20\n\n# Available numbers for leasing\nGET /get-numbers.json?filter=available&max=50\n\n# Navigate through all pages\nGET /get-numbers.json?page=1&max=100\nGET /get-numbers.json?page=2&max=100\n# Continue until page.number >= page.count\n```\n\n**Best Practices:**\n- Use max=10-20 for UI display purposes\n- Use max=50-100 for administrative tasks\n- Check page.count to determine if more pages exist\n- Filter by 'owned' vs 'available' to reduce dataset size\n- For large accounts, consider filtering by country or status" }, "response": [ { "id": "59073a13-3b3f-4534-8546-af85e2c1b683", "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/get-numbers.json?filter=owned&page=&max=", "host": [ "{{baseUrl}}" ], "path": [ "get-numbers.json" ], "query": [ { "description": "Choose owned or available. Default is owned.", "key": "filter", "value": "owned" }, { "description": "Page number for pagination.", "key": "page", "value": "" }, { "description": "Maximum results returned per page.", "key": "max", "value": "" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"page\": {\n \"count\": \"\",\n \"number\": \"\"\n },\n \"numbers_total\": \"\",\n \"numbers\": [\n {\n \"number\": \"\",\n \"price\": \"\",\n \"next_charge\": \"\",\n \"auto_renew\": \"\"\n },\n {\n \"number\": \"\",\n \"price\": \"\",\n \"next_charge\": \"\",\n \"auto_renew\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-59073a13-3b3f-4534-8546-af85e2c1b683" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-a389e3e0-2938-48ab-b6b6-8cb090aef0be" } ], "id": "5328259e-a6f1-4092-aee9-192ae599f994", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-5328259e-a6f1-4092-aee9-192ae599f994" }, { "name": "get-number.json", "item": [ { "name": "Get Number Information", "id": "c72b17e3-bd59-401c-9887-f8ac06506e1f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Number to retrieve Omit this field to be given a random number. Use get-numbers to find out which numbers are currently available.", "key": "number", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-number.json", "host": [ "{{baseUrl}}" ], "path": [ "get-number.json" ] }, "description": "Get detailed information about a number you have leased.\n" }, "response": [ { "id": "9356b301-6af1-4c9c-aebe-1fd9ac512a7c", "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Number to retrieve Omit this field to be given a random number. Use get-numbers to find out which numbers are currently available.", "key": "number", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-number.json", "host": [ "{{baseUrl}}" ], "path": [ "get-number.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"number\": \"\",\n \"price\": \"\",\n \"next_charge\": \"\",\n \"auto_renew\": \"\",\n \"status\": \"\",\n \"error\": {\n \"code\": \"\",\n \"header\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-9356b301-6af1-4c9c-aebe-1fd9ac512a7c" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-c72b17e3-bd59-401c-9887-f8ac06506e1f" } ], "id": "f4afa3da-581e-4a9b-887c-8223ca8d254c", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-f4afa3da-581e-4a9b-887c-8223ca8d254c" }, { "name": "edit-number-options.json", "item": [ { "name": "Edit Number Options", "id": "de79e6bb-360a-410d-8418-0338b7809dbb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Dedicated virtual number assigned to your account. A list of numbers on your account can be retrieved using get-numbers.", "key": "number", "value": "" }, { "description": "Forward incoming SMS to a set of email addresses. Emails can be comma separated.", "key": "forward_email", "value": "" }, { "description": "Forward incoming SMS to a set of mobile numbers. Numbers must be in international format. Can be comma separated.", "key": "forward_sms", "value": "" }, { "description": "Forward incoming messages to a callback URL.", "key": "forward_url", "value": "" }, { "description": "Add senders of incoming messages to this list.", "key": "list_id", "value": "" }, { "description": "Auto responder for all messages received.", "key": "welcome_message", "value": "" }, { "description": "Auto-response if the number is already on the list. Must be adding the number to a list.", "key": "members_message", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/edit-number-options.json", "host": [ "{{baseUrl}}" ], "path": [ "edit-number-options.json" ] }, "description": "Edit inbound options for a dedicated virtual number.\n\nThese options adjust behaviour for messages that are sent to this number." }, "response": [ { "id": "2df3854b-9ab1-451e-94de-58fe28401b1e", "name": "OK", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Dedicated virtual number assigned to your account. A list of numbers on your account can be retrieved using get-numbers.", "key": "number", "value": "" }, { "description": "Forward incoming SMS to a set of email addresses. Emails can be comma separated.", "key": "forward_email", "value": "" }, { "description": "Forward incoming SMS to a set of mobile numbers. Numbers must be in international format. Can be comma separated.", "key": "forward_sms", "value": "" }, { "description": "Forward incoming messages to a callback URL.", "key": "forward_url", "value": "" }, { "description": "Add senders of incoming messages to this list.", "key": "list_id", "value": "" }, { "description": "Auto responder for all messages received.", "key": "welcome_message", "value": "" }, { "description": "Auto-response if the number is already on the list. Must be adding the number to a list.", "key": "members_message", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/edit-number-options.json", "host": [ "{{baseUrl}}" ], "path": [ "edit-number-options.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"error\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-2df3854b-9ab1-451e-94de-58fe28401b1e" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-de79e6bb-360a-410d-8418-0338b7809dbb" } ], "id": "81e4749e-8ba5-4269-baca-739ea6dbf877", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-81e4749e-8ba5-4269-baca-739ea6dbf877" }, { "name": "add-email.json", "item": [ { "name": "Add Email", "id": "9631e759-4557-4998-9680-923b65f207d6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Email address to register. You may also register a wild-card email which allows any user on the same domain to use Email to SMS. Wild-card format: *@example.com\n", "key": "email", "value": "" }, { "description": "The maximum number of SMS messages to send from one email message sent from this email address.\nPossible values:\n\n- 1 - up to 160 characters (default)\n- 2 - up to 306 characters\n- 3 - up to 459 characters\n- 4 - up to 612 characters\n", "key": "max_sms", "value": "1" }, { "description": "Optional dedicated virtual number", "key": "number", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/add-email.json", "host": [ "{{baseUrl}}" ], "path": [ "add-email.json" ] }, "description": "Authorise Email Address" }, "response": [ { "id": "685ab5b8-58bf-4cc1-abb2-95ed76341ab7", "name": "Success response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Email address to register. You may also register a wild-card email which allows any user on the same domain to use Email to SMS. Wild-card format: *@example.com\n", "key": "email", "value": "" }, { "description": "The maximum number of SMS messages to send from one email message sent from this email address.\nPossible values:\n\n- 1 - up to 160 characters (default)\n- 2 - up to 306 characters\n- 3 - up to 459 characters\n- 4 - up to 612 characters\n", "key": "max_sms", "value": "1" }, { "description": "Optional dedicated virtual number", "key": "number", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/add-email.json", "host": [ "{{baseUrl}}" ], "path": [ "add-email.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"error\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-685ab5b8-58bf-4cc1-abb2-95ed76341ab7" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-9631e759-4557-4998-9680-923b65f207d6" } ], "id": "efcfe095-c458-471d-a35f-8573e895a1d7", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-efcfe095-c458-471d-a35f-8573e895a1d7" }, { "name": "delete-email.json", "item": [ { "name": "Delete Email", "id": "059eb032-964d-4de2-bda6-2dc581e8a9d5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Email address to remove. Use a wild-card email to remove all emails on that domain.", "key": "email", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/delete-email.json", "host": [ "{{baseUrl}}" ], "path": [ "delete-email.json" ] }, "description": "Remove an email address from the Email to SMS authorised list." }, "response": [ { "id": "4ace3c35-4991-4840-acd7-4fdec85f2618", "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) Email address to remove. Use a wild-card email to remove all emails on that domain.", "key": "email", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/delete-email.json", "host": [ "{{baseUrl}}" ], "path": [ "delete-email.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"success\": \"\",\n \"error\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-4ace3c35-4991-4840-acd7-4fdec85f2618" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-059eb032-964d-4de2-bda6-2dc581e8a9d5" } ], "id": "b726c661-e2a2-4c96-9178-8306597abebb", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-b726c661-e2a2-4c96-9178-8306597abebb" }, { "name": "add-keyword.json", "item": [ { "name": "Add Keyword", "id": "ae5a65f7-6a44-4cc6-8947-515fa6a9663f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The first word of a text message", "key": "keyword", "value": "" }, { "description": "(Required) The dedicated virtual number that the keyword belongs to", "key": "number", "value": "" }, { "description": "Your own reference (up to 100 characters)", "key": "reference", "value": "" }, { "description": "ID of a list to add respondents to, list ID's can be found in the title of a list or in the list page URL", "key": "list_id", "value": "" }, { "description": "SMS message to send to new members", "key": "welcome_message", "value": "" }, { "description": "SMS message to existing members", "key": "members_message", "value": "" }, { "description": "Whether to make the keyword active immediately.", "key": "activate", "value": "true" }, { "description": "Forward messages to a URL", "key": "forward_url", "value": "" }, { "description": "Forward messages to a set of email addresses", "key": "forward_email", "value": "" }, { "description": "Forward messages to a set of MSISDNs", "key": "forward_sms", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/add-keyword.json", "host": [ "{{baseUrl}}" ], "path": [ "add-keyword.json" ] }, "description": "Add New Keyword" }, "response": [ { "id": "48812f46-d454-488d-ac09-48e2fe15673e", "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The first word of a text message", "key": "keyword", "value": "" }, { "description": "(Required) The dedicated virtual number that the keyword belongs to", "key": "number", "value": "" }, { "description": "Your own reference (up to 100 characters)", "key": "reference", "value": "" }, { "description": "ID of a list to add respondents to, list ID's can be found in the title of a list or in the list page URL", "key": "list_id", "value": "" }, { "description": "SMS message to send to new members", "key": "welcome_message", "value": "" }, { "description": "SMS message to existing members", "key": "members_message", "value": "" }, { "description": "Whether to make the keyword active immediately.", "key": "activate", "value": "true" }, { "description": "Forward messages to a URL", "key": "forward_url", "value": "" }, { "description": "Forward messages to a set of email addresses", "key": "forward_email", "value": "" }, { "description": "Forward messages to a set of MSISDNs", "key": "forward_sms", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/add-keyword.json", "host": [ "{{baseUrl}}" ], "path": [ "add-keyword.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"keyword\": \"\",\n \"reference\": \"\",\n \"number\": \"\",\n \"list_id\": \"\",\n \"welcome_message\": \"\",\n \"member_message\": \"\",\n \"forward_url\": \"\",\n \"forward_sms\": \"\",\n \"forward_email\": \"\",\n \"status\": \"\",\n \"billing_date\": \"\",\n \"error\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-48812f46-d454-488d-ac09-48e2fe15673e" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-ae5a65f7-6a44-4cc6-8947-515fa6a9663f" } ], "id": "83874102-8a0c-4559-ae98-58c8f837d5ca", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-83874102-8a0c-4559-ae98-58c8f837d5ca" }, { "name": "edit-keyword.json", "item": [ { "name": "Edit Keyword", "id": "cc4fd0a2-70e0-4a23-b9a5-07a2e81e796c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The first word of a text message.", "key": "keyword", "value": "" }, { "description": "(Required) The dedicated virtual number that the keyword belongs to.", "key": "number", "value": "" }, { "description": "Your own reference (up to 100 characters).", "key": "reference", "value": "" }, { "description": "Open, will set the Keyword to being active. Closed, will close the Keyword.\n", "key": "status", "value": "Open" }, { "description": "ID of a list to add respondents to. List ID's can be found in the title of a list or in the list page URL.", "key": "list_id", "value": "" }, { "description": "SMS message to send to new members.", "key": "welcome_message", "value": "" }, { "description": "SMS message to existing members.", "key": "members_message", "value": "" }, { "description": "Whether to make the keyword active immediately.", "key": "activate", "value": "true" }, { "description": "Forward messages to a URL.", "key": "forward_url", "value": "" }, { "description": "Forward messages to a set of email addresses.", "key": "forward_email", "value": "" }, { "description": "Forward messages to a set of msisdns.", "key": "forward_sms", "value": "" }, { "description": "Forward messages to a set of msisdns.", "key": "forward_sms", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/edit-keyword.json", "host": [ "{{baseUrl}}" ], "path": [ "edit-keyword.json" ] }, "description": "Edit an existing keyword." }, "response": [ { "id": "3665b4a1-fab5-455f-bfeb-9e120498eefa", "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "(Required) The first word of a text message.", "key": "keyword", "value": "" }, { "description": "(Required) The dedicated virtual number that the keyword belongs to.", "key": "number", "value": "" }, { "description": "Your own reference (up to 100 characters).", "key": "reference", "value": "" }, { "description": "Open, will set the Keyword to being active. Closed, will close the Keyword.\n", "key": "status", "value": "Open" }, { "description": "ID of a list to add respondents to. List ID's can be found in the title of a list or in the list page URL.", "key": "list_id", "value": "" }, { "description": "SMS message to send to new members.", "key": "welcome_message", "value": "" }, { "description": "SMS message to existing members.", "key": "members_message", "value": "" }, { "description": "Whether to make the keyword active immediately.", "key": "activate", "value": "true" }, { "description": "Forward messages to a URL.", "key": "forward_url", "value": "" }, { "description": "Forward messages to a set of email addresses.", "key": "forward_email", "value": "" }, { "description": "Forward messages to a set of msisdns.", "key": "forward_sms", "value": "" }, { "description": "Forward messages to a set of msisdns.", "key": "forward_sms", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/edit-keyword.json", "host": [ "{{baseUrl}}" ], "path": [ "edit-keyword.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"keyword\": \"\",\n \"reference\": \"\",\n \"number\": \"\",\n \"list_id\": \"\",\n \"welcome_message\": \"\",\n \"member_message\": \"\",\n \"forward_url\": \"\",\n \"forward_sms\": \"\",\n \"forward_email\": \"\",\n \"status\": \"\",\n \"billing_date\": \"\",\n \"error\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-3665b4a1-fab5-455f-bfeb-9e120498eefa" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-cc4fd0a2-70e0-4a23-b9a5-07a2e81e796c" } ], "id": "a5eeeb31-f883-49fc-a28e-7c6b42105d41", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-a5eeeb31-f883-49fc-a28e-7c6b42105d41" }, { "name": "get-keywords.json", "item": [ { "name": "Get Keywords", "id": "3d292ee0-ea8b-46e6-848d-0fc7ce82db46", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "Filter the list by virtual number.", "key": "number", "value": "" }, { "description": "Page number for pagination.", "key": "page", "value": "" }, { "description": "Maximum results returned per page.", "key": "max", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-keywords.json", "host": [ "{{baseUrl}}" ], "path": [ "get-keywords.json" ] }, "description": "Get a list of existing keywords." }, "response": [ { "id": "b22a4b20-176d-4375-95c8-06f1107cd544", "name": "Successful response", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "body": { "mode": "urlencoded", "urlencoded": [ { "description": "Filter the list by virtual number.", "key": "number", "value": "" }, { "description": "Page number for pagination.", "key": "page", "value": "" }, { "description": "Maximum results returned per page.", "key": "max", "value": "" } ] }, "url": { "raw": "{{baseUrl}}/get-keywords.json", "host": [ "{{baseUrl}}" ], "path": [ "get-keywords.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"page\": {\n \"count\": \"\",\n \"number\": \"\"\n },\n \"keywords_total\": \"\",\n \"keywords\": [\n {\n \"keyword\": \"\",\n \"reference\": \"\",\n \"number\": \"\",\n \"list_id\": \"\",\n \"welcome_message\": \"\",\n \"member_message\": \"\",\n \"forward_url\": \"\",\n \"forward_sms\": \"\",\n \"forward_email\": \"\",\n \"status\": \"\",\n \"billing_date\": \"\"\n },\n {\n \"keyword\": \"\",\n \"reference\": \"\",\n \"number\": \"\",\n \"list_id\": \"\",\n \"welcome_message\": \"\",\n \"member_message\": \"\",\n \"forward_url\": \"\",\n \"forward_sms\": \"\",\n \"forward_email\": \"\",\n \"status\": \"\",\n \"billing_date\": \"\"\n }\n ],\n \"error\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-b22a4b20-176d-4375-95c8-06f1107cd544" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-3d292ee0-ea8b-46e6-848d-0fc7ce82db46" } ], "id": "7ef63d43-56cd-47f3-8cca-f04058b6f5b9", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-7ef63d43-56cd-47f3-8cca-f04058b6f5b9" }, { "name": "get-balance.json", "item": [ { "name": "Get Balance", "id": "0218fcdb-1d74-4f29-9840-864283f059be", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{basicAuthUsername}}", "type": "string" }, { "key": "password", "value": "{{basicAuthPassword}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/get-balance.json", "host": [ "{{baseUrl}}" ], "path": [ "get-balance.json" ] }, "description": "Account information.\n" }, "response": [ { "id": "c33cc268-354c-4bd4-804d-1165bb07c255", "name": "Successful response", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: basic", "key": "Authorization", "value": "Basic " } ], "url": { "raw": "{{baseUrl}}/get-balance.json", "host": [ "{{baseUrl}}" ], "path": [ "get-balance.json" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"balance\": \"\",\n \"currency\": \"\",\n \"error\": {\n \"code\": \"\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:01:25.000Z", "updatedAt": "2026-07-28T02:01:25.000Z", "uid": "35240-c33cc268-354c-4bd4-804d-1165bb07c255" } ], "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-0218fcdb-1d74-4f29-9840-864283f059be" } ], "id": "65c0f3c5-55af-4d8e-b7e7-25889b1098a7", "createdAt": "2026-07-28T02:01:24.000Z", "updatedAt": "2026-07-28T02:01:24.000Z", "uid": "35240-65c0f3c5-55af-4d8e-b7e7-25889b1098a7" } ], "variable": [ { "key": "baseUrl", "value": "https://api.transmitsms.com" } ] }