{ "item": [ { "name": "sms_gw", "description": "", "item": [ { "name": "sendsms.aspx", "description": "", "item": [ { "id": "86daff6e-18c4-41f8-b2db-4acf36e0d2f2", "name": "Send SMS (GET) ⚠ Deprecated", "request": { "name": "Send SMS (GET) ⚠ Deprecated", "description": { "content": "⚠ **Deprecated** — Use POST instead. Credentials appear in server logs.\n\nSend SMS via GET query parameters. All values must be URL-encoded.", "type": "text/plain" }, "url": { "path": [ "sms_gw", "sendsms.aspx" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Recipient mobile number(s). Multiple numbers comma-separated (max 50). Domestic: 09xxxxxxxx. International: prefix with `+` URL-encoded as `%2b`, e.g. `%2b8613681912700`.", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "(Required) SMS content. Max 70 chars (zh/en mix) or 160 chars (ASCII). Long SMS (`L*` encodings): max 335 chars. WAP Push (`PUSH`): this is the push title; `smbody`+`wapurl` ≤ 88 bytes.", "type": "text/plain" }, "key": "smbody", "value": "" }, { "disabled": false, "description": { "content": "Message encoding. Default: `BIG5`.\n\n| Value | Description |\n|---|---|\n| `BIG5` | Traditional Chinese, single SMS, max 70 chars |\n| `ASCII` | English only, single SMS, max 160 chars |\n| `UCS2` | Unicode (Japanese, Korean, Simplified Chinese) |\n| `PBIG5` | POPUP Traditional Chinese |\n| `PASCII` | POPUP English |\n| `LBIG5` | Long SMS Traditional Chinese, max 335 chars |\n| `LASCII` | Long SMS English |\n| `LUCS2` | Long SMS Unicode |\n| `PUSH` | WAP Push (requires `wapurl`) | (This can only be one of BIG5,ASCII,UCS2,PBIG5,PASCII,LBIG5,LASCII,LUCS2,PUSH)", "type": "text/plain" }, "key": "encoding", "value": "BIG5" }, { "disabled": false, "description": { "content": "Scheduled delivery time. Format: `YYYY/MM/DD hh24:mm:ss`. Leave blank to send immediately.", "type": "text/plain" }, "key": "dlvtime", "value": "" }, { "disabled": false, "description": { "content": "WAP Push destination URL. Only used when `encoding=PUSH`. Combined with `smbody` must be ≤ 88 bytes.", "type": "text/plain" }, "key": "wapurl", "value": "" }, { "disabled": false, "description": { "content": "Callback URL to receive user reply messages (extra charge: +1 point per 10 messages). Only for `BIG5`/`ASCII`/`UCS2`. Max 300 characters.", "type": "text/plain" }, "key": "replyurl", "value": "" }, { "disabled": false, "description": { "content": "Number of days to collect user replies. Default: 3, Max: 30. Only for `BIG5`/`ASCII`/`UCS2`.", "type": "text/plain" }, "key": "replydays", "value": "3" }, { "disabled": false, "description": { "content": "Callback URL for delivery status reports. System POSTs status updates to this URL. Leave blank to disable.", "type": "text/plain" }, "key": "response", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text, `JSON` for JSON, `XML` for XML. (This can only be one of JSON,XML)", "type": "text/plain" }, "key": "rtype", "value": "XML" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2294642c-9b0b-48e9-9728-d895572dba5e", "name": "API Send SMS response. Format determined by `rtype` parameter. `statuscode=0` means success.\n\n**Error Codes:**\n\n| Code | Description |\n|:---|:---|\n| `0` | Success |\n| `-1` | CGI string error |\n| `-2` | Username, password, or IP error |\n| `-3` | Username or password empty |\n| `-5` | Phone number format error |\n| `-8` | Insufficient points |\n| `-9` | Too many recipients (max 50) |\n| `-10` | Send failed |\n| `-11` | Database error |\n| `-12` | Message body empty |\n| `-13` | Parameter count mismatch |\n| `-14` | Fraud keyword detected |\n| `-15` | IP address not allowed |\n| `-16` | API service not enabled |\n| `-17` | Callback URL not allowed |\n| `-18` | Off-net number |\n| `-19` | Number blocked |\n| `-20` | Marked as SPAM |\n| `-21` | Capacity reached |\n| `-22` | Request rerouted |\n| `-23` | No signature |\n| `-24` | OTP verification failed |\n| `-25` | OTP expired |\n| `-30` | Operator system ID error |", "originalRequest": { "url": { "path": [ "sms_gw", "sendsms.aspx" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Recipient mobile number(s). Multiple numbers comma-separated (max 50). Domestic: 09xxxxxxxx. International: prefix with `+` URL-encoded as `%2b`, e.g. `%2b8613681912700`.", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "(Required) SMS content. Max 70 chars (zh/en mix) or 160 chars (ASCII). Long SMS (`L*` encodings): max 335 chars. WAP Push (`PUSH`): this is the push title; `smbody`+`wapurl` ≤ 88 bytes.", "type": "text/plain" }, "key": "smbody", "value": "" }, { "disabled": false, "description": { "content": "Message encoding. Default: `BIG5`.\n\n| Value | Description |\n|---|---|\n| `BIG5` | Traditional Chinese, single SMS, max 70 chars |\n| `ASCII` | English only, single SMS, max 160 chars |\n| `UCS2` | Unicode (Japanese, Korean, Simplified Chinese) |\n| `PBIG5` | POPUP Traditional Chinese |\n| `PASCII` | POPUP English |\n| `LBIG5` | Long SMS Traditional Chinese, max 335 chars |\n| `LASCII` | Long SMS English |\n| `LUCS2` | Long SMS Unicode |\n| `PUSH` | WAP Push (requires `wapurl`) | (This can only be one of BIG5,ASCII,UCS2,PBIG5,PASCII,LBIG5,LASCII,LUCS2,PUSH)", "type": "text/plain" }, "key": "encoding", "value": "BIG5" }, { "disabled": false, "description": { "content": "Scheduled delivery time. Format: `YYYY/MM/DD hh24:mm:ss`. Leave blank to send immediately.", "type": "text/plain" }, "key": "dlvtime", "value": "" }, { "disabled": false, "description": { "content": "WAP Push destination URL. Only used when `encoding=PUSH`. Combined with `smbody` must be ≤ 88 bytes.", "type": "text/plain" }, "key": "wapurl", "value": "" }, { "disabled": false, "description": { "content": "Callback URL to receive user reply messages (extra charge: +1 point per 10 messages). Only for `BIG5`/`ASCII`/`UCS2`. Max 300 characters.", "type": "text/plain" }, "key": "replyurl", "value": "" }, { "disabled": false, "description": { "content": "Number of days to collect user replies. Default: 3, Max: 30. Only for `BIG5`/`ASCII`/`UCS2`.", "type": "text/plain" }, "key": "replydays", "value": "3" }, { "disabled": false, "description": { "content": "Callback URL for delivery status reports. System POSTs status updates to this URL. Leave blank to disable.", "type": "text/plain" }, "key": "response", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text, `JSON` for JSON, `XML` for XML. (This can only be one of JSON,XML)", "type": "text/plain" }, "key": "rtype", "value": "XML" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": {\n \"msgid\": \"\",\n \"statuscode\": \"\",\n \"statusstr\": \"\",\n \"point\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5e99d649-43ba-41f6-998f-dfc20ed0fd24", "name": "Send SMS (POST)", "request": { "name": "Send SMS (POST)", "description": { "content": "Send an SMS message. Accepts `application/x-www-form-urlencoded` or `application/json`.", "type": "text/plain" }, "url": { "path": [ "sms_gw", "sendsms.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Recipient number(s), comma-separated, max 50", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) SMS content", "type": "text/plain" }, "key": "smbody", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "encoding", "value": "BIG5" }, { "disabled": false, "description": { "content": "Scheduled time: YYYY/MM/DD hh24:mm:ss", "type": "text/plain" }, "key": "dlvtime", "value": "" }, { "disabled": false, "description": { "content": "WAP Push URL (encoding=PUSH only)", "type": "text/plain" }, "key": "wapurl", "value": "" }, { "disabled": false, "description": { "content": "Reply callback URL (extra charge, max 300 chars)", "type": "text/plain" }, "key": "replyurl", "value": "" }, { "disabled": false, "description": { "content": "Days to collect replies (1–30)", "type": "text/plain" }, "key": "replydays", "value": "3" }, { "disabled": false, "description": { "content": "Status report callback URL", "type": "text/plain" }, "key": "response", "value": "" }, { "disabled": false, "description": { "content": "Response format", "type": "text/plain" }, "key": "rtype", "value": "XML" } ] }, "auth": null }, "response": [ { "id": "03976af5-212c-43a6-96dd-10b69b68690d", "name": "API Send SMS response. Format determined by `rtype` parameter. `statuscode=0` means success.\n\n**Error Codes:**\n\n| Code | Description |\n|:---|:---|\n| `0` | Success |\n| `-1` | CGI string error |\n| `-2` | Username, password, or IP error |\n| `-3` | Username or password empty |\n| `-5` | Phone number format error |\n| `-8` | Insufficient points |\n| `-9` | Too many recipients (max 50) |\n| `-10` | Send failed |\n| `-11` | Database error |\n| `-12` | Message body empty |\n| `-13` | Parameter count mismatch |\n| `-14` | Fraud keyword detected |\n| `-15` | IP address not allowed |\n| `-16` | API service not enabled |\n| `-17` | Callback URL not allowed |\n| `-18` | Off-net number |\n| `-19` | Number blocked |\n| `-20` | Marked as SPAM |\n| `-21` | Capacity reached |\n| `-22` | Request rerouted |\n| `-23` | No signature |\n| `-24` | OTP verification failed |\n| `-25` | OTP expired |\n| `-30` | Operator system ID error |", "originalRequest": { "url": { "path": [ "sms_gw", "sendsms.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Recipient number(s), comma-separated, max 50", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) SMS content", "type": "text/plain" }, "key": "smbody", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "encoding", "value": "BIG5" }, { "disabled": false, "description": { "content": "Scheduled time: YYYY/MM/DD hh24:mm:ss", "type": "text/plain" }, "key": "dlvtime", "value": "" }, { "disabled": false, "description": { "content": "WAP Push URL (encoding=PUSH only)", "type": "text/plain" }, "key": "wapurl", "value": "" }, { "disabled": false, "description": { "content": "Reply callback URL (extra charge, max 300 chars)", "type": "text/plain" }, "key": "replyurl", "value": "" }, { "disabled": false, "description": { "content": "Days to collect replies (1–30)", "type": "text/plain" }, "key": "replydays", "value": "3" }, { "disabled": false, "description": { "content": "Status report callback URL", "type": "text/plain" }, "key": "response", "value": "" }, { "disabled": false, "description": { "content": "Response format", "type": "text/plain" }, "key": "rtype", "value": "XML" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": {\n \"msgid\": \"\",\n \"statuscode\": \"\",\n \"statusstr\": \"\",\n \"point\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "query.aspx", "description": "", "item": [ { "id": "dbef40dc-2926-4236-a26c-9a7243b159e4", "name": "Query SMS Status (GET) ⚠ Deprecated", "request": { "name": "Query SMS Status (GET) ⚠ Deprecated", "description": { "content": "⚠ **Deprecated** — Use POST instead.\n\nQuery delivery status of a single SMS.", "type": "text/plain" }, "url": { "path": [ "sms_gw", "query.aspx" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Message ID returned from a successful send request.", "type": "text/plain" }, "key": "msgid", "value": "" }, { "disabled": false, "description": { "content": "(Required) Recipient mobile number(s). Multiple numbers comma-separated (max 50). Domestic: 09xxxxxxxx. International: prefix with `+` URL-encoded as `%2b`, e.g. `%2b8613681912700`.", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text, `JSON` for JSON, `XML` for XML. (This can only be one of JSON,XML)", "type": "text/plain" }, "key": "rtype", "value": "XML" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "05d8ceb9-1348-48c0-a63b-2ea1496c3435", "name": "Delivery status. Plain text format: `statusCode|statusStr|cellphone`\n\n**statusStr values:** `DELIVRD`, `REJECTD`, `EXPIRED`, `UNDELIV`, `UNKNOWN`, `ENROUTE`", "originalRequest": { "url": { "path": [ "sms_gw", "query.aspx" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Message ID returned from a successful send request.", "type": "text/plain" }, "key": "msgid", "value": "" }, { "disabled": false, "description": { "content": "(Required) Recipient mobile number(s). Multiple numbers comma-separated (max 50). Domestic: 09xxxxxxxx. International: prefix with `+` URL-encoded as `%2b`, e.g. `%2b8613681912700`.", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text, `JSON` for JSON, `XML` for XML. (This can only be one of JSON,XML)", "type": "text/plain" }, "key": "rtype", "value": "XML" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"result\": [\n {\n \"statusCode\": \"\",\n \"statusStr\": \"\",\n \"cellphone\": \"\"\n },\n {\n \"statusCode\": \"\",\n \"statusStr\": \"\",\n \"cellphone\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "f23a208f-13d3-4a8c-9547-6ae6fc496b18", "name": "Query SMS Status (POST)", "request": { "name": "Query SMS Status (POST)", "description": { "content": "Query delivery status of a single SMS via POST. Accepts `application/x-www-form-urlencoded` or `application/json`.", "type": "text/plain" }, "url": { "path": [ "sms_gw", "query.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Recipient phone number", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "(Required) Message ID from send response", "type": "text/plain" }, "key": "msgid", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "Response format", "type": "text/plain" }, "key": "rtype", "value": "XML" } ] }, "auth": null }, "response": [ { "id": "376a0cdf-7a4c-4e32-b5fd-b3d9c3228e76", "name": "Delivery status. Plain text: `statusCode|statusStr|cellphone`\n\n**statusStr values:** `DELIVRD`, `REJECTD`, `EXPIRED`, `UNDELIV`, `UNKNOWN`, `ENROUTE`", "originalRequest": { "url": { "path": [ "sms_gw", "query.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Recipient phone number", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "(Required) Message ID from send response", "type": "text/plain" }, "key": "msgid", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "Response format", "type": "text/plain" }, "key": "rtype", "value": "XML" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"result\": [\n {\n \"statusCode\": \"\",\n \"statusStr\": \"\",\n \"cellphone\": \"\"\n },\n {\n \"statusCode\": \"\",\n \"statusStr\": \"\",\n \"cellphone\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "queryBulk.aspx", "description": "", "item": [ { "id": "2e05057b-820e-45a0-82ee-2556a1e332f4", "name": "Query Bulk SMS Status (GET) ⚠ Deprecated", "request": { "name": "Query Bulk SMS Status (GET) ⚠ Deprecated", "description": { "content": "⚠ **Deprecated** — Use POST instead.\n\nQuery delivery status of multiple SMS. `msgid` and `dstaddr` are comma-separated and counts must match.", "type": "text/plain" }, "url": { "path": [ "sms_gw", "queryBulk.aspx" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) One or more message IDs separated by commas. Count must match `dstaddr`.", "type": "text/plain" }, "key": "msgid", "value": "" }, { "disabled": false, "description": { "content": "(Required) One or more phone numbers separated by commas. Count must match `msgid`.", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text, `JSON` for JSON, `XML` for XML. (This can only be one of JSON,XML)", "type": "text/plain" }, "key": "rtype", "value": "XML" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "d8f6dbd9-0bae-49b4-98a1-0c274f99cf53", "name": "Multiple records separated by `\\r\\n`. Each record: `statusCode|statusStr|cellphone|msgid`", "originalRequest": { "url": { "path": [ "sms_gw", "queryBulk.aspx" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) One or more message IDs separated by commas. Count must match `dstaddr`.", "type": "text/plain" }, "key": "msgid", "value": "" }, { "disabled": false, "description": { "content": "(Required) One or more phone numbers separated by commas. Count must match `msgid`.", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text, `JSON` for JSON, `XML` for XML. (This can only be one of JSON,XML)", "type": "text/plain" }, "key": "rtype", "value": "XML" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"result\": [\n {\n \"statusCode\": \"\",\n \"statusStr\": \"\",\n \"cellphone\": \"\",\n \"msgid\": \"\"\n },\n {\n \"statusCode\": \"\",\n \"statusStr\": \"\",\n \"cellphone\": \"\",\n \"msgid\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "96bcbc3d-7ebe-4e59-9b24-2b0818727ea8", "name": "Query Bulk SMS Status (POST)", "request": { "name": "Query Bulk SMS Status (POST)", "description": { "content": "Query delivery status of multiple SMS via POST. `msgid` and `dstaddr` are comma-separated and counts must match. Accepts `application/x-www-form-urlencoded` or `application/json`.", "type": "text/plain" }, "url": { "path": [ "sms_gw", "queryBulk.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Comma-separated phone numbers (count must match msgid)", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "(Required) Comma-separated message IDs", "type": "text/plain" }, "key": "msgid", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "Response format", "type": "text/plain" }, "key": "rtype", "value": "XML" } ] }, "auth": null }, "response": [ { "id": "d013243a-fdd7-4e11-95e9-8fb95805e0f7", "name": "Multiple records separated by `\\r\\n`. Each record: `statusCode|statusStr|cellphone|msgid`", "originalRequest": { "url": { "path": [ "sms_gw", "queryBulk.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Comma-separated phone numbers (count must match msgid)", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "(Required) Comma-separated message IDs", "type": "text/plain" }, "key": "msgid", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "Response format", "type": "text/plain" }, "key": "rtype", "value": "XML" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"result\": [\n {\n \"statusCode\": \"\",\n \"statusStr\": \"\",\n \"cellphone\": \"\",\n \"msgid\": \"\"\n },\n {\n \"statusCode\": \"\",\n \"statusStr\": \"\",\n \"cellphone\": \"\",\n \"msgid\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "queryPoint.aspx", "description": "", "item": [ { "id": "cecf3200-6cda-42df-846b-a918415ed84b", "name": "Query Remaining Points (GET) ⚠ Deprecated", "request": { "name": "Query Remaining Points (GET) ⚠ Deprecated", "description": { "content": "⚠ **Deprecated** — Use POST instead.\n\nRetrieve remaining SMS point balance.", "type": "text/plain" }, "url": { "path": [ "sms_gw", "queryPoint.aspx" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text, `JSON` for JSON, `XML` for XML. (This can only be one of JSON,XML)", "type": "text/plain" }, "key": "rtype", "value": "XML" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0f449f87-fb84-4a13-ad7b-dfb9a06af87d", "name": "Remaining points. Plain text returns a decimal number (e.g. `6220.0`).", "originalRequest": { "url": { "path": [ "sms_gw", "queryPoint.aspx" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text, `JSON` for JSON, `XML` for XML. (This can only be one of JSON,XML)", "type": "text/plain" }, "key": "rtype", "value": "XML" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"result\": [\n {\n \"statuscode\": \"\",\n \"point\": \"\"\n },\n {\n \"statuscode\": \"\",\n \"point\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2230b43d-02f8-4c42-994d-aa8bb4d20198", "name": "Query Remaining Points (POST)", "request": { "name": "Query Remaining Points (POST)", "description": { "content": "Retrieve remaining SMS point balance via POST. Accepts `application/x-www-form-urlencoded` or `application/json`.", "type": "text/plain" }, "url": { "path": [ "sms_gw", "queryPoint.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Response format: JSON / XML / (blank = plain text)", "type": "text/plain" }, "key": "rtype", "value": "XML" } ] }, "auth": null }, "response": [ { "id": "432a87e8-83df-452a-8ee8-56c64e08e8ad", "name": "Remaining points. Plain text: decimal number (e.g. `6220.0`).", "originalRequest": { "url": { "path": [ "sms_gw", "queryPoint.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Response format: JSON / XML / (blank = plain text)", "type": "text/plain" }, "key": "rtype", "value": "XML" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"result\": [\n {\n \"statuscode\": \"\",\n \"point\": \"\"\n },\n {\n \"statuscode\": \"\",\n \"point\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "moWebHook.aspx", "description": "", "item": [ { "id": "5aea754d-7430-496c-aa4a-49cddade7ecd", "name": "Set / Get / Clear MO Webhook", "request": { "name": "Set / Get / Clear MO Webhook", "description": { "content": "Register, retrieve, or remove the global MO (Mobile Originated) Webhook URL for your account.\n\nWhen an end-user replies to an SMS, SMSGO calls this URL via HTTP GET with the following query parameters:\n\n| Parameter | Description |\n|---|---|\n| `srcaddr` | Sender's mobile number |\n| `dstaddr` | Destination (virtual) number |\n| `smbody` | Reply message content (URL-encoded) |\n| `timestamp` | Received time (`yyMMddHHmmss`) |\n| `msgid` | Message identifier |\n\nThis is a global fallback webhook — it fires when no per-send `replyurl` was set for the matched send.", "type": "text/plain" }, "url": { "path": [ "sms_gw", "moWebHook.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Action: `set` saves the URL, `get` returns the current URL, `clear` removes it.", "type": "text/plain" }, "key": "action", "value": "set" }, { "disabled": false, "description": { "content": "Webhook URL to receive MO messages (required when `action=set`). Must start with `http://` or `https://`. Max 500 characters.", "type": "text/plain" }, "key": "webhookurl", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text.", "type": "text/plain" }, "key": "rtype", "value": "JSON" } ] }, "auth": null }, "response": [ { "id": "df80ee6c-6da3-4a86-bba2-98802e1d7ab0", "name": "MO Webhook result. `statuscode=0` means success.\n\n**Error Codes:**\n\n| Code | Description |\n|:---|:---|\n| `0` | Success |\n| `-2` | Username, password, or IP error |\n| `-3` | Username or password empty |\n| `-11` | Database error |\n| `-1` | Invalid URL format |", "originalRequest": { "url": { "path": [ "sms_gw", "moWebHook.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "Action: `set` saves the URL, `get` returns the current URL, `clear` removes it.", "type": "text/plain" }, "key": "action", "value": "set" }, { "disabled": false, "description": { "content": "Webhook URL to receive MO messages (required when `action=set`). Must start with `http://` or `https://`. Max 500 characters.", "type": "text/plain" }, "key": "webhookurl", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text.", "type": "text/plain" }, "key": "rtype", "value": "JSON" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"result\": [\n {\n \"statuscode\": \"\",\n \"webhookurl\": \"\"\n },\n {\n \"statuscode\": \"\",\n \"webhookurl\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "sendsmsCancel.aspx", "description": "", "item": [ { "id": "51f18d1f-82b9-4301-aa62-857eceba4204", "name": "Cancel Scheduled SMS (GET) ⚠ Deprecated", "request": { "name": "Cancel Scheduled SMS (GET) ⚠ Deprecated", "description": { "content": "⚠ **Deprecated** — Use POST instead.\n\nCancel a previously scheduled SMS that has not yet been sent.", "type": "text/plain" }, "url": { "path": [ "sms_gw", "sendsmsCancel.aspx" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Message ID of the scheduled SMS to cancel.", "type": "text/plain" }, "key": "msgid", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text, `JSON` for JSON, `XML` for XML. (This can only be one of JSON,XML)", "type": "text/plain" }, "key": "rtype", "value": "XML" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7dc42b83-69a5-4b41-b202-a9d40b6d15aa", "name": "Cancellation result. `0` = success.", "originalRequest": { "url": { "path": [ "sms_gw", "sendsmsCancel.aspx" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Message ID of the scheduled SMS to cancel.", "type": "text/plain" }, "key": "msgid", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text, `JSON` for JSON, `XML` for XML. (This can only be one of JSON,XML)", "type": "text/plain" }, "key": "rtype", "value": "XML" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "491fc7be-02eb-474a-aae9-13d8a1d90f67", "name": "Cancel Scheduled SMS (POST)", "request": { "name": "Cancel Scheduled SMS (POST)", "description": { "content": "Cancel a previously scheduled SMS that has not yet been sent. Accepts `application/x-www-form-urlencoded` or `application/json`.", "type": "text/plain" }, "url": { "path": [ "sms_gw", "sendsmsCancel.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Message ID to cancel", "type": "text/plain" }, "key": "msgid", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "Response format", "type": "text/plain" }, "key": "rtype", "value": "XML" } ] }, "auth": null }, "response": [ { "id": "3448b875-5c68-4076-acbb-7b69f5fedaf1", "name": "Cancellation result. `0` = success.", "originalRequest": { "url": { "path": [ "sms_gw", "sendsmsCancel.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Message ID to cancel", "type": "text/plain" }, "key": "msgid", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "Response format", "type": "text/plain" }, "key": "rtype", "value": "XML" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "verify.aspx", "description": "", "item": [ { "id": "7f2a1a6a-dcc4-451d-8dd5-3b07a33b4429", "name": "Send OTP Code (GET) ⚠ Deprecated", "request": { "name": "Send OTP Code (GET) ⚠ Deprecated", "description": { "content": "⚠ **Deprecated** — Use POST instead.\n\nSend a one-time password (OTP) to a mobile number.\n\n**OTP Flow Step 1/2:** Call this → save `msgid` from response → proceed to `/verifyAck.aspx`.", "type": "text/plain" }, "url": { "path": [ "sms_gw", "verify.aspx" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Recipient mobile number(s). Multiple numbers comma-separated (max 50). Domestic: 09xxxxxxxx. International: prefix with `+` URL-encoded as `%2b`, e.g. `%2b8613681912700`.", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "Length of the OTP verification code. Can be `4` or `6`. Default: `4`. (This can only be one of 4,6)", "type": "text/plain" }, "key": "codelength", "value": "4" }, { "disabled": false, "description": { "content": "Optional custom domain for iOS/Android OTP autofill (e.g., `shopee.tw`). Must be pre-approved.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Scheduled delivery time. Format: `YYYY/MM/DD hh24:mm:ss`. Leave blank to send immediately.", "type": "text/plain" }, "key": "dlvtime", "value": "" }, { "disabled": false, "description": { "content": "Callback URL for delivery status reports. System POSTs status updates to this URL. Leave blank to disable.", "type": "text/plain" }, "key": "response", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text, `JSON` for JSON, `XML` for XML. (This can only be one of JSON,XML)", "type": "text/plain" }, "key": "rtype", "value": "XML" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "ae006ab3-b2b5-4f0c-bb61-6c4b1eaeb0b2", "name": "API response. Format determined by `rtype` parameter. `statuscode=0` means success.\n\n**Error Codes:**\n\n| Code | Description |\n|:---|:---|\n| `0` | Success |\n| `-1` | CGI string error |\n| `-2` | Username, password, or IP error |\n| `-3` | Username or password empty |\n| `-5` | Phone number format error |\n| `-8` | Insufficient points |\n| `-9` | Too many recipients (max 50) |\n| `-10` | Send failed |\n| `-11` | Database error |\n| `-12` | Message body empty |\n| `-13` | Parameter count mismatch |\n| `-14` | Fraud keyword detected |\n| `-15` | IP address not allowed |\n| `-16` | API service not enabled |\n| `-17` | Callback URL not allowed |\n| `-18` | Off-net number |\n| `-19` | Number blocked |\n| `-20` | Marked as SPAM |\n| `-21` | Capacity reached |\n| `-22` | Request rerouted |\n| `-23` | No signature |\n| `-24` | OTP verification failed |\n| `-25` | OTP expired |\n| `-30` | Operator system ID error |", "originalRequest": { "url": { "path": [ "sms_gw", "verify.aspx" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Recipient mobile number(s). Multiple numbers comma-separated (max 50). Domestic: 09xxxxxxxx. International: prefix with `+` URL-encoded as `%2b`, e.g. `%2b8613681912700`.", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "Length of the OTP verification code. Can be `4` or `6`. Default: `4`. (This can only be one of 4,6)", "type": "text/plain" }, "key": "codelength", "value": "4" }, { "disabled": false, "description": { "content": "Optional custom domain for iOS/Android OTP autofill (e.g., `shopee.tw`). Must be pre-approved.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Scheduled delivery time. Format: `YYYY/MM/DD hh24:mm:ss`. Leave blank to send immediately.", "type": "text/plain" }, "key": "dlvtime", "value": "" }, { "disabled": false, "description": { "content": "Callback URL for delivery status reports. System POSTs status updates to this URL. Leave blank to disable.", "type": "text/plain" }, "key": "response", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text, `JSON` for JSON, `XML` for XML. (This can only be one of JSON,XML)", "type": "text/plain" }, "key": "rtype", "value": "XML" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": {\n \"msgid\": \"\",\n \"statuscode\": \"\",\n \"statusstr\": \"\",\n \"point\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9a698fd2-1d06-4777-8e15-d174dc2b86c4", "name": "Send OTP Code (POST)", "request": { "name": "Send OTP Code (POST)", "description": { "content": "Send a one-time password (OTP) to a mobile number. Accepts `application/x-www-form-urlencoded` or `application/json`.\n\n**OTP Flow Step 1/2:** Call this → save `msgid` from response → user enters code → call `/verifyAck.aspx` with `serial_number=msgid`.", "type": "text/plain" }, "url": { "path": [ "sms_gw", "verify.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Recipient phone number", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "OTP length: 4 or 6", "type": "text/plain" }, "key": "codelength", "value": "4" }, { "disabled": false, "description": { "content": "Optional custom domain for iOS/Android OTP autofill.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Scheduled time: YYYY/MM/DD hh24:mm:ss", "type": "text/plain" }, "key": "dlvtime", "value": "" }, { "disabled": false, "description": { "content": "Status callback URL", "type": "text/plain" }, "key": "response", "value": "" }, { "disabled": false, "description": { "content": "Response format", "type": "text/plain" }, "key": "rtype", "value": "JSON" } ] }, "auth": null }, "response": [ { "id": "fe16d701-b772-4e0d-a0fe-2f43ddcc197b", "name": "API response. Format determined by `rtype` parameter. `statuscode=0` means success.\n\n**Error Codes:**\n\n| Code | Description |\n|:---|:---|\n| `0` | Success |\n| `-1` | CGI string error |\n| `-2` | Username, password, or IP error |\n| `-3` | Username or password empty |\n| `-5` | Phone number format error |\n| `-8` | Insufficient points |\n| `-9` | Too many recipients (max 50) |\n| `-10` | Send failed |\n| `-11` | Database error |\n| `-12` | Message body empty |\n| `-13` | Parameter count mismatch |\n| `-14` | Fraud keyword detected |\n| `-15` | IP address not allowed |\n| `-16` | API service not enabled |\n| `-17` | Callback URL not allowed |\n| `-18` | Off-net number |\n| `-19` | Number blocked |\n| `-20` | Marked as SPAM |\n| `-21` | Capacity reached |\n| `-22` | Request rerouted |\n| `-23` | No signature |\n| `-24` | OTP verification failed |\n| `-25` | OTP expired |\n| `-30` | Operator system ID error |", "originalRequest": { "url": { "path": [ "sms_gw", "verify.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) Recipient phone number", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "OTP length: 4 or 6", "type": "text/plain" }, "key": "codelength", "value": "4" }, { "disabled": false, "description": { "content": "Optional custom domain for iOS/Android OTP autofill.", "type": "text/plain" }, "key": "domain", "value": "" }, { "disabled": false, "description": { "content": "Scheduled time: YYYY/MM/DD hh24:mm:ss", "type": "text/plain" }, "key": "dlvtime", "value": "" }, { "disabled": false, "description": { "content": "Status callback URL", "type": "text/plain" }, "key": "response", "value": "" }, { "disabled": false, "description": { "content": "Response format", "type": "text/plain" }, "key": "rtype", "value": "JSON" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": {\n \"msgid\": \"\",\n \"statuscode\": \"\",\n \"statusstr\": \"\",\n \"point\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "sendsmscustom.aspx", "description": "", "item": [ { "id": "05369949-863e-47e4-8230-608eb2dfdb54", "name": "Send Personalized Bulk SMS", "request": { "name": "Send Personalized Bulk SMS", "description": { "content": "Send a batch of SMS messages where each recipient receives a unique message body.\n\nAccepts three input modes (auto-detected from `Content-Type`):\n\n| Mode | Content-Type | How to pass data |\n|---|---|---|\n| JSON array | `application/json` | `messages` array of `{dstaddr, smbody}` objects |\n| JSON CSV | `application/json` | `csv` string field |\n| Form CSV | `application/x-www-form-urlencoded` | `csv` string field |\n| File upload | `multipart/form-data` | `csv` file field (UTF-8 or BIG5/CP950) |\n\n**CSV format:** one `mobile,message` per line. Only the first comma splits the columns, so commas in the message are safe. Lines starting with `#` are ignored.\n\n> ⚠️ This endpoint is intended for internal/MCP use and does not require IP whitelisting.", "type": "text/plain" }, "url": { "path": [ "sms_gw", "sendsmscustom.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"password\": \"\",\n \"csv\": \"\",\n \"messages\": [\n {\n \"dstaddr\": \"\",\n \"smbody\": \"\"\n },\n {\n \"dstaddr\": \"\",\n \"smbody\": \"\"\n }\n ],\n \"encoding\": \"BIG5\",\n \"dlvtime\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "eeab119f-7c47-4833-a839-42175280750e", "name": "Batch send result. `statuscode=0` means all sent. `statuscode=1` means partial. `statuscode=-10` means all failed.", "originalRequest": { "url": { "path": [ "sms_gw", "sendsmscustom.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"username\": \"\",\n \"password\": \"\",\n \"csv\": \"\",\n \"messages\": [\n {\n \"dstaddr\": \"\",\n \"smbody\": \"\"\n },\n {\n \"dstaddr\": \"\",\n \"smbody\": \"\"\n }\n ],\n \"encoding\": \"BIG5\",\n \"dlvtime\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"statuscode\": \"\",\n \"statusstr\": \"\",\n \"total\": \"\",\n \"sent\": \"\",\n \"failed\": \"\",\n \"results\": [\n {\n \"seq\": \"\",\n \"dstaddr\": \"\",\n \"statuscode\": \"\",\n \"statusstr\": \"\",\n \"msgid\": \"\",\n \"point\": \"\"\n },\n {\n \"seq\": \"\",\n \"dstaddr\": \"\",\n \"statuscode\": \"\",\n \"statusstr\": \"\",\n \"msgid\": \"\",\n \"point\": \"\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "verifyAck.aspx", "description": "", "item": [ { "id": "0b68e156-7b1d-44ee-ad66-b41ab4cb7309", "name": "Verify OTP Code (GET) ⚠ Deprecated", "request": { "name": "Verify OTP Code (GET) ⚠ Deprecated", "description": { "content": "⚠ **Deprecated** — Use POST instead.\n\n**OTP Flow Step 2/2:** Validate the code entered by the user.", "type": "text/plain" }, "url": { "path": [ "sms_gw", "verifyAck.aspx" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Recipient mobile number(s). Multiple numbers comma-separated (max 50). Domestic: 09xxxxxxxx. International: prefix with `+` URL-encoded as `%2b`, e.g. `%2b8613681912700`.", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "(Required) The OTP code entered by the user (4 or 6 digits).", "type": "text/plain" }, "key": "OtpCode", "value": "3781" }, { "disabled": false, "description": { "content": "(Required) The `msgid` returned from the Send OTP (`/verify.aspx`) request.", "type": "text/plain" }, "key": "serial_number", "value": "" }, { "disabled": false, "description": { "content": "Set to `true` to automatically resend a new OTP if the current one has expired (statuscode `-25`).", "type": "text/plain" }, "key": "resend", "value": "" }, { "disabled": false, "description": { "content": "Scheduled delivery time. Format: `YYYY/MM/DD hh24:mm:ss`. Leave blank to send immediately.", "type": "text/plain" }, "key": "dlvtime", "value": "" }, { "disabled": false, "description": { "content": "Callback URL for delivery status reports. System POSTs status updates to this URL. Leave blank to disable.", "type": "text/plain" }, "key": "response", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text, `JSON` for JSON, `XML` for XML. (This can only be one of JSON,XML)", "type": "text/plain" }, "key": "rtype", "value": "XML" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "fd9150bc-4701-44f0-b1bc-545bebe19637", "name": "API response. Format determined by `rtype` parameter. `statuscode=0` means success.\n\n**Error Codes:**\n\n| Code | Description |\n|:---|:---|\n| `0` | Success |\n| `-1` | CGI string error |\n| `-2` | Username, password, or IP error |\n| `-3` | Username or password empty |\n| `-5` | Phone number format error |\n| `-8` | Insufficient points |\n| `-9` | Too many recipients (max 50) |\n| `-10` | Send failed |\n| `-11` | Database error |\n| `-12` | Message body empty |\n| `-13` | Parameter count mismatch |\n| `-14` | Fraud keyword detected |\n| `-15` | IP address not allowed |\n| `-16` | API service not enabled |\n| `-17` | Callback URL not allowed |\n| `-18` | Off-net number |\n| `-19` | Number blocked |\n| `-20` | Marked as SPAM |\n| `-21` | Capacity reached |\n| `-22` | Request rerouted |\n| `-23` | No signature |\n| `-24` | OTP verification failed |\n| `-25` | OTP expired |\n| `-30` | Operator system ID error |", "originalRequest": { "url": { "path": [ "sms_gw", "verifyAck.aspx" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Recipient mobile number(s). Multiple numbers comma-separated (max 50). Domestic: 09xxxxxxxx. International: prefix with `+` URL-encoded as `%2b`, e.g. `%2b8613681912700`.", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "(Required) The OTP code entered by the user (4 or 6 digits).", "type": "text/plain" }, "key": "OtpCode", "value": "3781" }, { "disabled": false, "description": { "content": "(Required) The `msgid` returned from the Send OTP (`/verify.aspx`) request.", "type": "text/plain" }, "key": "serial_number", "value": "" }, { "disabled": false, "description": { "content": "Set to `true` to automatically resend a new OTP if the current one has expired (statuscode `-25`).", "type": "text/plain" }, "key": "resend", "value": "" }, { "disabled": false, "description": { "content": "Scheduled delivery time. Format: `YYYY/MM/DD hh24:mm:ss`. Leave blank to send immediately.", "type": "text/plain" }, "key": "dlvtime", "value": "" }, { "disabled": false, "description": { "content": "Callback URL for delivery status reports. System POSTs status updates to this URL. Leave blank to disable.", "type": "text/plain" }, "key": "response", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text, `JSON` for JSON, `XML` for XML. (This can only be one of JSON,XML)", "type": "text/plain" }, "key": "rtype", "value": "XML" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/plain" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": {\n \"msgid\": \"\",\n \"statuscode\": \"\",\n \"statusstr\": \"\",\n \"point\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "aada06ab-fa2f-495a-a516-80138699e238", "name": "Verify OTP Code (POST)", "request": { "name": "Verify OTP Code (POST)", "description": { "content": "**OTP Flow Step 2/2:** Validate the OTP code entered by the user. Accepts `application/x-www-form-urlencoded` or `application/json`.\n\n- `serial_number` = `msgid` from the Send OTP response\n- `OtpCode` = 4 or 6 digit code the user received\n- statuscode `-24` = wrong code, `-25` = expired (set `resend=true` to auto-resend)", "type": "text/plain" }, "url": { "path": [ "sms_gw", "verifyAck.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) OTP code entered by user", "type": "text/plain" }, "key": "OtpCode", "value": "102629" }, { "disabled": false, "description": { "content": "(Required) Recipient phone number", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) msgid from Send OTP response", "type": "text/plain" }, "key": "serial_number", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "Resend new OTP if expired (statuscode -25)", "type": "text/plain" }, "key": "resend", "value": "" }, { "disabled": false, "description": { "content": "Resend scheduled time", "type": "text/plain" }, "key": "dlvtime", "value": "" }, { "disabled": false, "description": { "content": "Resend status callback URL", "type": "text/plain" }, "key": "response", "value": "" }, { "disabled": false, "description": { "content": "Response format", "type": "text/plain" }, "key": "rtype", "value": "XML" } ] }, "auth": null }, "response": [ { "id": "ca0783d2-dd81-43d3-a79c-fb313bec7066", "name": "API response. Format determined by `rtype` parameter. `statuscode=0` means success.\n\n**Error Codes:**\n\n| Code | Description |\n|:---|:---|\n| `0` | Success |\n| `-1` | CGI string error |\n| `-2` | Username, password, or IP error |\n| `-3` | Username or password empty |\n| `-5` | Phone number format error |\n| `-8` | Insufficient points |\n| `-9` | Too many recipients (max 50) |\n| `-10` | Send failed |\n| `-11` | Database error |\n| `-12` | Message body empty |\n| `-13` | Parameter count mismatch |\n| `-14` | Fraud keyword detected |\n| `-15` | IP address not allowed |\n| `-16` | API service not enabled |\n| `-17` | Callback URL not allowed |\n| `-18` | Off-net number |\n| `-19` | Number blocked |\n| `-20` | Marked as SPAM |\n| `-21` | Capacity reached |\n| `-22` | Request rerouted |\n| `-23` | No signature |\n| `-24` | OTP verification failed |\n| `-25` | OTP expired |\n| `-30` | Operator system ID error |", "originalRequest": { "url": { "path": [ "sms_gw", "verifyAck.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) OTP code entered by user", "type": "text/plain" }, "key": "OtpCode", "value": "102629" }, { "disabled": false, "description": { "content": "(Required) Recipient phone number", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) msgid from Send OTP response", "type": "text/plain" }, "key": "serial_number", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "Resend new OTP if expired (statuscode -25)", "type": "text/plain" }, "key": "resend", "value": "" }, { "disabled": false, "description": { "content": "Resend scheduled time", "type": "text/plain" }, "key": "dlvtime", "value": "" }, { "disabled": false, "description": { "content": "Resend status callback URL", "type": "text/plain" }, "key": "response", "value": "" }, { "disabled": false, "description": { "content": "Response format", "type": "text/plain" }, "key": "rtype", "value": "XML" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": {\n \"msgid\": \"\",\n \"statuscode\": \"\",\n \"statusstr\": \"\",\n \"point\": \"\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "queryReply.aspx", "description": "", "item": [ { "id": "105e56ef-5f34-4bf4-9b67-ff953605dd1e", "name": "Query SMS Replies (POST)", "request": { "name": "Query SMS Replies (POST)", "description": { "content": "Retrieve inbound reply messages sent by recipients within a date range. Accepts `application/x-www-form-urlencoded` or `application/json`.", "type": "text/plain" }, "url": { "path": [ "sms_gw", "queryReply.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) End of date range. Format: `YYYY/MM/DD`.", "type": "text/plain" }, "key": "enddate", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Start of date range. Format: `YYYY/MM/DD`.", "type": "text/plain" }, "key": "startdate", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text.", "type": "text/plain" }, "key": "rtype", "value": "JSON" } ] }, "auth": null }, "response": [ { "id": "6ed0abdc-0155-4c2a-826d-3e17fb5695cb", "name": "List of reply messages.", "originalRequest": { "url": { "path": [ "sms_gw", "queryReply.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) End of date range. Format: `YYYY/MM/DD`.", "type": "text/plain" }, "key": "enddate", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Start of date range. Format: `YYYY/MM/DD`.", "type": "text/plain" }, "key": "startdate", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text.", "type": "text/plain" }, "key": "rtype", "value": "JSON" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"result\": [\n {\n \"srcaddr\": \"\",\n \"dstaddr\": \"\",\n \"recvtime\": \"\",\n \"sendtime\": \"\",\n \"smbody\": \"\"\n },\n {\n \"srcaddr\": \"\",\n \"dstaddr\": \"\",\n \"recvtime\": \"\",\n \"sendtime\": \"\",\n \"smbody\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "querySentList.aspx", "description": "", "item": [ { "id": "0603852a-2017-4d72-a05a-8f077d835ba1", "name": "Query Sent Message List (POST)", "request": { "name": "Query Sent Message List (POST)", "description": { "content": "Retrieve a paginated list of sent messages within a date range (max 31 days). Accepts `application/x-www-form-urlencoded` or `application/json`.", "type": "text/plain" }, "url": { "path": [ "sms_gw", "querySentList.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) End of send date range. Format: `YYYY/MM/DD`. Max range: 31 days.", "type": "text/plain" }, "key": "enddate", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Start of send date range. Format: `YYYY/MM/DD`.", "type": "text/plain" }, "key": "startdate", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "Optional filter by recipient phone number.", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "Page number for pagination. Default: `1`.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Records per page. Default: `50`. Max: `200`.", "type": "text/plain" }, "key": "pagesize", "value": "50" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text.", "type": "text/plain" }, "key": "rtype", "value": "XML" } ] }, "auth": null }, "response": [ { "id": "f027ed08-4658-43d5-afd0-e6d23daf4a37", "name": "Paginated list of sent messages.", "originalRequest": { "url": { "path": [ "sms_gw", "querySentList.aspx" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/x-www-form-urlencoded" }, { "key": "Accept", "value": "text/plain" } ], "method": "POST", "body": { "mode": "urlencoded", "urlencoded": [ { "disabled": false, "description": { "content": "(Required) End of send date range. Format: `YYYY/MM/DD`. Max range: 31 days.", "type": "text/plain" }, "key": "enddate", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member password or API Key", "type": "text/plain" }, "key": "password", "value": "" }, { "disabled": false, "description": { "content": "(Required) Start of send date range. Format: `YYYY/MM/DD`.", "type": "text/plain" }, "key": "startdate", "value": "" }, { "disabled": false, "description": { "content": "(Required) Member account username", "type": "text/plain" }, "key": "username", "value": "" }, { "disabled": false, "description": { "content": "Optional filter by recipient phone number.", "type": "text/plain" }, "key": "dstaddr", "value": "" }, { "disabled": false, "description": { "content": "Page number for pagination. Default: `1`.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Records per page. Default: `50`. Max: `200`.", "type": "text/plain" }, "key": "pagesize", "value": "50" }, { "disabled": false, "description": { "content": "Response format. Omit for plain text.", "type": "text/plain" }, "key": "rtype", "value": "XML" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"results\": {\n \"page\": \"\",\n \"pagesize\": \"\",\n \"totalcount\": \"\",\n \"totalpages\": \"\",\n \"result\": [\n {\n \"msgid\": \"\",\n \"dstaddr\": \"\",\n \"sendtime\": \"\",\n \"smbody\": \"\",\n \"statuscode\": \"\",\n \"statusstr\": \"\"\n },\n {\n \"msgid\": \"\",\n \"dstaddr\": \"\",\n \"sendtime\": \"\",\n \"smbody\": \"\",\n \"statuscode\": \"\",\n \"statusstr\": \"\"\n }\n ]\n }\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://www.smsgo.com.tw" } ], "info": { "_postman_id": "6e83cbf1-62aa-4eec-99d3-3821eec1065b", "name": "SMSGO SMS Gateway API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "Send SMS messages through the SMSGO platform via HTTP POST.\n\n---\n\n**Key Features:**\n\n- **Multiple Encodings:** `BIG5` (Traditional Chinese), `ASCII`, `UCS2` (Unicode).\n- **Long SMS:** Up to 335 characters.\n- **WAP Push:** Send links to mobile devices.\n- **Scheduled Delivery:** Schedule future sends.\n- **Callbacks:** Webhooks for delivery status and user replies.\n\n---\n\n**Notes:**\n\n1. `BIG5`/`ASCII`/`UCS2` support single SMS only. Messages exceeding the limit are auto-truncated.\n2. `PBIG5`/`PASCII` are POPUP. `LBIG5`/`LASCII`/`LUCS2` are long SMS (max 335 Chinese chars).\n3. For `PUSH`, `smbody`+`wapurl` combined must be ≤ 88 bytes (Chinese chars count as 3 bytes).\n4. Setting `replyurl` enables SMS reply at +1 point per 10 messages (max URL length: 300 chars).\n5. International SMS: only `BIG5`/`ASCII`/`UCS2`. Use `UCS2` for Simplified Chinese.\n> ⚠️ **Important:** To use this API, you will need to contact customer support to enable it.\n\n---\n\n**Contact:**\n\n- 💬 LINE: [@cdn4573o](https://line.me/R/ti/p/@cdn4573o)\n\nContact Support:\n Name: SMSGO Support", "type": "text/plain" } } }