{"note":"OpenAPI conversion -- returning structured metadata","name":"winsms-co-za","description":"WINSMS","version":"1.0.0","base_url":"https://api.winsms.co.za/api/rest/v1","endpoints":11,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api WINSMS\n@base https://api.winsms.co.za/api/rest/v1\n@version 1.0.0\n@auth ApiKey AUTHORIZATION in header\n@endpoints 11\n@toc credits(2), sms(7), shortcode(1), subaccounts(1)\n\n@group credits\n@endpoint GET /credits/balance\n@desc Get your current WinSMS credit balance\n@returns(200) OK\n@errors {401: Unauthorized, 404: Not found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endpoint POST /credits/transfer\n@desc Transfer credits between main and sub accounts.\n@required {creditTransferDetails: map # The details of the credit transfer. Sender account number, recipient account number, and number of credits to transfer.}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 404: Not found, 405: Method Not Allowed, 413: Payload Too Large, 415: Unsupported Media Type, 422: Unprocessable Entity, 500: Internal Server Error}\n\n@endgroup\n\n@group sms\n@endpoint POST /sms/outgoing/send\n@desc Send SMS messages\n@required {newMessageDetails: map # The message, recipients and delivery options of an SMS message to be sent.}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 404: Not found, 405: Method Not Allowed, 413: Payload Too Large, 415: Unsupported Media Type, 422: Unprocessable Entity, 500: Internal Server Error}\n\n@endpoint POST /sms/outgoing/sendmulti\n@desc Send multiple different SMS messages\n@required {multiMessageDetails: map # The messages, recipients and delivery options of multiple SMS messages to be sent.}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 404: Not found, 405: Method Not Allowed, 413: Payload Too Large, 415: Unsupported Media Type, 422: Unprocessable Entity, 500: Internal Server Error}\n\n@endpoint POST /sms/outgoing/status\n@desc Get SMS delivery statuses\n@required {messageStatusRequest: [int] # An array of WinSMS API Ids received after submitting messages to the ***/sms/outgoing/send*** endpoint.  A maximum of 1000 API Ids can be supplied in a single request.}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 404: Not found, 405: Method Not Allowed, 413: Payload Too Large, 415: Unsupported Media Type, 422: Unprocessable Entity, 500: Internal Server Error}\n\n@endpoint GET /sms/scheduled\n@desc Get a list of scheduled SMS messages\n@optional {offset: any # ***Optional*** - The number of items to skip before starting to return results. Default 0. Minimum 0., limit: any # ***Optional*** - The number of items to return. Default 100. Minimum 1. Maximum 1000.}\n@returns(200) OK\n@errors {401: Unauthorized, 404: Not found, 405: Method Not Allowed, 422: Unprocessable Entity, 500: Internal Server Error}\n\n@endpoint POST /sms/scheduled/delete\n@desc Delete scheduled SMS messages and refund credits\n@required {messageDeleteRequest: [int] # An array of WinSMS API Ids received after submitting scheduled messages to the ***/sms/outgoing/send*** endpoint. A maximum of 1000 API Ids can be supplied in a single request.}\n@returns(200) OK\n@errors {400: Bad Request, 401: Unauthorized, 404: Not found, 405: Method Not Allowed, 413: Payload Too Large, 415: Unsupported Media Type, 422: Unprocessable Entity, 500: Internal Server Error}\n\n@endpoint GET /sms/incoming\n@desc Get a list of incoming SMS messages\n@optional {offset: any # ***Optional*** - The number of items to skip before starting to return results. Default 0. Minimum 0., limit: any # ***Optional*** - The number of items to return. Default 100. Minimum 1. Maximum 1000.}\n@returns(200) OK\n@errors {401: Unauthorized, 404: Not found, 405: Method Not Allowed, 422: Unprocessable Entity, 500: Internal Server Error}\n\n@endpoint GET /sms/incoming/optout\n@desc Get a list of incoming opt-out SMS messages\n@returns(200) OK\n@errors {401: Unauthorized, 404: Not found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endgroup\n\n@group shortcode\n@endpoint GET /shortcode/incoming\n@desc Get a list of incoming short/long code messages\n@optional {offset: any # ***Optional*** - The number of items to skip before starting to return results. Default 0. Minimum 0., limit: any # ***Optional*** - The number of items to return. Default 100. Minimum 1. Maximum 1000.}\n@returns(200) OK\n@errors {401: Unauthorized, 404: Not found, 405: Method Not Allowed, 422: Unprocessable Entity, 500: Internal Server Error}\n\n@endgroup\n\n@group subaccounts\n@endpoint GET /subaccounts\n@desc Get a list of all Sub Accounts.\n@returns(200) OK\n@errors {401: Unauthorized, 404: Not found, 405: Method Not Allowed, 500: Internal Server Error}\n\n@endgroup\n\n@end\n"}