{ "origin": "https://api.szybkisms.pl", "schema_version": 2, "language": "en", "scope": "REST API; public guidance by problem type, diagnostic codes are not a public cause registry; current response type URIs use the provider registry", "types": [ { "current_uri": "https://api.szybkisms.pl/problems/not-found/", "slug": "not-found", "cases": [ { "status": 404, "detail": "The requested endpoint was not found.", "dynamic": false, "action": "Check the endpoint URL and the /rest or /rest-sandbox prefix.", "endpoints": [ "Any REST endpoint" ], "transport": "Whole request failure", "anchor": "case-1" }, { "status": 404, "detail": "No subaccount was found with the provided user_login.", "dynamic": false, "action": "Check user_login and whether the user belongs to the current account.", "endpoints": [ "GET /rest/account", "GET /rest/account/{user_login}" ], "transport": "Whole request failure", "anchor": "case-2" }, { "status": 404, "detail": "The requested page was not found in your outgoing message history.", "dynamic": false, "action": "Choose an existing page of outgoing message history.", "endpoints": [ "GET /rest/messages", "GET /rest/messages/{ids}" ], "transport": "Whole request failure", "anchor": "case-3" }, { "status": 404, "detail": "No outgoing messages were found with the provided IDs.", "dynamic": false, "action": "Check the environment and the outgoing message IDs available to the account.", "endpoints": [ "DELETE /rest/messages/{ids}", "GET /rest/messages/{ids}" ], "transport": "Whole request failure", "anchor": "case-4" }, { "status": 404, "detail": "The requested page was not found in your incoming message inbox.", "dynamic": false, "action": "Choose an existing page of the incoming message inbox.", "endpoints": [ "GET /rest/incoming", "GET /rest/incoming/{ids}" ], "transport": "Whole request failure", "anchor": "case-5" }, { "status": 404, "detail": "No incoming messages were found with the provided IDs.", "dynamic": false, "action": "Check the incoming message IDs and their availability to the account.", "endpoints": [ "GET /rest/incoming/{ids}", "DELETE /rest/incoming/{ids}" ], "transport": "Whole request failure", "anchor": "case-6" }, { "status": 404, "detail": "The sender name is not defined on your account.", "dynamic": false, "action": "Retrieve GET /rest/senders and choose a sender name assigned to the account.", "endpoints": [ "DELETE /rest/senders/{sender}", "PATCH /rest/senders/{sender}" ], "transport": "Whole request failure", "anchor": "case-7" }, { "status": 404, "detail": "No incoming message was found with the provided ID.", "dynamic": false, "action": "Check the ID of the incoming message to delete.", "endpoints": [ "DELETE /rest/incoming/{ids}" ], "transport": "Batch item · HTTP 200", "anchor": "case-8" }, { "status": 404, "detail": "No outgoing message was found with the provided ID.", "dynamic": false, "action": "Check the outgoing message ID and its availability to the account before cancellation.", "endpoints": [ "DELETE /rest/messages/{ids}" ], "transport": "Batch item · HTTP 200", "anchor": "case-9" } ], "title": "Not Found", "label": "Resource not found", "group": "Resources", "summary": "The endpoint, message, page or sender is not available for this account.", "steps": [ "Check the endpoint and environment: /rest and /rest-sandbox have separate data.", "Use IDs belonging to the current account and accessible to the user associated with the token.", "For collections, check the page number. An empty collection returns HTTP 200 with an empty array; a page outside a nonempty collection returns HTTP 404." ], "note": "This type indicates HTTP 404. Interpret it together with the endpoint and instance.", "path": "/problems/not-found/", "uri": "https://api.szybkisms.pl/problems/not-found/", "statuses": [ 404 ], "example": { "type": "https://api.szybkisms.pl/problems/not-found/", "status": 404, "title": "Not Found", "detail": "The requested endpoint was not found.", "code": "404-1", "instance": "/rest/messages/sms" } }, { "current_uri": "https://api.szybkisms.pl/problems/server-error/", "slug": "server-error", "cases": [ { "status": 500, "detail": "An internal server error occurred.", "dynamic": false, "action": "Save code, the endpoint and request time. Check the operation result before retrying; contact support if the failure persists.", "endpoints": [ "GET /rest/account", "GET /rest/account/{user_login}", "DELETE /rest/messages/{ids}", "GET /rest/incoming", "GET /rest/incoming/{ids}", "DELETE /rest/incoming/{ids}", "POST /rest/messages/mms/price", "POST /rest/messages/sms/price", "POST /rest/messages/mms", "POST /rest/messages/sms", "GET /rest/senders", "POST /rest/senders", "DELETE /rest/senders/{sender}", "PATCH /rest/senders/{sender}", "GET /rest/messages", "GET /rest/messages/{ids}", "Any REST endpoint", "Authenticated REST endpoints" ], "transport": "Whole request failure", "anchor": "case-1" }, { "status": 500, "detail": "An internal server error occurred.", "dynamic": false, "action": "Save code, the endpoint and request time. Check the operation result before retrying; contact support if the failure persists.", "endpoints": [ "DELETE /rest/messages/{ids}", "DELETE /rest/incoming/{ids}" ], "transport": "Batch item · HTTP 200", "anchor": "case-2" } ], "title": "Internal API Server Error", "label": "Internal server error", "group": "System", "summary": "An internal server error occurred while processing the operation.", "steps": [ "Save the request time, endpoint and code so support can locate the event.", "After a sending failure, check message history before retrying: HTTP 500 alone does not confirm whether the operation was completed.", "Retry read requests with increasing delays. Contact support if the failure persists." ], "note": "The detail field contains the generic message An internal server error occurred. Technical diagnostics remain in server logs; provide code to support. In a batch, status 500 can apply to an individual item within an HTTP 200 response.", "path": "/problems/server-error/", "uri": "https://api.szybkisms.pl/problems/server-error/", "statuses": [ 500 ], "example": { "type": "https://api.szybkisms.pl/problems/server-error/", "status": 500, "title": "Internal API Server Error", "detail": "An internal server error occurred.", "code": "500-14", "instance": "/rest/messages/sms" } }, { "current_uri": "https://api.szybkisms.pl/problems/unauthorized/", "slug": "unauthorized", "cases": [ { "status": 401, "detail": "Authorization token is missing or invalid.", "dynamic": false, "action": "Send the current token for the correct API account in one Authorization: Bearer header, without extra prefixes or a list of tokens.", "endpoints": [ "Authenticated REST endpoints", "Any REST endpoint" ], "transport": "Whole request failure", "anchor": "case-1" } ], "title": "Unauthorized", "label": "Authentication failed", "group": "Access", "summary": "The API token is missing or cannot be used to authenticate the request.", "steps": [ "Send the current API account token in Authorization: Bearer .", "Check whether the token has been replaced and whether you are using the correct API account.", "Retry after updating the credentials. Do not repeatedly submit the same invalid token." ], "note": "The Bearer scheme name is case-insensitive: bearer and BEARER are also accepted. Keep the token unchanged and send one Authorization header with one token. HTTP 401 includes WWW-Authenticate: Bearer. Different authentication failures can have the same public description. Replacing the token alone does not resolve HTTP 403 permission failures.", "path": "/problems/unauthorized/", "uri": "https://api.szybkisms.pl/problems/unauthorized/", "statuses": [ 401 ], "example": { "type": "https://api.szybkisms.pl/problems/unauthorized/", "status": 401, "title": "Unauthorized", "detail": "Authorization token is missing or invalid.", "code": "401-1", "instance": "/rest/messages/sms" } }, { "current_uri": "https://api.szybkisms.pl/problems/forbidden/", "slug": "forbidden", "cases": [ { "status": 403, "detail": "Your account has not been activated yet.", "dynamic": false, "action": "Complete user account activation.", "endpoints": [ "Authenticated REST endpoints" ], "transport": "Whole request failure", "anchor": "case-1" }, { "status": 403, "detail": "Your account has not been verified by the operator yet.", "dynamic": false, "action": "Wait for the operator to verify your account.", "endpoints": [ "Authenticated REST endpoints" ], "transport": "Whole request failure", "anchor": "case-2" }, { "status": 403, "detail": "REST API access is disabled in your API ID settings.", "dynamic": false, "action": "Enable REST access in the API account settings.", "endpoints": [ "Authenticated REST endpoints" ], "transport": "Whole request failure", "anchor": "case-3" }, { "status": 403, "detail": "API access from this IP address is blocked in your API ID settings.", "dynamic": false, "action": "Check the client's public outgoing IP address and the API account's allowed IP list.", "endpoints": [ "Authenticated REST endpoints" ], "transport": "Whole request failure", "anchor": "case-4" }, { "status": 403, "detail": "Your account does not have sufficient permissions to access this resource.", "dynamic": false, "action": "Use the main account or a user with permission to manage users.", "endpoints": [ "GET /rest/account", "GET /rest/account/{user_login}" ], "transport": "Whole request failure", "anchor": "case-5" }, { "status": 403, "detail": "The API client IP address is missing.", "dynamic": false, "action": "Check how the client IP address is forwarded through trusted proxies. Contact support if it is still unavailable.", "endpoints": [ "Authenticated REST endpoints" ], "transport": "Whole request failure", "anchor": "case-6" } ], "title": "Access Denied", "label": "Access denied", "group": "Access", "summary": "The account, REST settings, client IP address or permissions prevent this operation.", "steps": [ "Check that the user account is activated and verified.", "Check REST access and allowed IP addresses in the API account settings.", "Access to another user's data requires the main account or the appropriate permissions." ], "note": "Check that the client's public IP address is recognized and included in the allowed IP list.", "path": "/problems/forbidden/", "uri": "https://api.szybkisms.pl/problems/forbidden/", "statuses": [ 403 ], "example": { "type": "https://api.szybkisms.pl/problems/forbidden/", "status": 403, "title": "Access Denied", "detail": "Your account has not been verified by the operator yet.", "code": "403-2", "instance": "/rest/messages/sms" } }, { "current_uri": "https://api.szybkisms.pl/problems/invalid-body-property-format/", "slug": "invalid-body-property-format", "cases": [ { "status": 400, "detail": "The request body is missing or malformed.", "dynamic": false, "action": "Check the JSON syntax and provide the required request body.", "endpoints": [ "Any REST endpoint" ], "transport": "Whole request failure", "anchor": "case-1" } ], "title": "Invalid Request Body Format", "label": "Invalid request body", "group": "Request", "summary": "The request body is missing or cannot be processed as the expected JSON.", "steps": [ "Send valid JSON with Content-Type: application/json.", "Check the syntax, encoding and object or array structure against the endpoint schema.", "Do not send an empty body to an operation that requires message or sender data." ], "path": "/problems/invalid-body-property-format/", "uri": "https://api.szybkisms.pl/problems/invalid-body-property-format/", "statuses": [ 400 ], "example": { "type": "https://api.szybkisms.pl/problems/invalid-body-property-format/", "status": 400, "title": "Invalid Request Body Format", "detail": "The request body is missing or malformed.", "code": "400-1", "instance": "/rest/messages/sms" } }, { "current_uri": "https://api.szybkisms.pl/problems/bad-request/", "slug": "bad-request", "cases": [ { "status": 400, "detail": "{validation_message}", "dynamic": true, "action": "Check the path and method in the REST API documentation.", "endpoints": [ "Any REST endpoint" ], "transport": "Whole request failure", "anchor": "case-1" } ], "title": "Bad Request", "label": "Bad request", "group": "Request", "summary": "The request does not match an operation described in the API specification.", "steps": [ "Compare the URL and HTTP method with the OpenAPI documentation.", "Check the data required by the operation.", "Correct the request according to detail." ], "note": "This type indicates HTTP 400. Sender and message state conflicts have separate types with HTTP 409.", "path": "/problems/bad-request/", "uri": "https://api.szybkisms.pl/problems/bad-request/", "statuses": [ 400 ], "example": { "type": "https://api.szybkisms.pl/problems/bad-request/", "status": 400, "title": "Bad Request", "detail": "{validation_message}", "code": "400-15", "instance": "/rest/messages/sms" } }, { "current_uri": "https://api.szybkisms.pl/problems/missing-request-parameter/", "slug": "missing-request-parameter", "cases": [ { "status": 400, "detail": "No outgoing message IDs were provided.", "dynamic": false, "action": "Provide outgoing message IDs in the path.", "endpoints": [ "DELETE /rest/messages/{ids}", "GET /rest/messages/{ids}" ], "transport": "Whole request failure", "anchor": "case-1" }, { "status": 400, "detail": "No incoming message IDs were provided.", "dynamic": false, "action": "Provide incoming message IDs in the /rest/incoming/{ids} path.", "endpoints": [ "GET /rest/incoming/{ids}", "DELETE /rest/incoming/{ids}" ], "transport": "Whole request failure", "anchor": "case-2" } ], "title": "Missing Request Parameter", "label": "Missing request parameter", "group": "Request", "summary": "Message IDs were not provided for retrieval, cancellation or deletion.", "steps": [ "Provide IDs in the /messages/{ids} or /incoming/{ids} endpoint path.", "Separate multiple IDs with commas and avoid empty entries.", "Omitting the entire path segment can match a different route and produce a different response." ], "path": "/problems/missing-request-parameter/", "uri": "https://api.szybkisms.pl/problems/missing-request-parameter/", "statuses": [ 400 ], "example": { "type": "https://api.szybkisms.pl/problems/missing-request-parameter/", "status": 400, "title": "Missing Request Parameter", "detail": "No outgoing message IDs were provided.", "code": "400-3", "instance": "/rest/messages/123" } }, { "current_uri": "https://api.szybkisms.pl/problems/invalid-request-parameter-format/", "slug": "invalid-request-parameter-format", "cases": [ { "status": 400, "detail": "Outgoing message IDs must be numbers separated by commas.", "dynamic": false, "action": "Use a comma-separated list of numeric outgoing message IDs.", "endpoints": [ "DELETE /rest/messages/{ids}", "GET /rest/messages/{ids}" ], "transport": "Whole request failure", "anchor": "case-1" }, { "status": 400, "detail": "Incoming message IDs must be numbers separated by commas.", "dynamic": false, "action": "Use comma-separated numeric incoming message IDs without spaces or empty entries.", "endpoints": [ "GET /rest/incoming/{ids}", "DELETE /rest/incoming/{ids}" ], "transport": "Whole request failure", "anchor": "case-2" } ], "title": "Invalid Request Parameter Format", "label": "Invalid parameter format", "group": "Request", "summary": "The ID list contains a value that is not a numeric message ID.", "steps": [ "Use numeric IDs returned by the API.", "A valid list looks like /messages/123,456. Do not add spaces or a trailing comma.", "Check path encoding and remove empty entries from the list." ], "path": "/problems/invalid-request-parameter-format/", "uri": "https://api.szybkisms.pl/problems/invalid-request-parameter-format/", "statuses": [ 400 ], "example": { "type": "https://api.szybkisms.pl/problems/invalid-request-parameter-format/", "status": 400, "title": "Invalid Request Parameter Format", "detail": "Outgoing message IDs must be numbers separated by commas.", "code": "400-4", "instance": "/rest/messages/123" } }, { "current_uri": "https://api.szybkisms.pl/problems/already-exists/", "slug": "already-exists", "cases": [ { "status": 409, "detail": "The sender name is already defined on your account.", "dynamic": false, "action": "Use an existing sender or choose a different name.", "endpoints": [ "POST /rest/senders" ], "transport": "Whole request failure", "anchor": "case-1" } ], "title": "Already Exists", "label": "Sender already exists", "group": "Resources", "summary": "The sender name is already assigned to the account or matches a system sender.", "steps": [ "Retrieve GET /rest/senders and use an existing sender.", "Do not register the same name or a system sender again.", "If you need another sender name, choose a different name and describe its intended use." ], "path": "/problems/already-exists/", "uri": "https://api.szybkisms.pl/problems/already-exists/", "statuses": [ 409 ], "example": { "type": "https://api.szybkisms.pl/problems/already-exists/", "status": 409, "title": "Already Exists", "detail": "The sender name is already defined on your account.", "code": "409-1", "instance": "/rest/senders" } }, { "current_uri": "https://api.szybkisms.pl/problems/validation-error/", "slug": "validation-error", "cases": [ { "status": 400, "detail": "{validation_message}. Path: #{property_path}", "dynamic": true, "action": "Check the field type, constraints and object or array schema variant. Path in detail helps locate invalid data.", "endpoints": [ "Any REST endpoint" ], "transport": "Whole request failure", "anchor": "case-1" }, { "status": 400, "detail": "{validation_message}", "dynamic": true, "action": "Check the request parameters and body. If the failure persists, provide code and the endpoint to support.", "endpoints": [ "Any REST endpoint" ], "transport": "Whole request failure", "anchor": "case-2" }, { "status": 422, "detail": "Sender name validation error: {validation_message}", "dynamic": true, "action": "Correct the sender name according to detail.", "endpoints": [ "POST /rest/senders" ], "transport": "Whole request failure", "anchor": "case-3" } ], "title": "Validation Error", "label": "Validation failed", "group": "Request", "summary": "The data does not meet schema constraints or value rules, such as sender name requirements.", "steps": [ "Check field types, allowed values, formats and limits in OpenAPI.", "If detail contains Path: #..., the path helps locate the invalid field.", "For a rejected sender name, check its length, characters and naming restrictions; choose an allowed name." ], "note": "Schema failures return HTTP 400, while sender name validation failures return HTTP 422. The automation API also uses this type for an invalid webhook URL with HTTP 400. Path is part of the detail text, not a separate errors field.", "path": "/problems/validation-error/", "uri": "https://api.szybkisms.pl/problems/validation-error/", "statuses": [ 400, 422 ], "example": { "type": "https://api.szybkisms.pl/problems/validation-error/", "status": 400, "title": "Validation Error", "detail": "{validation_message}. Path: #{property_path}", "code": "400-10", "instance": "/rest/messages/sms" } }, { "current_uri": "https://api.szybkisms.pl/problems/missing-body-property/", "slug": "missing-body-property", "cases": [ { "status": 400, "detail": "At least one message is required.", "dynamic": false, "action": "Provide at least one message in the request body for sending or pricing.", "endpoints": [ "POST /rest/messages/mms", "POST /rest/messages/sms", "POST /rest/messages/mms/price", "POST /rest/messages/sms/price" ], "transport": "Whole request failure", "anchor": "case-1" }, { "status": 400, "detail": "A description of the intended use of the sender name is required.", "dynamic": false, "action": "Fill in description with the intended use of the sender name.", "endpoints": [ "POST /rest/senders" ], "transport": "Whole request failure", "anchor": "case-2" } ], "title": "Missing Body Property", "label": "Missing body data", "group": "Request", "summary": "The request is missing messages to send or price, or a description of the sender name's intended use.", "steps": [ "For sending and pricing, submit a message object or a nonempty array of message objects.", "When registering a sender, fill in description with its intended use.", "Empty arrays and other missing required fields can be rejected earlier by OpenAPI validation." ], "path": "/problems/missing-body-property/", "uri": "https://api.szybkisms.pl/problems/missing-body-property/", "statuses": [ 400 ], "example": { "type": "https://api.szybkisms.pl/problems/missing-body-property/", "status": 400, "title": "Missing Body Property", "detail": "At least one message is required.", "code": "400-2", "instance": "/rest/messages/mms" } }, { "current_uri": "https://api.szybkisms.pl/problems/invalid-request-parameter-value/", "slug": "invalid-request-parameter-value", "cases": [ { "status": 400, "detail": "{validation_message}", "dynamic": true, "action": "Correct the path parameter value according to the endpoint schema.", "endpoints": [ "Any REST endpoint" ], "transport": "Whole request failure", "anchor": "case-1" } ], "title": "Invalid Request Parameter Value", "label": "Invalid parameter value", "group": "Request", "summary": "Path parameter validation rejected a value in the request URL.", "steps": [ "Compare the path parameter with the endpoint schema.", "Check the IDs, list length and allowed value format.", "Correct the parameter identified in detail and retry." ], "path": "/problems/invalid-request-parameter-value/", "uri": "https://api.szybkisms.pl/problems/invalid-request-parameter-value/", "statuses": [ 400 ], "example": { "type": "https://api.szybkisms.pl/problems/invalid-request-parameter-value/", "status": 400, "title": "Invalid Request Parameter Value", "detail": "{validation_message}", "code": "400-12", "instance": "/rest/messages/sms" } }, { "current_uri": "https://api.szybkisms.pl/problems/method-not-allowed/", "slug": "method-not-allowed", "cases": [ { "status": 405, "detail": "The requested endpoint supports only {allowed_methods}.", "dynamic": true, "action": "Use a method listed in Allow and detail.", "endpoints": [ "Any REST endpoint" ], "transport": "Whole request failure", "anchor": "case-1" } ], "title": "Method Not Allowed", "label": "Method not allowed", "group": "Request", "summary": "The endpoint exists but does not support the submitted HTTP method.", "steps": [ "Read the Allow header for the methods supported at this URL.", "Check the method in the endpoint documentation, such as POST for sending and pricing or DELETE for cancellation.", "Use a supported method and retry with the required parameters and body." ], "note": "The response has HTTP 405 and includes Allow. The supported methods depend on the endpoint and are also listed in detail.", "path": "/problems/method-not-allowed/", "uri": "https://api.szybkisms.pl/problems/method-not-allowed/", "statuses": [ 405 ], "example": { "type": "https://api.szybkisms.pl/problems/method-not-allowed/", "status": 405, "title": "Method Not Allowed", "detail": "The requested endpoint supports only POST method.", "code": "405-1", "instance": "/rest/messages/sms" } }, { "current_uri": "https://api.szybkisms.pl/problems/message-not-cancellable/", "slug": "message-not-cancellable", "cases": [ { "status": 409, "detail": "This message can no longer be canceled.", "dynamic": false, "action": "Read the current message status; only a scheduled message can be canceled.", "endpoints": [ "DELETE /rest-sandbox/messages/{ids}", "DELETE /rest/messages/{ids}" ], "transport": "Batch item · HTTP 200", "anchor": "case-1" }, { "status": 409, "detail": "This message cannot be canceled again.", "dynamic": false, "action": "The message is already canceled. Do not retry cancellation for this ID.", "endpoints": [ "DELETE /rest-sandbox/messages/{ids}", "DELETE /rest/messages/{ids}" ], "transport": "Batch item · HTTP 200", "anchor": "case-2" } ], "title": "Message Cannot Be Canceled", "label": "Message cannot be canceled", "group": "Resources", "summary": "The message is already canceled or is not in a state that allows cancellation.", "steps": [ "Read the current message status from history.", "Cancel only a scheduled message that is waiting to be sent.", "If the message has already been canceled, do not retry cancellation for that ID." ], "note": "This type appears in the error field of a batch item for DELETE /rest/messages/{ids} or its sandbox equivalent. The item has status 409 while the whole request returns HTTP 200 with application/json. Check each item separately.", "path": "/problems/message-not-cancellable/", "uri": "https://api.szybkisms.pl/problems/message-not-cancellable/", "statuses": [ 409 ], "example": { "type": "https://api.szybkisms.pl/problems/message-not-cancellable/", "status": 409, "title": "Message Cannot Be Canceled", "detail": "This message can no longer be canceled.", "code": "409-2", "instance": "/rest-sandbox/messages/123" } }, { "current_uri": "https://api.szybkisms.pl/problems/sender-not-removable/", "slug": "sender-not-removable", "cases": [ { "status": 403, "detail": "System sender names cannot be removed.", "dynamic": false, "action": "Choose an account sender; a system sender cannot be removed.", "endpoints": [ "DELETE /rest/senders/{sender}" ], "transport": "Whole request failure", "anchor": "case-1" } ], "title": "Sender Cannot Be Removed", "label": "Sender cannot be removed", "group": "Resources", "summary": "A protected system sender cannot be deleted.", "steps": [ "Check whether the name in the path identifies a system sender.", "Delete only your own sender names assigned to the account.", "Retrieve GET /rest/senders and choose an appropriate account sender." ], "note": "This type indicates HTTP 403: API policy prohibits deleting a system sender. Invalid data syntax or values are covered by the separate validation-error type.", "path": "/problems/sender-not-removable/", "uri": "https://api.szybkisms.pl/problems/sender-not-removable/", "statuses": [ 403 ], "example": { "type": "https://api.szybkisms.pl/problems/sender-not-removable/", "status": 403, "title": "Sender Cannot Be Removed", "detail": "System sender names cannot be removed.", "code": "403-9", "instance": "/rest/senders/Bramka%20SMS" } }, { "current_uri": "https://api.szybkisms.pl/problems/sender-not-active/", "slug": "sender-not-active", "cases": [ { "status": 409, "detail": "Only an active sender can be set as default.", "dynamic": false, "action": "Choose a sender with the Active status.", "endpoints": [ "PATCH /rest/senders/{sender}" ], "transport": "Whole request failure", "anchor": "case-1" } ], "title": "Sender Is Not Active", "label": "Sender is not active", "group": "Resources", "summary": "The sender is not in a state that allows it to be set as default.", "steps": [ "Retrieve the sender list with GET /rest/senders and check each status.", "Choose a sender with the Active status.", "A pending sender can be set as default after it has been approved." ], "note": "HTTP 409 indicates a conflict with the current sender state. Valid request data is not enough while the sender is inactive.", "path": "/problems/sender-not-active/", "uri": "https://api.szybkisms.pl/problems/sender-not-active/", "statuses": [ 409 ], "example": { "type": "https://api.szybkisms.pl/problems/sender-not-active/", "status": 409, "title": "Sender Is Not Active", "detail": "Only an active sender can be set as default.", "code": "409-11", "instance": "/rest/senders/STORE" } }, { "current_uri": "https://api.szybkisms.pl/problems/unsupported-media-type/", "slug": "unsupported-media-type", "cases": [ { "status": 415, "detail": "This endpoint does not support the submitted Content-Type.", "dynamic": false, "action": "Set Content-Type to a requestBody format supported in OpenAPI; use application/json for REST endpoints with JSON bodies.", "endpoints": [ "Any REST endpoint" ], "transport": "Whole request failure", "anchor": "case-1" } ], "title": "Unsupported Media Type", "label": "Unsupported media type", "group": "Request", "summary": "The Content-Type specifies a format that this endpoint does not accept.", "steps": [ "Check the supported requestBody formats in OpenAPI.", "For REST endpoints that accept JSON, set Content-Type: application/json.", "Encode the request body in the format specified by the header." ], "note": "HTTP 415 means that the submitted format is unsupported. Malformed JSON or a missing required header can still return HTTP 400.", "path": "/problems/unsupported-media-type/", "uri": "https://api.szybkisms.pl/problems/unsupported-media-type/", "statuses": [ 415 ], "example": { "type": "https://api.szybkisms.pl/problems/unsupported-media-type/", "status": 415, "title": "Unsupported Media Type", "detail": "This endpoint does not support the submitted Content-Type.", "code": "415-1", "instance": "/rest/messages/sms" } } ], "message_errors": [ { "description": "User account does not exist", "detail": "User account does not exist", "action": "Check the user associated with the token and whether they belong to the account.", "scope": "rest-messaging" }, { "description": "Invalid message type", "detail": "Invalid message type", "action": "Use an SMS type supported by the REST API schema.", "scope": "rest-messaging" }, { "description": "The message's recipient number is invalid", "detail": "The message's recipient number is invalid", "action": "Correct the recipient number and use international format.", "scope": "rest-messaging" }, { "description": "ECO SMS messages can only be sent to standard Polish recipient numbers", "detail": "ECO SMS messages can only be sent to standard Polish recipient numbers", "action": "Use a standard Polish phone number or choose an appropriate SMS type.", "scope": "rest-messaging" }, { "description": "2Way SMS can only be sent to standard Polish recipient numbers", "detail": "2Way SMS can only be sent to standard Polish recipient numbers", "action": "Use a standard Polish phone number for SMS 2Way.", "scope": "rest-messaging" }, { "description": "Missing message content", "detail": "Missing message content", "action": "Provide the SMS text or MMS content.", "scope": "rest-messaging" }, { "description": "The content of the binary message is invalid", "detail": "The content of the binary message is invalid", "action": "Check the binary content. The standard REST schema does not expose a separate binary SMS type.", "scope": "shared" }, { "description": "UDH header is invalid", "detail": "UDH header is invalid", "action": "Check the UDH header. The public REST schema does not include a UDH field.", "scope": "shared" }, { "description": "Binary message content is too long", "detail": "Binary message content is too long", "action": "Reduce the binary content size. This belongs to shared SMS validation.", "scope": "shared" }, { "description": "The recipient number is currently unsupported", "detail": "The recipient number is currently unsupported", "action": "Check whether the recipient destination is supported and included in the account's price list. Contact support if rejection persists.", "scope": "rest-messaging" }, { "description": "The scheduled delivery date of the message may be up to 90 days from now", "detail": "The scheduled delivery date of the message may be up to 90 days from now", "action": "Use a future sending date no more than 90 days from now.", "scope": "rest-messaging" }, { "description": "An unknown error occurred", "detail": "An unknown error occurred", "action": "Check message history and the account balance before retrying. Report the event to support if rejection persists.", "scope": "rest-messaging" }, { "description": "There are not enough credits in your account to send this message. Please top up your account and try again.", "detail": "There are not enough credits in your account to send this message. Please top up your account and try again.", "action": "Top up the account, then retry only the rejected messages.", "scope": "rest-messaging" }, { "description": "The subaccount limit defined by your account Administrator has been reached. Please contact your account Administrator.", "detail": "The subaccount limit defined by your account Administrator has been reached. Please contact your account Administrator.", "action": "Ask the account administrator to increase the user's limit.", "scope": "rest-messaging" }, { "description": "FLASH message cannot contain UNICODE characters", "detail": "FLASH message cannot contain UNICODE characters", "action": "Disable FLASH or use text that does not require Unicode.", "scope": "rest-messaging" }, { "description": "The MMS content is too large. Delete oversized attachments.", "detail": "The MMS content is too large. Delete oversized attachments.", "action": "Reduce the size of the attachments and the whole MMS.", "scope": "rest-messaging" }, { "description": "MMS can only be sent to standard Polish recipient numbers", "detail": "MMS can only be sent to standard Polish recipient numbers", "action": "Use a standard Polish phone number for MMS.", "scope": "rest-messaging" }, { "description": "User account has not been verified by provider yet", "detail": "User account has not been verified by provider yet", "action": "Wait for the operator to verify your account.", "scope": "rest-messaging" }, { "description": "The MMS attachement type format is unsupported.", "detail": "The MMS attachement type format is unsupported.", "action": "Check base64 encoding, the actual file format and attachment size.", "scope": "rest-messaging" }, { "description": "Message limit exceeded for this phone number within the last 60 seconds.", "detail": "Message limit exceeded for this phone number within the last 60 seconds.", "action": "Wait before sending another message to this number; the limit applies to the last 60 seconds.", "scope": "rest-messaging" } ], "scenario_count": 37 }