{ "openapi":"3.1.0", "info":{ "title":"Infobip OpenAPI Specification", "description":"OpenAPI Specification that contains all public endpoints and webhooks.", "contact":{ "name":"Infobip support", "email":"support@infobip.com" }, "version":"3.210.0", "x-generatedAt":"2026-07-23T15:24:04.338668974Z" }, "tags":[ { "name":"platform", "description":"Modular tools to scale and automate your business.\n", "x-type":"category", "x-displayName":"Platform" }, { "name":"account-management", "description":"Manage your Infobip account details, such as individual users and api keys.", "x-type":"product", "x-displayName":"Account management" }, { "name":"balance", "description":"", "x-type":"section", "x-displayName":"Balance" }, { "name":"accounts", "description":"", "x-type":"section", "x-displayName":"Accounts" }, { "name":"api-keys", "description":"", "x-type":"section", "x-displayName":"API keys" }, { "name":"login", "description":"", "x-type":"section", "x-displayName":"Login" }, { "name":"oauth", "description":"", "x-type":"section", "x-displayName":"OAuth" }, { "name":"audit-logs", "description":"", "x-type":"section", "x-displayName":"Audit logs" } ], "paths":{ "/account/1/balance":{ "get":{ "tags":[ "platform", "account-management", "balance" ], "summary":"Get current account balance", "description":"Returns the current account balance displayed in the currency configured for the account.", "operationId":"get-account-balance", "responses":{ "200":{ "description":"OK", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.AccountBalance" } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "account-management:manage" ] } }, "/account/1/free-messages":{ "get":{ "tags":[ "platform", "account-management", "balance" ], "summary":"Get remaining free messages", "description":"Returns the remaining number of free messages available for the account.", "operationId":"get-free-messages-count", "responses":{ "200":{ "description":"OK", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.FreeMessagesResponse" } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "account-management:manage" ] } }, "/account/1/total-balance":{ "get":{ "tags":[ "platform", "account-management", "balance" ], "summary":"Get account balance with free messages", "description":"Returns the current account balance, monthly balance, monthly and total credit limit, currency details, and the remaining count of free messages per service type.", "operationId":"get-total-account-balance", "responses":{ "200":{ "description":"OK", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.BalanceInfoResponse" } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "account-management:manage" ] } }, "/settings/1/accounts":{ "get":{ "tags":[ "platform", "account-management", "accounts" ], "summary":"Get all sub accounts with filter", "description":"This method allows you to get all sub accounts with custom filter", "operationId":"get-all-accounts", "parameters":[ { "name":"name", "in":"query", "description":"Account name", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"limit", "in":"query", "description":"Number of account in response", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":40 } }, { "name":"enabled", "in":"query", "description":"Indicates whether the account is enabled", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" } } ], "responses":{ "200":{ "description":"OK", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.AccountsResponse" }, "examples":{ "default_accounts_response":{ "summary":"Get all subaccounts by filter", "value":{ "accounts":[ { "key":"accountKey", "ownerKey":"ownerKey", "name":"Account Name", "enabled":true } ] } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "account-management:manage" ] } }, "/settings/1/accounts/{accountKey}":{ "put":{ "tags":[ "platform", "account-management", "accounts" ], "summary":"Update account", "description":"This method allows you to update account. You can only update sub accounts", "operationId":"update-account", "parameters":[ { "name":"accountKey", "in":"path", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.UpdateAccountRequest" }, "examples":{ "UpdateAccountRequest":{ "summary":"UpdateAccountRequest", "description":"Example of UpdateAccountRequest", "value":{ "name":"New Account Name", "enabled":true } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Account" } } } }, "400":{ "$ref":"#/components/responses/ApiException400" }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "$ref":"#/components/responses/ApiException404" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "account-management:manage" ] } }, "/settings/1/accounts/{accountKey}/api-keys":{ "get":{ "tags":[ "platform", "account-management", "api-keys" ], "summary":"Get API keys by filter", "description":"This method allows you to get API keys of some account by filter forwarded", "operationId":"get-api-keys-by-filter-deprecated", "parameters":[ { "name":"accountKey", "in":"path", "description":"Key of the main account the API key belongs to. Use the special `_` value to reference the account of the user making the API request or a standard account key such as `8F0792F86035A9F4290821F1EE6BC06A` to reference an account explicitly.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"name", "in":"query", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"limit", "in":"query", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":40 } }, { "name":"enabled", "in":"query", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" } }, { "name":"publicApiKey", "in":"query", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeys" }, "examples":{ "default_api_keys_response":{ "summary":"Default API keys response", "value":{ "apiKeys":[ { "key":"573711510E1C002E29679B12C7CB48AE", "publicApiKey":"", "accountKey":"8F0792F86035A9F4290821F1EE6BC06A", "name":"ApiKey name", "allowedIPs":[ "127.0.0.1" ], "validFrom":"2026-07-09T06:04:54.988+00:00", "validTo":"2026-07-09T06:04:54.988+00:00", "enabled":true, "permissions":[ "ALL" ] } ] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "account-management:manage" ] }, "post":{ "tags":[ "platform", "account-management", "api-keys" ], "summary":"Create API key", "description":"This method allows you to create an API key.", "operationId":"create-api-key-deprecated", "parameters":[ { "name":"accountKey", "in":"path", "description":"Key of the main account the API key belongs to. Use the special `_` value to reference the account of the user making the API request or a standard account key such as `8F0792F86035A9F4290821F1EE6BC06A` to reference an account explicitly.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.CreateApiKeyRequestV1" }, "examples":{ "default_create_api_key_v1_request":{ "summary":"Create API key v1 request", "value":{ "name":"name", "allowedIPs":[ "127.0.0.1" ], "validTo":"2026-08-08T06:04:54.988+0000", "validFrom":"2026-08-08T06:04:54.988+0000", "enabled":true, "permissions":[ "ALL" ] } } } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeyResponse" } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "account-management:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":40, "numberOfTimeUnits":0, "timeUnit":"d" } ] } }, "/settings/1/accounts/{accountKey}/api-keys/{key}":{ "get":{ "tags":[ "platform", "account-management", "api-keys" ], "summary":"Get API key", "description":"Key of the main account the API key belongs to. Use the special _ value to reference the account of the user making the API request or a standard account key such as 8F0792F86035A9F4290821F1EE6BC06A to reference an account explicitly", "operationId":"get-api-key-deprecated", "parameters":[ { "name":"accountKey", "in":"path", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"key", "in":"path", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeyResponse" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "account-management:manage" ] }, "put":{ "tags":[ "platform", "account-management", "api-keys" ], "summary":"Update API key", "description":"Key of the main account the API key belongs to. Use the special _ value to reference the account of the user making the API request or a standard account key such as 8F0792F86035A9F4290821F1EE6BC06A to reference an account explicitly.", "operationId":"update-api-key-deprecated", "parameters":[ { "name":"accountKey", "in":"path", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"key", "in":"path", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.UpdateApiKeyRequestV1" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeyResponse" } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "account-management:manage" ] } }, "/settings/2/api-keys":{ "get":{ "tags":[ "platform", "account-management", "api-keys" ], "summary":"Get API keys by filter", "description":"This method allows you to fetch an API keys by filter. Only users with certain roles can fetch api keys; for example, Account Manager and Integrations Manager roles.", "operationId":"get-api-keys-by-filter", "parameters":[ { "name":"accountId", "in":"query", "description":"Unique identifier for account this API keys belongs to. AccountId is optional and if not provided it will default to the account making the request.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"name", "in":"query", "description":"Name of this API Key.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"page", "in":"query", "description":"Specify the API key response page you want to fetch, starting with 0. If not set, the response will contain first page. The highest allowed page value is 100.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" } }, { "name":"size", "in":"query", "description":"The number of API keys in one response page. If not set, the response will be limited to 100 API keys, which is also the highest allowed size.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" } }, { "name":"orderBy", "in":"query", "description":"The ordering parameter of API keys in the response page. If not set, the API keys in the response will be ordered by API key id.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"orderDirection", "in":"query", "description":"The order direction of API keys in the response page. If not set, the API keys in the response will be in the ascending order.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"enabled", "in":"query", "description":"Is API key enabled.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" } }, { "name":"apiKeySecret", "in":"query", "description":"Authentication key. Use this value for authentication on API. Keep this in secure storage and don't share it.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.GetApiKeysResponse" }, "examples":{ "default_get_api_key_response":{ "summary":"Get API keys response", "value":{ "apiKeys":[ { "id":"573711510E1C002E29679B12C7CB48AE", "apiKeySecret":"", "accountId":"8F0792F86035A9F4290821F1EE6BC06A", "name":"First ApiKey on my account", "allowedIPs":[ "127.0.0.1", "168.158.10.122" ], "validFrom":"2023-09-01T10:00:00", "validTo":"2024-09-01T10:00:00", "enabled":true, "permissions":[ "PUBLIC_API" ], "scopeGuids":[ "2fa:manage", "account-management:manage" ] } ], "paging":{ "page":0, "pageSize":10, "orderDirection":"asc", "totalCount":1, "totalPages":1 } } }, "default_get_api_key_cpaasx_response":{ "summary":"Get CPaasX API keys response", "value":{ "apiKeys":[ { "id":"573711510E1C002E29679B12C7CB48AE", "apiKeySecret":"", "accountId":"8F0792F86035A9F4290821F1EE6BC06A", "name":"First ApiKey on my account", "allowedIPs":[ "127.0.0.1", "168.158.10.122" ], "validFrom":"2023-09-01T10:00:00", "validTo":"2024-09-01T10:00:00", "enabled":true, "platform":[ { "key":"301493481C01BC01921AB1072S1A1AA1", "applicationId":"test-application", "entityId":"test-entity" }, { "key":"12948B109237B1DB10237EB10E1B01B0", "applicationId":"default" }, { "key":"C365C6D6575A757D576D5987968D574D", "applicationId":"marketing-automation-application", "entityId":"promotional-traffic-entity", "action":"FILL" } ] } ], "paging":{ "page":0, "pageSize":10, "orderDirection":"asc", "totalCount":1, "totalPages":1 } } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message." } ], "resources":[] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "account-management:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "post":{ "tags":[ "platform", "account-management", "api-keys" ], "summary":"Create API key", "description":"This method allows you to create an API key. Only users with certain roles can create api keys; for example, Account Manager and Integrations Manager roles.", "operationId":"create-api-key", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.CreateApiKeyRequest" }, "examples":{ "default_create_api_key_request":{ "summary":"Create API key request", "value":{ "accountId":"8F0792F86035A9F4290821F1EE6BC06A", "name":"First ApiKey on my account", "allowedIPs":[ "127.0.0.1", "168.158.10.122" ], "validFrom":"2023-09-01T10:00:00", "validTo":"2024-09-01T10:00:00", "permissions":[ "PUBLIC_API" ], "scopeGuids":[ "2fa:manage", "account-management:manage" ] } }, "default_create_cpaasx_api_key_request":{ "summary":"Create CPaaSX API key request", "value":{ "accountId":"8F0792F86035A9F4290821F1EE6BC06A", "name":"First ApiKey on my account", "allowedIPs":[ "127.0.0.1", "168.158.10.122" ], "validFrom":"2023-09-01T10:00:00", "validTo":"2024-09-01T10:00:00", "platform":[ { "applicationId":"test-application", "entityId":"test-entity" }, { "applicationId":"default" }, { "applicationId":"marketing-automation-application", "entityId":"promotional-traffic-entity", "action":"FILL" } ] } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKey" }, "examples":{ "default_create_api_key_response":{ "summary":"Create API key response", "value":{ "id":"573711510E1C002E29679B12C7CB48AE", "apiKeySecret":"", "accountId":"8F0792F86035A9F4290821F1EE6BC06A", "name":"First ApiKey on my account", "allowedIPs":[ "127.0.0.1", "168.158.10.122" ], "validFrom":"2024-09-01T10:00:00", "validTo":"2023-09-01T10:00:00", "enabled":true, "permissions":[ "PUBLIC_API" ], "scopeGuids":[ "2fa:manage", "account-management:manage" ] } }, "default_create_cpaasx_api_key_response":{ "summary":"Create CPaaSX API key response", "value":{ "id":"573711510E1C002E29679B12C7CB48AE", "apiKeySecret":"", "accountId":"8F0792F86035A9F4290821F1EE6BC06A", "name":"First ApiKey on my account", "allowedIPs":[ "127.0.0.1", "168.158.10.122" ], "validFrom":"2024-09-01T10:00:00", "validTo":"2023-09-01T10:00:00", "enabled":true, "platform":[ { "key":"301493481C01BC01921AB1072S1A1AA1", "applicationId":"test-application", "entityId":"test-entity" }, { "key":"12948B109237B1DB10237EB10E1B01B0", "applicationId":"default" }, { "key":"C365C6D6575A757D576D5987968D574D", "applicationId":"marketing-automation-application", "entityId":"promotional-traffic-entity", "action":"FILL" } ] } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message." } ], "resources":[] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "account-management:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":40, "numberOfTimeUnits":0, "timeUnit":"d" } ] } }, "/settings/2/api-keys/{apiKeyId}":{ "get":{ "tags":[ "platform", "account-management", "api-keys" ], "summary":"Get API key", "description":"This method allows you to fetch an API key. Only users with certain roles can fetch api key; for example, Account Manager and Integrations Manager roles.", "operationId":"get-api-key", "parameters":[ { "name":"apiKeyId", "in":"path", "description":"Unique identifier of api key to be returned.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKey" }, "examples":{ "default_get_api_key_response":{ "summary":"Get API key response", "value":{ "id":"573711510E1C002E29679B12C7CB48AE", "apiKeySecret":"", "accountId":"8F0792F86035A9F4290821F1EE6BC06A", "name":"First ApiKey on my account", "allowedIPs":[ "127.0.0.1", "168.158.10.122" ], "validFrom":"2024-09-01T10:00:00", "validTo":"2023-09-01T10:00:00", "enabled":true, "permissions":[ "PUBLIC_API" ], "scopeGuids":[ "2fa:manage", "account-management:manage" ] } }, "default_get_cpaasx_api_key_response":{ "summary":"Get CPaaSX API key response", "value":{ "id":"573711510E1C002E29679B12C7CB48AE", "apiKeySecret":"", "accountId":"8F0792F86035A9F4290821F1EE6BC06A", "name":"First ApiKey on my account", "allowedIPs":[ "127.0.0.1", "168.158.10.122" ], "validFrom":"2024-09-01T10:00:00", "validTo":"2023-09-01T10:00:00", "enabled":true, "platform":[ { "key":"301493481C01BC01921AB1072S1A1AA1", "applicationId":"test-application", "entityId":"test-entity" }, { "key":"12948B109237B1DB10237EB10E1B01B0", "applicationId":"default" }, { "key":"C365C6D6575A757D576D5987968D574D", "applicationId":"marketing-automation-application", "entityId":"promotional-traffic-entity", "action":"FILL" } ] } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message." } ], "resources":[] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "account-management:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "put":{ "tags":[ "platform", "account-management", "api-keys" ], "summary":"Update API key", "description":"This method allows you to update an API key. Only users with certain roles can create api keys; for example, Account Manager and Integrations Manager roles.", "operationId":"update-api-key", "parameters":[ { "name":"apiKeyId", "in":"path", "description":"Unique identifier of api key to be updated.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.UpdateApiKeyRequest" }, "examples":{ "default_update_api_key_request":{ "summary":"Update API key request", "value":{ "name":"First ApiKey on my account", "allowedIPs":[ "127.0.0.1", "168.158.10.122" ], "validFrom":"2025-09-01T10:00:00", "validTo":"2024-09-01T10:00:00", "permissions":[ "PUBLIC_API" ], "scopeGuids":[ "2fa:manage", "account:management" ] } }, "default_update_cpaasx_api_key_request":{ "summary":"Update CPaaSX API key request", "value":{ "name":"First ApiKey on my account", "allowedIPs":[ "127.0.0.1", "168.158.10.122" ], "validFrom":"2025-09-01T10:00:00", "validTo":"2024-09-01T10:00:00", "platform":[ { "applicationId":"marketing-automation-application", "entityId":"promotional-traffic-entity", "action":"FILL" } ] } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKey" }, "examples":{ "default_update_api_key_response":{ "summary":"Update API key response", "value":{ "id":"573711510E1C002E29679B12C7CB48AE", "apiKeySecret":"", "accountId":"8F0792F86035A9F4290821F1EE6BC06A", "name":"First ApiKey on my account", "allowedIPs":[ "127.0.0.1", "168.158.10.122" ], "validFrom":"2024-09-01T10:00:00", "validTo":"2023-09-01T10:00:00", "enabled":true, "permissions":[ "PUBLIC_API" ], "scopeGuids":[ "2fa:manage", "account-management:manage" ] } }, "default_update_cpaasx_api_key_response":{ "summary":"Update CPaaSX API key response", "value":{ "id":"573711510E1C002E29679B12C7CB48AE", "apiKeySecret":"", "accountId":"8F0792F86035A9F4290821F1EE6BC06A", "name":"First ApiKey on my account", "allowedIPs":[ "127.0.0.1", "168.158.10.122" ], "validFrom":"2024-09-01T10:00:00", "validTo":"2023-09-01T10:00:00", "enabled":true, "platform":[ { "key":"301493481C01BC01921AB1072S1A1AA1", "applicationId":"test-application", "entityId":"test-entity" }, { "key":"12948B109237B1DB10237EB10E1B01B0", "applicationId":"default" }, { "key":"C365C6D6575A757D576D5987968D574D", "applicationId":"marketing-automation-application", "entityId":"promotional-traffic-entity", "action":"FILL" } ] } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message." } ], "resources":[] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "account-management:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":40, "numberOfTimeUnits":0, "timeUnit":"d" } ] } }, "/auth/1/session":{ "post":{ "tags":[ "platform", "account-management", "login" ], "summary":"Create session token", "description":"This method allows you to create a session (login) which by default will expire after 60 minutes. If you want to create a new token before the session expires, you'll need to destroy it first.", "operationId":"create-session", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.CreateSessionRequest" }, "examples":{ "default_create_session_request":{ "summary":"Create Session Request", "value":{ "username":"username", "password":"password", "unsafe":false } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "*/*":{ "schema":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Session" } } } }, "400":{ "$ref":"#/components/responses/ApiException400" }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "delete":{ "tags":[ "platform", "account-management", "login" ], "summary":"Destroy session token", "description":"This method allows you to destroy the session token.", "operationId":"destroy-session", "responses":{ "200":{ "description":"OK" }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] } ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/auth/1/oauth2/token":{ "post":{ "tags":[ "platform", "account-management", "oauth" ], "summary":"Create OAuth2 token", "description":"Generate OAuth2 access token that can later on be used to authenticate other Infobip API calls.", "operationId":"create-oauth2-token", "requestBody":{ "content":{ "application/x-www-form-urlencoded":{ "schema":{ "$ref":"#/components/schemas/b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.TokenRequest" } } } }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.TokenResponse" } } } }, "400":{ "$ref":"#/components/responses/ApiException400" }, "429":{ "$ref":"#/components/responses/ApiException429" }, "4XX":{ "description":"Error responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.OAuthApiException" } } } }, "500":{ "$ref":"#/components/responses/ApiException500" }, "5XX":{ "description":"Error responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.OAuthApiException" } } } } }, "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/audit/1/logs/export":{ "get":{ "tags":[ "platform", "account-management", "audit-logs" ], "summary":"Export Audit Logs", "description":"This method allows you to search and export users' activities on the web interface.", "operationId":"export-audit-logs", "parameters":[ { "name":"action", "in":"query", "description":"User's action. If nothing is provided, logs for all actions are returned.", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.Action" }, "example":"Create" }, { "name":"description", "in":"query", "description":"Description of an action. If nothing is provided, logs for all descriptions are returned.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "example":"username" }, "example":"username" }, { "name":"from", "in":"query", "description":"Date and time filter with the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. If nothing is provided, there will be no lower limit filter applied on a date and time of recorded activity returned in logs.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time", "example":"2023-01-01T00:00:00Z" }, "example":"2023-01-01T00:00:00.000Z" }, { "name":"item", "in":"query", "description":"Use it as a filter to apply to the action field to narrow down the logs returned. if nothing is provided, logs with all items are returned.", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.Item" }, "example":"User" }, { "name":"ipAddress", "in":"query", "description":"User's IP address. If nothing is provided, logs for all IP addresses are returned.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "example":"127.0.0.1" }, "example":"127.0.0.1" }, { "name":"limit", "in":"query", "description":"Max number of user activities returned in logs. Accepts values from `1` to `10000`. Defaults to `10000`.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "example":10000, "maximum":10000, "minimum":1 }, "example":10000 }, { "name":"to", "in":"query", "description":"Date and time filter with the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. If nothing is provided, there will be no upper limit filter applied on a date and time of recorded user activity returned in logs.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time", "example":"2023-01-03T00:00:00Z" }, "example":"2023-01-03T00:00:00.000Z" }, { "name":"userKey", "in":"query", "description":"User's key can be found on the user's profile page at the Infobip portal. If nothing is provided, the logs for all user keys are returned.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "example":"JD1I2JD9JD3DDHHGKCNN1PK2O1" }, "example":"JD1I2JD9JD3DDHHGKCNN1PK2O1" } ], "responses":{ "200":{ "description":"CSV File.", "content":{ "text/csv":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Search result larger than the limit. Limit is 10000.", "content":{ "text/plain":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Search result larger than the limit. Limit is 10000.", "validationErrors":null } } } } } }, "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Search result larger than the limit. Limit is 10000.", "validationErrors":null } } } } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Search result larger than the limit. Limit is 10000.", "validationErrors":null } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] }, { "IBSSOTokenHeader":[] } ], "x-scopes":[ "audit-logs:read", "account-management:manage" ] } }, "/audit/1/logs":{ "get":{ "tags":[ "platform", "account-management", "audit-logs" ], "summary":"Search Audit Logs", "description":"This method allows you to track and search through users' activities on the web interface.", "operationId":"search-audit-logs", "parameters":[ { "name":"action", "in":"query", "description":"User's action. If nothing is provided, logs for all actions are returned.", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.Action" }, "example":"Create" }, { "name":"description", "in":"query", "description":"Description of an action. If nothing is provided, logs for all descriptions are returned.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "example":"username" }, "example":"username" }, { "name":"from", "in":"query", "description":"Date and time filter with the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. If nothing is provided, there will be no lower limit filter applied on a date and time of recorded activity returned in logs.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time", "example":"2023-01-01T00:00:00Z" }, "example":"2023-01-01T00:00:00.000Z" }, { "name":"item", "in":"query", "description":"Use it as a filter to apply to the action field to narrow down the logs returned. if nothing is provided, logs with all items are returned.", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.Item" }, "example":"User" }, { "name":"ipAddress", "in":"query", "description":"User's IP address. If nothing is provided, logs for all IP addresses are returned.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "example":"127.0.0.1" }, "example":"127.0.0.1" }, { "name":"limit", "in":"query", "description":"Max number of user activities returned in logs. Accepts values from `1` to `10000`. Defaults to `10000`.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "example":10000, "maximum":10000, "minimum":1 }, "example":10000 }, { "name":"to", "in":"query", "description":"Date and time filter with the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. If nothing is provided, there will be no upper limit filter applied on a date and time of recorded user activity returned in logs.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time", "example":"2023-01-03T00:00:00Z" }, "example":"2023-01-03T00:00:00.000Z" }, { "name":"userKey", "in":"query", "description":"User's key can be found on the user's profile page at the Infobip portal. If nothing is provided, the logs for all user keys are returned.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "example":"JD1I2JD9JD3DDHHGKCNN1PK2O1" }, "example":"JD1I2JD9JD3DDHHGKCNN1PK2O1" } ], "responses":{ "200":{ "description":"List of audit logs.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.SearchResult" } }, "examples":{ "Response example":{ "summary":"Response example", "value":[ { "action":"Create", "description":"User 'username' created user!", "id":"80265c56-b644-4fb9-a5ab-83example5b3384", "ipAddress":"127.0.0.1", "item":"User", "timestamp":"2026-07-23T00:00:00Z", "username":"username" } ] } } } } }, "400":{ "description":"Search result larger than the limit. Limit is 10000.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Search result larger than the limit. Limit is 10000.", "validationErrors":null } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] }, { "IBSSOTokenHeader":[] } ], "x-scopes":[ "audit-logs:read", "account-management:manage" ] } } }, "components":{ "schemas":{ "40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.Action":{ "type":"string", "enum":[ "Accept", "Activation", "Add", "Assign", "Buy", "Cancel", "Change", "Clone", "Create", "CreateGenerate", "CreateVersion", "Delete", "DeleteVersion", "Disable", "Download", "Duplicate", "Enable", "Export", "Finish", "Import", "InviteToMobileDemoApplication", "Launch", "LaunchVersion", "Lock", "Login", "Logout", "Merge", "Pause", "Remove", "Request", "Restore", "Schedule", "Sent", "StopVersion", "Successful", "Unlock", "Update", "Updated", "Unsuccessful", "Verify" ], "title":"Action" }, "40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.Item":{ "type":"string", "enum":[ "TFA", "Account", "ApiKey", "AutomaticPayment", "BillingAddress", "Blacklist", "Campaign", "Communication", "Company", "CustomField", "Domain", "ExportConfiguration", "Forms", "Keyword", "MobileApplication", "MobileDemoApplication", "Number", "OneTimePayment", "Password", "Person", "Price", "Report", "Segment", "Search", "Tag", "Team", "Template", "URL", "User", "Website" ], "title":"Item" }, "40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.RequestError":{ "type":"object", "additionalProperties":false, "properties":{ "serviceException":{ "$ref":"#/components/schemas/40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.ServiceException" } }, "title":"RequestError" }, "40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.SearchResult":{ "type":"object", "additionalProperties":false, "properties":{ "action":{ "type":[ "string", "null" ], "description":"User's action." }, "description":{ "type":[ "string", "null" ], "description":"Description of an action." }, "id":{ "type":[ "string", "null" ], "description":"Unique ID of an action." }, "ipAddress":{ "type":[ "string", "null" ], "description":"User's IP Address." }, "item":{ "type":[ "string", "null" ], "description":"Entity on which action is executed." }, "timestamp":{ "type":"string", "format":"date-time", "description":"Exact time when user executed an action." }, "username":{ "type":[ "string", "null" ], "description":"Username of the user who executed the action." } }, "title":"SearchResult" }, "40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.ServiceException":{ "type":"object", "additionalProperties":false, "properties":{ "messageId":{ "type":[ "string", "null" ], "description":"Identifier of the error." }, "text":{ "type":[ "string", "null" ], "description":"Detailed error description." }, "validationErrors":{ "type":[ "array", "null" ], "description":"Validation errors.", "items":{ "$ref":"#/components/schemas/40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.ValidationError" } } }, "title":"ServiceException" }, "40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.ValidationError":{ "type":"object", "additionalProperties":false, "properties":{ "error":{ "type":[ "string", "null" ] }, "fieldName":{ "type":[ "string", "null" ] } }, "title":"ValidationError" }, "66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.AccountBalance":{ "type":"object", "properties":{ "balance":{ "type":"number" }, "currency":{ "type":"string" } }, "title":"AccountBalance" }, "66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.BalanceInfoResponse":{ "type":"object", "properties":{ "balance":{ "type":"number" }, "allowedMinus":{ "type":"number" }, "monthlyLimit":{ "type":"number" }, "monthlyBalance":{ "type":"number" }, "currency":{ "$ref":"#/components/schemas/66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.SimpleCurrencyInfo" }, "freeMessages":{ "type":"object", "additionalProperties":{ "type":"integer", "format":"int32" } } }, "title":"BalanceInfoResponse" }, "66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.FreeMessagesResponse":{ "type":"object", "properties":{ "remainingCount":{ "type":"integer", "format":"int32" } }, "title":"FreeMessagesResponse" }, "66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.SimpleCurrencyInfo":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int32" }, "code":{ "type":"string" }, "currencyName":{ "type":"string" }, "symbol":{ "type":"string" } }, "title":"SimpleCurrencyInfo" }, "ApiError":{ "type":"object", "properties":{ "errorCode":{ "type":"string", "description":"An error code uniquely identifying the error case." }, "description":{ "type":"string", "description":"A detailed description of an error." }, "action":{ "type":"string", "description":"An action that should be taken to recover from the error." }, "violations":{ "type":"array", "description":"List of violations that caused the error.", "items":{ "$ref":"#/components/schemas/ApiErrorViolation" } }, "resources":{ "type":"array", "description":"List of available resources to recover from the error.", "items":{ "$ref":"#/components/schemas/ApiErrorResource" } } }, "required":[ "action", "description", "errorCode", "resources", "violations" ], "title":"ApiError" }, "ApiErrorResource":{ "type":"object", "description":"List of available resources to recover from the error.", "properties":{ "name":{ "type":"string", "description":"Resource name." }, "url":{ "type":"string", "description":"Resource URL." } }, "title":"ApiErrorResource" }, "ApiErrorViolation":{ "type":"object", "description":"List of violations that caused the error.", "properties":{ "property":{ "type":"string", "description":"Request property that caused the error." }, "violation":{ "type":"string", "description":"Detailed violation description." } }, "title":"ApiErrorViolation" }, "ApiException":{ "type":"object", "properties":{ "requestError":{ "$ref":"#/components/schemas/ApiRequestError" } }, "title":"ApiException" }, "ApiRequestError":{ "type":"object", "properties":{ "serviceException":{ "$ref":"#/components/schemas/ApiRequestErrorDetails" } }, "title":"ApiRequestError" }, "ApiRequestErrorDetails":{ "type":"object", "properties":{ "messageId":{ "type":"string", "description":"Identifier of the error." }, "text":{ "type":"string", "description":"Detailed error description." }, "validationErrors":{ "type":"object", "additionalProperties":{ "type":"array", "description":"Validation errors.", "items":{ "type":"string", "description":"Validation errors." } }, "description":"Validation errors." } }, "title":"ApiRequestErrorDetails" }, "b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.GrantType":{ "type":"string", "description":"Grant type as defined by the OAuth framework.", "enum":[ "client_credentials", "authorization_code " ], "title":"GrantType" }, "b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.OAuthApiException":{ "type":"object", "properties":{ "error":{ "type":"string", "description":"Deprecated, use requestError field instead. Shows error message." }, "requestError":{ "$ref":"#/components/schemas/ApiRequestError" } }, "title":"OAuthApiException" }, "b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.TokenRequest":{ "type":"object", "description":"Request used for creating OAuth2 token.", "properties":{ "client_id":{ "type":"string", "description":"The username created when signing up with Infobip." }, "client_secret":{ "type":"string", "description":"The password created when signing up with Infobip." }, "grant_type":{ "type":"string", "allOf":[ { "$ref":"#/components/schemas/b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.GrantType" } ], "description":"Grant type as defined by the OAuth framework." }, "code":{ "type":"string", "description":"Authorization code received from the authorization server. This parameter is required only if the `grant_type` is set to `authorization_code`." } }, "required":[ "client_id", "client_secret", "grant_type" ], "title":"TokenRequest" }, "b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.TokenResponse":{ "type":"object", "description":"Successful response that indicates OAuth2 token was created.", "properties":{ "access_token":{ "type":"string", "description":"OAuth2 token." }, "expires_in":{ "type":"integer", "format":"int32", "description":"OAuth2 token expiration in seconds." }, "token_type":{ "type":"string", "description":"OAuth2 token type." } }, "title":"TokenResponse" }, "bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Account":{ "type":"object", "properties":{ "key":{ "type":"string" }, "ownerKey":{ "type":"string" }, "name":{ "type":"string" }, "enabled":{ "type":"boolean" } }, "title":"Account" }, "bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.AccountsResponse":{ "type":"object", "properties":{ "accounts":{ "type":"array", "description":"List of accounts", "items":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Account" } } }, "title":"AccountsResponse" }, "bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Action":{ "type":"string", "description":"An optional action performed for an API request authenticated by this specific API key. The `FILL` option is used when an API endpoint inserts linked Application and Entity IDs into a request, if missing. The `FORCE` option is used when an API endpoint overrides linked Application and Entity IDs with the ones from this platform. If the action is left blank, the API endpoint will only perform an authorization check without injecting values into the request.", "enum":[ "FILL", "FORCE" ], "title":"Action" }, "bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKey":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Unique identifier specifying this api key." }, "apiKeySecret":{ "type":"string", "description":"Authentication key. Use this value for authentication on API. Keep this in secure storage and don't share it." }, "accountId":{ "type":"string", "description":"Unique identifier for account this API key belongs to." }, "name":{ "type":"string", "description":"Name of this API Key." }, "allowedIPs":{ "type":"array", "description":"List of allowed IP addresses from which this API key will be used. Authentication will fail from any other IP not specified in this list.", "items":{ "type":"string", "description":"List of allowed IP addresses from which this API key will be used. Authentication will fail from any other IP not specified in this list." } }, "validFrom":{ "type":"string", "format":"date-time", "description":"Date from which this API key is/will be valid. Time is in UTC." }, "validTo":{ "type":"string", "format":"date-time", "description":"Date until this API key will be valid. Time is in UTC." }, "enabled":{ "type":"boolean", "description":"Is API key enabled." }, "permissions":{ "type":"array", "description":"List of permissions this API key has granted.", "items":{ "type":"string", "description":"List of permissions this API key has granted." }, "uniqueItems":true }, "platform":{ "type":"array", "description":"A collection of CPaaS X Applications and/or Entities associated with the API Key", "items":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Platform" } }, "scopeGuids":{ "type":"array", "description":"List of Scopes assigned to API Key", "items":{ "type":"string", "description":"List of Scopes assigned to API Key" }, "uniqueItems":true } }, "required":[ "name" ], "title":"ApiKey" }, "bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeyResponse":{ "type":"object", "properties":{ "key":{ "type":"string", "description":"Unique key specifying this api key." }, "publicApiKey":{ "type":"string", "description":"Authentication key. Use this value for authentication on API. Keep this in secure storage and don't share it." }, "accountKey":{ "type":"string", "description":"Unique identifier for account this API key belongs to." }, "name":{ "type":"string", "description":"Name of this API Key." }, "allowedIPs":{ "type":"array", "description":"List of allowed IP addresses from which this API key will be used. Authentication will fail from any other IP not specified in this list.", "items":{ "type":"string", "description":"List of allowed IP addresses from which this API key will be used. Authentication will fail from any other IP not specified in this list." } }, "validFrom":{ "type":"string", "format":"date-time", "description":"Date from which this API key is/will be valid. Time is in UTC." }, "validTo":{ "type":"string", "format":"date-time", "description":"Date until this API key will be valid. Time is in UTC." }, "enabled":{ "type":"boolean", "description":"Is API key enabled." }, "permissions":{ "type":"array", "description":"List of permissions this API key has granted.", "items":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Permission" } } }, "required":[ "name" ], "title":"ApiKeyResponse" }, "bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeys":{ "type":"object", "properties":{ "apiKeys":{ "type":"array", "description":"List of API keys", "items":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeyResponse" } } }, "title":"ApiKeys" }, "bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.CreateApiKeyRequest":{ "type":"object", "properties":{ "accountId":{ "type":"string", "description":"Unique identifier for account this API key will belong to. If not provided accountId of the user making the API request will be set. CPaaSX Applications and Entities can be set only on api keys that belong to the account of the user making the request and only if that account is main account." }, "name":{ "type":"string", "description":"Name of this API Key." }, "allowedIPs":{ "type":"array", "description":"List of IP addresses or IP ranges from which this API key will be used. Authentication will fail from any other IP not specified in this list.", "externalDocs":{ "description":"It is recommended to set up AllowedIPs by security recommendations", "url":"https://www.infobip.com/docs/essentials/security-recommendations#entry-point-specific-users" }, "items":{ "type":"string", "description":"List of IP addresses or IP ranges from which this API key will be used. Authentication will fail from any other IP not specified in this list.", "externalDocs":{ "description":"It is recommended to set up AllowedIPs by security recommendations", "url":"https://www.infobip.com/docs/essentials/security-recommendations#entry-point-specific-users" } } }, "validFrom":{ "type":"string", "format":"date-time", "description":"Date from which this API key will be valid. Time is in UTC. Should not be earlier than creation date. If not provided default is date of creation." }, "validTo":{ "type":"string", "format":"date-time", "description":"Date until this API key will be valid. Time is in UTC. Should not be earlier than validFrom or creation time. If not provided default is 1 year from creation." }, "permissions":{ "type":"array", "description":"List of permissions this API key has granted. Default permission is 'PUBLIC_API'. API key cannot be created with both 'PUBLIC_API' and 'WEB_SDK' permissions. API key cannot be created with both permissions and a collection of Applications and/or Entities in platform.", "enum":[ "PUBLIC_API", "2FA_CLIENT", "WEB_SDK" ], "items":{ "type":"string", "description":"List of permissions this API key has granted. Default permission is 'PUBLIC_API'. API key cannot be created with both 'PUBLIC_API' and 'WEB_SDK' permissions. API key cannot be created with both permissions and a collection of Applications and/or Entities in platform.", "enum":[ "PUBLIC_API", "2FA_CLIENT", "WEB_SDK" ] } }, "platform":{ "type":"array", "description":"A collection of CPaaS X Applications and Entities that will be linked to the API Key. API key cannot be created with both permissions and a collection of Applications and/or Entities.", "externalDocs":{ "description":"API Key will only have access to these endpoints.", "url":"https://www.infobip.com/docs/cpaas-x/application-and-entity-management#api-keys-endpoints-list-api-keys-with-application-and-entity" }, "items":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Platform" } }, "scopeGuids":{ "type":"array", "description":"List of [API scopes](https://www.infobip.com/docs/essentials/api-essentials/api-authorization#available-api-scopes-api-scopes) that will be assigned to the API key.", "items":{ "type":"string", "description":"List of [API scopes](https://www.infobip.com/docs/essentials/api-essentials/api-authorization#available-api-scopes-api-scopes) that will be assigned to the API key." }, "uniqueItems":true } }, "required":[ "name" ], "title":"CreateApiKeyRequest" }, "bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.CreateApiKeyRequestV1":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Name of the API key" }, "allowedIPs":{ "type":"array", "description":"List of IP addresses or IP ranges from which this API key will be used. Authentication will fail from any other IP not specified in this list.", "items":{ "type":"string", "description":"List of IP addresses or IP ranges from which this API key will be used. Authentication will fail from any other IP not specified in this list." } }, "validTo":{ "type":"string", "format":"date-time", "description":"Date from which this API key is/will be valid. Time is in UTC" }, "validFrom":{ "type":"string", "format":"date-time", "description":"Date until this API key will be valid. Time is in UTC." }, "enabled":{ "type":"boolean", "description":"Only enabled API keys will be accepted. When revoking existing API key, this property can be set to false." }, "permissions":{ "type":"array", "description":"List of permissions this API key has granted. Default permission is 'ALL'. This data may be inaccurate. Migrate to new API key management endpoints and use API scopes for fine grained control.", "items":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Permission" } } }, "required":[ "name" ], "title":"CreateApiKeyRequestV1" }, "bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.CreateSessionRequest":{ "type":"object", "properties":{ "username":{ "type":"string", "description":"Username of the user." }, "password":{ "type":"string", "description":"Password of the user." }, "unsafe":{ "type":"boolean", "description":"Create session which is not bound to IP." } }, "required":[ "password", "username" ], "title":"CreateSessionRequest" }, "bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.GetApiKeysResponse":{ "type":"object", "properties":{ "apiKeys":{ "type":"array", "description":"List of API keys.", "items":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKey" } }, "paging":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.PagingResponse" } }, "required":[ "paging" ], "title":"GetApiKeysResponse" }, "bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.PagingResponse":{ "type":"object", "properties":{ "page":{ "type":"integer", "format":"int32" }, "pageSize":{ "type":"integer", "format":"int32" }, "orderDirection":{ "type":"string" }, "orderBy":{ "type":"string" }, "totalCount":{ "type":"integer", "format":"int64" }, "totalPages":{ "type":"integer", "format":"int32" } }, "title":"PagingResponse" }, "bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Permission":{ "type":"string", "description":"List of permissions this API key has granted. This data may be inaccurate. Migrate to new API key management endpoints and use API scopes for fine grained control.", "enum":[ "ALL", "TFA", "PUSH_CLIENT", "PEOPLE_EVENTS_PUBLIC_CLIENT", "EXTERNAL_INTEGRATIONS" ], "title":"Permission" }, "bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Platform":{ "type":"object", "description":"A collection of CPaaS X Applications and Entities that will be linked to the API key. All Applications and Entities will be removed from the api key if an empty platform list is sent and 'PUBLIC_API' will be assigned as default permission. Or, to remove a specific Application/Entity pair, omit it from the platform list.", "externalDocs":{ "description":"WARNING: linking an existing API Key to an Application and/or Entity will limit access to these endpoints.", "url":"https://www.infobip.com/docs/cpaas-x/application-and-entity-management#api-keys-endpoints-list-api-keys-with-application-and-entity" }, "properties":{ "key":{ "type":"string", "description":"Unique identifier of application and/or entity association.", "readOnly":true }, "applicationId":{ "type":"string", "description":"ID of a CPaaS X Application. Once linked to an Application, the API key can only be used to send messages using linked Applications. Mandatory for every Application and/or Entity pair. Use the default value to reference a default Application. Use an existing Application created using [create-application endpoint](https://www.infobip.com/docs/api/platform/application-entity/create-application) or specify a new applicationId to create a new Application." }, "entityId":{ "type":"string", "description":"ID of a CPaaS X Entity. Once linked to an Entity, the API key can only be used to send messages using linked Entities. Use an existing Entity created using [create-entity endpoint](https://www.infobip.com/docs/api/platform/application-entity/create-entity) or specify a new entityId to create a new Entity." }, "action":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Action" } }, "required":[ "applicationId" ], "title":"Platform" }, "bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Session":{ "type":"object", "properties":{ "token":{ "type":"string", "description":"Session with Token" } }, "title":"Session" }, "bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.UpdateAccountRequest":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"New name for the account" }, "enabled":{ "type":"boolean", "description":"Enable or disable the account" } }, "title":"UpdateAccountRequest" }, "bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.UpdateApiKeyRequest":{ "type":"object", "properties":{ "accountId":{ "type":"string", "description":"Unique identifier for account this API key belongs to. If not provided accountId of the user making the API request will be set. CPaaSX Applications and Entities can be set only on api keys that belong to the account of the user making the request and only if that account is main account." }, "name":{ "type":"string", "description":"Name of this API Key." }, "allowedIPs":{ "type":"array", "description":"List of IP addresses or IP ranges from which this API key will be used. Authentication will fail from any other IP not specified in this list.", "externalDocs":{ "description":"It is recommended to set up AllowedIPs by security recommendations", "url":"https://www.infobip.com/docs/essentials/security-recommendations#entry-point-specific-users" }, "items":{ "type":"string", "description":"List of IP addresses or IP ranges from which this API key will be used. Authentication will fail from any other IP not specified in this list.", "externalDocs":{ "description":"It is recommended to set up AllowedIPs by security recommendations", "url":"https://www.infobip.com/docs/essentials/security-recommendations#entry-point-specific-users" } } }, "validFrom":{ "type":"string", "format":"date-time", "description":"Date from which this API key is/will be valid. Time is in UTC." }, "validTo":{ "type":"string", "format":"date-time", "description":"Date until this API key will be valid. Time is in UTC." }, "enabled":{ "type":"boolean", "description":"Enable or disable API key." }, "permissions":{ "type":"array", "description":"List of permissions this API key has granted. Default permission is 'PUBLIC_API'. API key cannot be created with both 'PUBLIC_API' and WEB_SDK permissions. API key cannot be updated with both permissions and a collection of Applications and/or Entities in platform. If an empty list is sent all current permissions assigned to api key will be removed and 'PUBLIC_API' will be set as default.", "enum":[ "PUBLIC_API", "2FA_CLIENT", "WEB_SDK" ], "items":{ "type":"string", "description":"List of permissions this API key has granted. Default permission is 'PUBLIC_API'. API key cannot be created with both 'PUBLIC_API' and WEB_SDK permissions. API key cannot be updated with both permissions and a collection of Applications and/or Entities in platform. If an empty list is sent all current permissions assigned to api key will be removed and 'PUBLIC_API' will be set as default.", "enum":[ "PUBLIC_API", "2FA_CLIENT", "WEB_SDK" ] } }, "platform":{ "type":"array", "description":"A collection of CPaaS X Applications and Entities that will be linked to the API key. All Applications and Entities will be removed from the api key if an empty platform list is sent and 'PUBLIC_API' will be assigned as default permission. Or, to remove a specific Application/Entity pair, omit it from the platform list.", "externalDocs":{ "description":"WARNING: linking an existing API Key to an Application and/or Entity will limit access to these endpoints.", "url":"https://www.infobip.com/docs/cpaas-x/application-and-entity-management#api-keys-endpoints-list-api-keys-with-application-and-entity" }, "items":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Platform" } }, "scopeGuids":{ "type":"array", "description":"List of [API scopes](https://www.infobip.com/docs/essentials/api-essentials/api-authorization#available-api-scopes-api-scopes) that will be assigned to the API key. An API key cannot be updated with both scopes and a collection of Applications and/or Entities in platform. If an empty list is sent, all current scopes assigned to the API Key will be removed and it will no longer be able to access any API endpoint.", "items":{ "type":"string", "description":"List of [API scopes](https://www.infobip.com/docs/essentials/api-essentials/api-authorization#available-api-scopes-api-scopes) that will be assigned to the API key. An API key cannot be updated with both scopes and a collection of Applications and/or Entities in platform. If an empty list is sent, all current scopes assigned to the API Key will be removed and it will no longer be able to access any API endpoint." }, "uniqueItems":true } }, "title":"UpdateApiKeyRequest" }, "bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.UpdateApiKeyRequestV1":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Api key name" }, "enabled":{ "type":"boolean", "description":"Enable or disable api key." }, "allowedIPs":{ "type":"array", "description":"List of allowed IP addresses from which this API key can be used", "items":{ "type":"string", "description":"List of allowed IP addresses from which this API key can be used" } }, "validFrom":{ "type":"string", "format":"date-time", "description":"Date from which this API key is/will be valid. Time is in UTC." }, "validTo":{ "type":"string", "format":"date-time", "description":"Date until this API key will be valid. Time is in UTC." }, "permissions":{ "type":"array", "description":"List of permissions this API key has granted. This data may be inaccurate. Migrate to new API key management endpoints and use API scopes for fine grained control.", "items":{ "$ref":"#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Permission" } } }, "title":"UpdateApiKeyRequestV1" } }, "responses":{ "ApiError400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[], "resources":[] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E400\n Request cannot be processed.\n Check the syntax, violations and adjust the request.\n \n \n\n" } } }, "ApiError401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E401", "description":"The request lacks valid authentication credentials for the requested resource.", "action":"Check the resources and adjust authentication credentials.", "violations":[], "resources":[ { "name":"API Authentication", "url":"https://www.infobip.com/docs/essentials/api-authentication" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E401\n The request lacks valid authentication credentials for the requested resource.\n Check the resources and adjust authentication credentials.\n \n \n \n API Authentication\n https://www.infobip.com/docs/essentials/api-authentication\n \n \n\n" } } }, "ApiError403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E403", "description":"Insufficient permissions to access the requested resource.", "action":"Repeat the request with new or different credentials.", "violations":[], "resources":[ { "name":"API Scopes", "url":"https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E403\n Insufficient permissions to access the requested resource.\n Repeat the request with new or different credentials.\n \n \n \n API Scopes\n https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes\n \n \n\n" } } }, "ApiError404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E404", "description":"Not found - request URL doesn't exist on the API server or resource is not found.", "action":"Check the resources and adjust your request.", "violations":[], "resources":[] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E404\n Not found - request URL doesn't exist on the API server or resource is not found.\n Check the resources and adjust your request.\n \n \n\n" } } }, "ApiError429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E429", "description":"Too many requests sent.", "action":"Check request rate limit specified in the API endpoint documentation resource.", "violations":[], "resources":[ { "name":"Throttling handling errors", "url":"https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E429\n Too many requests sent.\n Check request rate limit specified in the API endpoint documentation resource.\n \n \n \n Throttling handling errors\n https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors\n \n \n\n" } } }, "ApiError500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E500", "description":"Something went wrong.", "action":"Contact the support.", "violations":[], "resources":[] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E500\n Something went wrong.\n Contact the support.\n \n \n\n" } } }, "ApiException400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n" } } }, "ApiException401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"UNAUTHORIZED", "text":"Unauthorized" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n UNAUTHORIZED\n Unauthorized\n \n \n\n" } } }, "ApiException403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"FORBIDDEN", "text":"Forbidden" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n FORBIDDEN\n Forbidden\n \n \n\n" } } }, "ApiException404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n NOT_FOUND\n Not found\n \n \n\n" } } }, "ApiException429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n TOO_MANY_REQUESTS\n Too many requests\n \n \n\n" } } }, "ApiException500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"GENERAL_ERROR", "text":"Something went wrong. Please contact support." } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n GENERAL_ERROR\n Something went wrong. Please contact support.\n \n \n\n" } } } }, "parameters":{}, "examples":{}, "requestBodies":{}, "headers":{}, "securitySchemes":{ "APIKeyHeader":{ "type":"apiKey", "description":"This is the most secure authorization type and the one with the most flexibility.\n\nAPI keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can\nbe revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases.\nFinally, the loss of an API key is easily manageable.\n\nYou can manage your API keys from [GUI](https://portal.infobip.com/settings/accounts/api-keys), or programmatically\nwith [dedicated API](#platform-&-connectivity/settings).\n\nAPI key Authorization header example:\n\n```shell\nAuthorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9\n```\n", "name":"Authorization", "in":"header" }, "Basic":{ "type":"http", "description":"Basic authorization type can be used in situations when the API key is not available. For example, API methods for generating API keys should be authenticated\nwith the Basic type.\n\nIn this case, the credentials included in the Authorization header should be a Base64 encoded username and password combination. More formally, basic\nauthentication header can be constructed in three steps:\n\n* Username and password are concatenated using the colon `(:)` as a separator `username:password`.\n* The resulting string is encoded using the [RFC2045-MIME](https://www.ietf.org/rfc/rfc2045.txt) variant of Base64.\n* Encoded string is added as credentials after the `\"Basic \"` type.\n\nExample:\n\n```shell\nUsername: \"Aladdin\"\nPassword: \"openSesame\"\n\nConcatenated string: \"Aladdin:openSesame\"\n\nBase64 encoded string: \"QWxhZGRpbjpvcGVuU2VzYW1l\"\n\nAuthorization header: \"Basic QWxhZGRpbjpvcGVuU2VzYW1l\"\n```\n\n> **Implementation detail**: Base64 encoding is a standard and many available programming languages and frameworks provide convenient methods for encoding\n> strings.\n", "scheme":"basic" }, "IBSSOTokenHeader":{ "type":"apiKey", "description":"This authorization type is suited for situations when you do not want to store Infobip credentials in your own app. Instead, your users will input their Infobip\ncredentials every time they access your application and the application will use those credentials to create a session. From then on, the session token can be\nused to authenticate subsequent API requests. Note that the session will expire automatically after a predefined period of inactivity, and can also be manually\nterminated by making an appropriate API call.\n\nYou can find more details on the creation and behavior of the session at\nthe [dedicated documentation page](#platform-connectivity/account-management/create-session).\n\nAfter obtaining the session token by calling the above-referenced API method you can include it in the Authorization header like this:\n\n```shell\nAuthorization: IBSSO 2f9b4d31-2d0d-49a8-85f0-9b862bdca394\n```\n", "name":"Authorization", "in":"header" }, "OAuth2":{ "type":"oauth2", "description":"Similarly to the IBSSO Token authentication you can use OAuth 2.0 bearer token with Infobip serving both as resource and authorization server. You can obtain\nthe access token using the client credentials grant from `auth/1/oauth2/token` endpoint. It will provide you with your access token, and its expiration period.\nYou can use the token to authorize your API calls until it expires. You can find out more about the process in\nthe [official specification](https://tools.ietf.org/html/rfc6749#section-4.4).\n\nYou can include your access token in the Authorization HTTP request header like this:\n\n```http\nAuthorization: Bearer \n```", "flows":{ "clientCredentials":{ "tokenUrl":"https://api.infobip.com/auth/1/oauth2/token", "scopes":{} } } } }, "links":{}, "callbacks":{} } }