{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:winsms-co-za/get-credit-balance":{"get":{"operationId":"communication_winsms_co_za_get_credit_balance","summary":"Get your current WinSMS credit balance","description":"GET /credits/balance","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:winsms-co-za/transfer-credits":{"post":{"operationId":"communication_winsms_co_za_transfer_credits","summary":"Transfer credits between main and sub accounts.","description":"POST /credits/transfer","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:winsms-co-za/get-short-code-messages":{"get":{"operationId":"communication_winsms_co_za_get_short_code_messages","summary":"Get a list of incoming short/long code messages","description":"GET /shortcode/incoming","tags":["communication"],"parameters":[{"name":"offset","in":"query","required":false,"description":"***Optional*** - The number of items to skip before starting to return results. Default 0. Minimum 0.","schema":{"type":"integer","default":0,"description":"***Optional*** - The number of items to skip before starting to return results. Default 0. Minimum 0."}},{"name":"limit","in":"query","required":false,"description":"***Optional*** - The number of items to return. Default 100. Minimum 1. Maximum 1000.","schema":{"type":"integer","default":100,"description":"***Optional*** - The number of items to return. Default 100. Minimum 1. Maximum 1000."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:winsms-co-za/get-incoming-messages":{"get":{"operationId":"communication_winsms_co_za_get_incoming_messages","summary":"Get a list of incoming SMS messages","description":"GET /sms/incoming","tags":["communication"],"parameters":[{"name":"offset","in":"query","required":false,"description":"***Optional*** - The number of items to skip before starting to return results. Default 0. Minimum 0.","schema":{"type":"integer","default":0,"description":"***Optional*** - The number of items to skip before starting to return results. Default 0. Minimum 0."}},{"name":"limit","in":"query","required":false,"description":"***Optional*** - The number of items to return. Default 100. Minimum 1. Maximum 1000.","schema":{"type":"integer","default":100,"description":"***Optional*** - The number of items to return. Default 100. Minimum 1. Maximum 1000."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:winsms-co-za/get-optout-messages":{"get":{"operationId":"communication_winsms_co_za_get_optout_messages","summary":"Get a list of incoming opt-out SMS messages","description":"GET /sms/incoming/optout","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:winsms-co-za/sms-send":{"post":{"operationId":"communication_winsms_co_za_sms_send","summary":"Send SMS messages","description":"POST /sms/outgoing/send","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:winsms-co-za/sms-send-batch":{"post":{"operationId":"communication_winsms_co_za_sms_send_batch","summary":"Send multiple different SMS messages","description":"POST /sms/outgoing/sendmulti","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:winsms-co-za/sms-status":{"post":{"operationId":"communication_winsms_co_za_sms_status","summary":"Get SMS delivery statuses","description":"POST /sms/outgoing/status","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:winsms-co-za/get-scheduled-messages":{"get":{"operationId":"communication_winsms_co_za_get_scheduled_messages","summary":"Get a list of scheduled SMS messages","description":"GET /sms/scheduled","tags":["communication"],"parameters":[{"name":"offset","in":"query","required":false,"description":"***Optional*** - The number of items to skip before starting to return results. Default 0. Minimum 0.","schema":{"type":"integer","default":0,"description":"***Optional*** - The number of items to skip before starting to return results. Default 0. Minimum 0."}},{"name":"limit","in":"query","required":false,"description":"***Optional*** - The number of items to return. Default 100. Minimum 1. Maximum 1000.","schema":{"type":"integer","default":100,"description":"***Optional*** - The number of items to return. Default 100. Minimum 1. Maximum 1000."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:winsms-co-za/delete-scheduled-messages":{"post":{"operationId":"communication_winsms_co_za_delete_scheduled_messages","summary":"Delete scheduled SMS messages and refund credits","description":"POST /sms/scheduled/delete","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:winsms-co-za/get-sub-accounts":{"get":{"operationId":"communication_winsms_co_za_get_sub_accounts","summary":"Get a list of all Sub Accounts.","description":"GET /subaccounts","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}