{ "info": { "_postman_id": "05815968-6a89-4ff6-aba7-4c35d46d8300", "name": "SMSVIRO API", "description": "**SMSVIRO API** is documentation we provide to help you send SMS via other applications.\n\nOur SMSVIRO documentation is divided into 4 categories:\n\n1. Send SMS\n2. Delivery Report\n3. Logs\n4. Get Account Balance\n5. Responses Status\n \n\nWe provide code examples that can be easily studied, for more details, please open the link [API Documentation](https://send.smsviro.com/api.zip).\n\nBefore making an API request, there are several things you need to pay attention to:\n\n1. All requests are sent in **JSON**.\n2. Make sure you have the API key generated on the Dashboard [SMSVIRO Regular, ](https://send.smsviro.com/) [SMSVIRO Premium, ](https://premium.smsviro.com/) or [SMSVIRO International](https://international.smsviro.com/) according to your account type. \n After successfully logging in, click the API Keys menu in the Developer Tools category.\n3. After successfully logging in, click the **API Keys** menu in the **Developer Tools** category.\n \n\n\n\n4\\. Click **CREATE API KEY.**\n\n\n\n5\\. In the form, fill in the Name with the name of the API KEY. There are 3 choices for roles:\n\n- **Public API**: Provides access to all APIs\n- **Two-factor authentication**: Provides access for those of you who have the application by implementing the 2FA method. The contents of the message are a PIN sent via SMS to the destination number.\n- **Web SDK**: Provides access to the Web JS SDK\n \n\nCheck **Public API**, set the **API Key expiration date**, and add IP Addresses if you want the API to only be accessed via certain IP Address, these are not mandatory. Then click the **GENERATE button**.\n\n\n\n6\\. Copy the **API Key** that has been created by clicking the copy icon **according** to the image below.\n\n\n\n7\\. The API Key writing format in the header is **App {{ API_KEY }}**. Your API KEY must consist of **69 characters**. Example App 5d3g0wk3y1cg20qk0mm4d8l8l419xny2-5z3xooay-7vpc-6z29-za3g-2fpj40mhs0m7.\n\n8\\. Make sure the destination number in the **Body** begins with the country code without using the plus symbol (+). Example: 6282386xxxxxx (**True**), 082386xxxxxx (**False**), +6282386xxxxxx (**False**)", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "29794109", "_collection_link": "https://www.postman.com/infosmsviro/workspace/smsviro-workspace/collection/29794109-05815968-6a89-4ff6-aba7-4c35d46d8300?action=share&source=collection_link&creator=29794109" }, "item": [ { "name": "Send SMS", "item": [ { "name": "Send Text Message", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "App {{API_KEY}}", "type": "string" }, { "key": "key", "value": "Authorization", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"from\": \"{{SENDER_ID}}\",\r\n \"to\": \"{{TO}}\",\r\n // Sending SMS to more than one number can add other numbers separated by comma (,)\r\n \"text\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras interdum.\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api.smsviro.com/restapi/sms/1/text/single", "protocol": "https", "host": [ "api", "smsviro", "com" ], "path": [ "restapi", "sms", "1", "text", "single" ] } }, "response": [] }, { "name": "Send Text Message Multiple", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "App {{API_KEY}}", "type": "string" }, { "key": "key", "value": "Authorization", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"messages\": [\r\n {\r\n \"from\": \"{{SENDER_ID}}\",\r\n \"to\": [\r\n \"{{TO}}\"\r\n // Sending a message to more than one destination number separate the numbers with a , (comma)\r\n ],\r\n \"text\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras interdum.\"\r\n },\r\n // The following is an example of a message that can be sent with the same/different sender ID to more than one destination number\r\n {\r\n \"from\": \"{{SENDER_ID}}\",\r\n \"to\": [\r\n \"{{TO}}\"\r\n ],\r\n \"text\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras interdum.\"\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api.smsviro.com/restapi/sms/1/text/multi", "protocol": "https", "host": [ "api", "smsviro", "com" ], "path": [ "restapi", "sms", "1", "text", "multi" ] } }, "response": [] }, { "name": "Send Text Message Advanced", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "App {{API_KEY}}", "type": "string" }, { "key": "key", "value": "Authorization", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"messages\": [\r\n {\r\n \"from\": \"{{SENDER_ID}}\",\r\n \"destinations\": [\r\n {\r\n \"to\": \"{{TO}}\",\r\n \"messageId\": \"{{MESSAGE_ID}}\"\r\n }\r\n ],\r\n \"text\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras interdum.\",\r\n \"flash\": false,\r\n \"language\": {\r\n \"languageCode\": \"TR\",\r\n \"singleShift\": true,\r\n \"lockingShift\": false\r\n },\r\n \"transliteration\": \"TURKISH\",\r\n \"notifyUrl\": \"{{NOTIFY_URL}}\",\r\n \"notifyContentType\": \"{{NOTIFY_CONTENT_TYPE}}\",\r\n \"callbackData\": \"DLR callback data\",\r\n \"validityPeriod\": 720,\r\n \"sendAt\": \"{{SEND_AT}}\"\r\n },\r\n // The following is an example of a message that can be sent with the same/different sender ID to more than one destination number\r\n {\r\n \"from\": \"{{SENDER_ID}}\",\r\n \"destinations\": [\r\n {\r\n \"to\": \"{{TO}}\"\r\n }\r\n ],\r\n \"text\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras interdum.\"\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://api.smsviro.com/restapi/sms/1/text/advanced", "protocol": "https", "host": [ "api", "smsviro", "com" ], "path": [ "restapi", "sms", "1", "text", "advanced" ] } }, "response": [] } ], "description": "**Send SMS** is an SMSVIRO API that is used to send SMS which is divided into 3 types:\n\n1. **Send Text Message**, for sending a single message to one or more destination numbers.\n \n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| from \\* | String | Sender ID |\n| to \\* | String | Destination number. If you want to send to more than one destination number, separate the numbers with a comma ( , ) |\n| text \\* | String | Message content |\n\nParameters marked with a sign **( \\* )** are **mandatory**.\n\n2\\. **Send Text Message Multiple**, to send messages with the same/different sender ID to one or more destination numbers simultaneously.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| from \\* | String | Sender ID |\n| to \\* | String | Destination number. If you want to send to more than one destination number, separate the numbers with a comma ( , ) |\n| text \\* | String | Message content |\n\nParameters marked with a sign **( \\* )** are **mandatory**.\n\n3\\. **Send Text Message Advanced**, to send messages with the same/different Sender ID to one or more destination numbers simultaneously with further parameter options that can be seen in Body.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| from \\* | String | Sender ID |\n| to \\* | String | Destination number. If you want to send to more than one destination number, separate the numbers with a comma ( , ) |\n| text \\* | String | Message content |\n| bulkId | String | The ID which uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address |\n| messageId | String | The ID that uniquely identifies the message sent |\n| flash | Boolean (default: false) | Can be true or false. If the value is set to true, a
flash SMS will be sent. Otherwise, a normal SMS will be sent. |\n| transliteration | String | Conversion of a message text from one script to another. Possible values: “TURKISH\",“GREEK\",
\"CYRILLIC\", \"CENTRAL_EUROPEAN\" |\n| languageCode | String | Code for language character set of a message text. Possible
values: TR for Turkish, ES for Spanish and PT for
Portuguese |\n| singleShift | Boolean | Single shift table replacing the GSM 7 bit default alphabet extension table |\n| lockingShift | Boolean | Locking shift table replacing standard GSM 7 bit default alphabet table |\n| notifyUrl | String | The URL on your call back server on which the Delivery report will be sent |\n| notifyContentType | String | Preferred Delivery report content type. Can be
**application/json** or **application/xml** |\n| callbackData | String | Additional client’s data that will be sent on the notifyUrl |\n| validityPeriod | Integer | The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent.
Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h) |\n| sendAt | DateTime | Date and time when the message is to be sent. Used for scheduled SMS (SMS not sent immediately, but at scheduled time) |\n\nParameters marked with a sign **( \\* )** are **mandatory**.\n\n#### Notify URL\n\nThe Notify URL in the Body payload is optional (not required). This Notify URL functions to receive SMS status changes sent by the SMSVIRO server. Every time there is a change in the sending status of the SMS, the data will be sent to the notify url.\n\nThe following is an example of the payload sent by the SMSVIRO server to the Notify URL:\n\n\n\n### Attention\n\n- Make sure the **Sender ID** is written correctly, especially in capital letters. The Sender ID/Masking name consists of a **maximum of 11 characters**, a combination of letters and numbers that represent your business name. Sender ID appears as the name of the **SMS sender**.\n- **Destination number** in the format 628123456789 (**true**), 08123456789 (**false**), +628123456789 (**false**).\n- The message content must not exceed **160 characters**. If you exceed the maximum limit, you will be **charged for more than 1 SMS.**" }, { "name": "Delivery Report", "item": [ { "name": "Getting Reports", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "App {{API_KEY}}", "type": "string" }, { "key": "key", "value": "Authorization", "type": "string" } ] }, "method": "GET", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "MESSAGE_ID", "value": "MESSAGE-ID-123-xyz", "type": "text" }, { "key": "BULK_ID", "value": "BULK-ID-123-xyz", "type": "text" }, { "key": "LIMIT", "value": "1", "type": "text" } ] }, "url": { "raw": "https://api.smsviro.com/restapi/sms/1/reports", "protocol": "https", "host": [ "api", "smsviro", "com" ], "path": [ "restapi", "sms", "1", "reports" ], "query": [ { "key": "MESSAGE_ID", "value": "MESSAGE-ID-123-xyz", "disabled": true }, { "key": "BULK_ID", "value": "BULK-ID-123-xyz", "disabled": true }, { "key": "LIMIT", "value": "1", "disabled": true } ] } }, "response": [] } ], "description": "**Delivery Report** is an SMSVIRO API that is used to view message delivery status.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| bulkId | String | IDs are only accepted if sending messages to multiple numbers or sending messages via 1 API request. And also used to get delivery reports and message logs |\n| messageId | String | ID to identify the message sent |\n| limit | Integer | Limits the report limit that you want to display |\n\n### Attention\n\nIf you make the same request again, you will get the following response.\n\n\n\nYou will get an empty response because all delivery reports have been read in the previous request." }, { "name": "Logs", "item": [ { "name": "Getting Logs", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "App {{API_KEY}}", "type": "string" }, { "key": "key", "value": "Authorization", "type": "string" } ] }, "method": "GET", "header": [], "body": { "mode": "formdata", "formdata": [ { "key": "SENDER_ID", "value": "InfoSMS", "type": "text" }, { "key": "TO", "value": "6287654321", "type": "text" }, { "key": "BULK_ID", "value": "BULK-ID-123-xyz", "type": "text" }, { "key": "MESSAGE_ID", "value": "MESSAGE-ID-123-xyz", "type": "text" }, { "key": "GENERAL_STATUS", "value": "DELIVERED", "type": "text" }, { "key": "SENT_SINCE", "value": "2019-11-09T16:00:00.000+0000", "type": "text" }, { "key": "SENT_UNTIL", "value": "2019-11-09T16:00:00.000+0000", "type": "text" }, { "key": "LIMIT", "value": "1", "type": "text" }, { "key": "MCC", "value": "510", "type": "text" }, { "key": "MNC", "value": "10", "type": "text" } ] }, "url": { "raw": "https://api.smsviro.com/restapi/sms/1/logs", "protocol": "https", "host": [ "api", "smsviro", "com" ], "path": [ "restapi", "sms", "1", "logs" ], "query": [ { "key": "SENDER_ID", "value": "InfoSMS", "disabled": true }, { "key": "TO", "value": "6287654321", "disabled": true }, { "key": "BULK_ID", "value": "BULK-ID-123-xyz", "disabled": true }, { "key": "MESSAGE_ID", "value": "MESSAGE-ID-123-xyz", "disabled": true }, { "key": "GENERAL_STATUS", "value": "DELIVERED", "disabled": true }, { "key": "SENT_SINCE", "value": "2019-11-09T16:00:00.000+0000", "disabled": true }, { "key": "SENT_UNTIL", "value": "2019-11-09T16:00:00.000+0000", "disabled": true }, { "key": "LIMIT", "value": "1", "disabled": true }, { "key": "MCC", "value": "510", "disabled": true }, { "key": "MNC", "value": "10", "disabled": true } ] } }, "response": [] } ], "description": "**Getting Logs** is an SMSVIRO API that is used to view all history of messages sent.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| from | String | Sender ID |\n| to | String | Destination number. If you want to send to more than one destination number, separate the numbers with a , (comma) |\n| bulkId | String | The ID which uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address |\n| messageId | String | Message ID for which logs are requested |\n| generalStatus | String | Sent SMS status |\n| sentSince | Date | Lower limit on date and time of sending SMS |\n| sentUntil | Date | Upper limit on date and time of sending SMS |\n| limit | Integer | Max number of messages in returned logs |\n| mcc | String | Mobile country code |\n| mnc | String | Mobile network code |\n\nFurther explanation regarding mcc and mnc can be seen at this [link](https://mcc-mnc.com/)." }, { "name": "Get Account Balance", "item": [ { "name": "Get Account Balance", "request": { "auth": { "type": "apikey", "apikey": [ { "key": "value", "value": "App {{API_KEY}}", "type": "string" }, { "key": "key", "value": "Authorization", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "https://api.smsviro.com/restapi/account/1/balance", "protocol": "https", "host": [ "api", "smsviro", "com" ], "path": [ "restapi", "account", "1", "balance" ] } }, "response": [] } ], "description": "**Getting Logs** is an SMSVIRO API that is used to display account balances." }, { "name": "Responses Status", "item": [ { "name": "Status: Successful Send text Message", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"messages\": [\r\n {\r\n \"to\": \"6287654321\",\r\n \"status\": {\r\n \"groupId\": 0,\r\n \"groupName\": \"ACCEPTED\",\r\n \"id\": 0,\r\n \"name\": \"MESSAGE_ACCEPTED\",\r\n \"description\": \"Message accepted\"\r\n },\r\n \"smsCount\": 1,\r\n \"messageId\": \"MESSAGE-ID-123-xyz\"\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" } }, "response": [] }, { "name": "Status: Successful Send text Message Multiple", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"bulkId\": \"BULK-ID-123-xyz\",\r\n \"messages\": [\r\n {\r\n \"to\": \"6287654321\",\r\n \"status\": {\r\n \"groupId\": 0,\r\n \"groupName\": \"ACCEPTED\",\r\n \"id\": 0,\r\n \"name\": \"MESSAGE_ACCEPTED\",\r\n \"description\": \"Message accepted\"\r\n },\r\n \"messageId\": \"MESSAGE-ID-123-xyz\",\r\n \"smsCount\": 1\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" } }, "response": [] }, { "name": "Status: Successful Send text Message Advanced", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"bulkId\": \"BULK-ID-123-xyz\",\r\n \"messages\": [\r\n {\r\n \"to\": \"6287654321\",\r\n \"status\": {\r\n \"groupId\": 0,\r\n \"groupName\": \"ACCEPTED\",\r\n \"id\": 0,\r\n \"name\": \"MESSAGE_ACCEPTED\",\r\n \"description\": \"Message accepted\"\r\n },\r\n \"messageId\": \"MESSAGE-ID-123-xyz\",\r\n \"smsCount\": 1\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" } }, "response": [] }, { "name": "Example of payload sent by SMSVIRO server to Notify URL", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"messageId\": \"MESSAGE-ID-123-xyz\",\r\n \"status\": {\r\n \"groupId\": 0,\r\n \"groupName\": \"ACCEPTED\",\r\n \"id\": 0,\r\n \"name\": \"MESSAGE_ACCEPTED\",\r\n \"description\": \"Message accepted\"\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" } }, "response": [] }, { "name": "Status: Successful Getting Reports", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"results\": [\r\n {\r\n \"bulkId\": \"BULK-ID-123-xyz\",\r\n \"messageId\": \"MESSAGE-ID-123-xyz\",\r\n \"to\": \"6287654321\",\r\n \"sentAt\": \"2015-02-12T09:58:20.323+0100\",\r\n \"doneAt\": \"2015-02-12T09:58:20.337+0100\",\r\n \"smsCount\": 1,\r\n \"price\": {\r\n \"pricePerMessage\": 585.0,\r\n \"currency\": \"IDR\"\r\n },\r\n \"status\": {\r\n \"id\": 5,\r\n \"groupId\": 3,\r\n \"groupName\": \"DELIVERED\",\r\n \"name\": \"DELIVERED_TO_HANDSET\",\r\n \"description\": \"Message delivered to handset\"\r\n },\r\n \"error\": {\r\n \"groupId\": 0,\r\n \"groupName\": \"OK\",\r\n \"id\": 0,\r\n \"name\": \"NO_ERROR\",\r\n \"description\": \"No Error\",\r\n \"permanent\": false\r\n }\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" } }, "response": [] }, { "name": "Status: Successful Getting Logs", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"results\": [\r\n {\r\n \"messageId\": \"MESSAGE-ID-123-xyz\",\r\n \"to\": \"6287654321\",\r\n \"from\": \"infoSMS\",\r\n \"text\": \"This is a sample message\",\r\n \"sentAt\": \"2023-08-14T07:29:23.288+0000\",\r\n \"doneAt\": \"2023-08-14T07:29:24.570+0000\",\r\n \"smsCount\": 1,\r\n \"mccMnc\": \"51010\",\r\n \"price\": {\r\n \"pricePerMessage\": 585.0,\r\n \"currency\": \"IDR\"\r\n },\r\n \"status\": {\r\n \"groupId\": 3,\r\n \"groupName\": \"DELIVERED\",\r\n \"id\": 5,\r\n \"name\": \"DELIVERED_TO_HANDSET\",\r\n \"description\": \"Message delivered to handset\"\r\n },\r\n \"error\": {\r\n \"groupId\": 0,\r\n \"groupName\": \"OK\",\r\n \"id\": 0,\r\n \"name\": \"NO_ERROR\",\r\n \"description\": \"No Error\",\r\n \"permanent\": false\r\n },\r\n \"applicationId\": \"default\"\r\n }\r\n ]\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" } }, "response": [] }, { "name": "Same Request for Delivery Reports", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"results\": []\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" } }, "response": [] }, { "name": "Status: Successful Get Account Balance", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"balance\": 47.79134,\r\n \"currency\": \"IDR\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" } }, "response": [] }, { "name": "Status: Status object example", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"groupId\": 3,\r\n \"groupName\": \"DELIVERED\",\r\n \"id\": 5,\r\n \"name\": \"DELIVERED_TO_HANDSET\",\r\n \"description\": \"Message delivered to handset\"\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" } }, "response": [] }, { "name": "Status: Error object example", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"groupId\": 1,\r\n \"groupName\": \"HANDSET_ERRORS\",\r\n \"id\": 13,\r\n \"name\": \"EC_CALL_BARRED\",\r\n \"description\": \"Handset error occurred\",\r\n \"permanent\": false\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" } }, "response": [] }, { "name": "Status: Error 400 Bad Request", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"requestError\": {\r\n \"serviceException\": {\r\n \"messageId\": \"BAD_REQUEST\",\r\n \"text\": \"Bad request\"\r\n }\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" } }, "response": [] }, { "name": "Status: Error 401 Unauthorized", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"requestError\": {\r\n \"serviceException\": {\r\n \"messageId\": \"UNAUTHORIZED\",\r\n \"text\": \"Unauthorized\"\r\n }\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" } }, "response": [] }, { "name": "Status: Error 500 Internal Server Error", "request": { "method": "VIEW", "header": [], "body": { "mode": "raw", "raw": "{\r\n \"requestError\": {\r\n \"serviceException\": {\r\n \"messageId\": \"GENERAL_ERROR\",\r\n \"text\": \"Something went wrong. Please contact support.\"\r\n }\r\n }\r\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "" } }, "response": [] } ], "description": "The following is an explanation of the response that will appear after making a request:\n\n- If the request is successful, the HTTP header response status code will be **200** **OK**, which means the message will be sent.\n- The HTTP header response status code will be **400 Bad Request**, which means the message will not be sent. The reason the message failed to send was because\n \n\n1. Incorrect **Sender ID**\n2. Incorrect **destination number format**\n \n\n- If you try to send a message without **Authorization**, the HTTP header response status code will be **401 Unauthorized**, which means the message will not be sent. The reason the message failed to send was because:\n \n\n1. The API Key writing format in the header is incorrect. The correct format is **App {{ API_KEY }}**\n2. **The API Key** entered is incorrect\n \n\n- The HTTP header response status code will be **500 Internal Server Error**, which means the message will not be sent. The reason the message failed to send was because:\n \n\n1. The system server is down\n2. If you experience this error, [contact us](https://wa.me/6289667678789)\n \n\n**1\\. Send SMS Responses**\n\n| **Parameter** | **Description** |\n| --- | --- |\n| messages | The contents of the message sent to the requester |\n| to | Destination number |\n| messageId | The ID that uniquely identifies the message sent |\n| bulkId | The ID which uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address |\n| smscount | The number of sent message segments |\n| status | Message delivery status |\n| groupId | Group ID |\n| groupName | Group name |\n| id | Status ID |\n| name | Status Name |\n| description | Human readable description of the status |\n\n**2\\. Getting Report and Logs Responses**\n\n| **Parameter** | **Description** |\n| --- | --- |\n| to | Destination number |\n| bulkId | The ID which uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address |\n| messageId | Message ID for which logs are requested |\n| sentAt | Tells when the SMS was sent |\n| doneAt | Tells when the SMS was finished |\n| smsCount | The number of sent message segments |\n| price | \\-pricePerMessage: Sending price per message
\\-currency: Currency |\n| status and error | Message delivery status and errors |\n\n**3\\. Get Account Balance**\n\n| **Parameter** | **Description** |\n| --- | --- |\n| balance | Account balance |\n| currency | Currency |\n\n**4\\. SMS API Statuses**\n\n#### Statuses Groups\n\n| GroupId | GroupName | Description |\n| --- | --- | --- |\n| 0 | ACCEPTED | Messages is accepted |\n| 1 | PENDING | Message has been processed and sent to mobile operator |\n| 2 | UNDELIVERABLE | Message has not been delivered |\n| 3 | DELIVERED | Message has successfully been processed and delivered |\n| 4 | EXPIRED | Message has been sent, and has either expired due to being pending past its validity period (our platform default is 48 hours) |\n| 5 | REJECTED | Message has been received, but has either been rejected by operator |\n\nClick [Status Codes](https://smsviro.com/web/documentation.php#request-status-error-statuses) to see a more detailed explanation.\n\n#### Errors Groups\n\n| GroupId | GroupName | Description |\n| --- | --- | --- |\n| 0 | OK | No error, delivery successful |\n| 1 | HANDSET_ERRORS | Handset error occurred |\n| 2 | USER_ERRORS | User error occured |\n| 3 | OPERATOR_ERRORS | Operator error occurred |\n\nClick [Error Codes](https://smsviro.com/web/documentation.php#request-status-error-errors) to see a more detailed explanation.\n\n### Attention\n\n- For all messages with an error status, the balance will still be deducted except for the **REJECTED** error message." } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ], "variable": [ { "key": "URL", "value": "api.smsviro.com" }, { "key": "API_KEY", "value": "45230371191013987025" }, { "key": "SENDER_ID", "value": "InfoSMS" }, { "key": "TO", "value": "6287654321" }, { "key": "MESSAGE_ID", "value": "MESSAGE-ID-123-xyz" }, { "key": "LIMIT", "value": "1" }, { "key": "NOTIFY_URL", "value": "http://www.example.com/sms/advanced" }, { "key": "NOTIFY_CONTENT_TYPE", "value": "application/json" }, { "key": "SEND_AT", "value": "2023-08-16T13:18:00.000+01:00" } ] }