{ "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:23:57.84094823Z" }, "tags":[ { "name":"platform", "description":"Modular tools to scale and automate your business.\n", "x-type":"category", "x-displayName":"Platform" }, { "name":"subscriptions-api", "description":"Subscriptions are a way to manage notifications sent to your webhooks by Infobip.\nIt is a useful feature if you want to narrow down the list of events to be notified about or specify different webhooks for different use cases.\nIt will also allow you to set up authentication settings for your endpoint.\n\nIf you want to use mutual TLS for the webhook that receives notification events from Infobip, you can upload and manage a TLS certificate that Infobip will use when connecting to your server. The certificate allows your server to verify that the request is really coming from Infobip. For details, see [Create and Manage Certificates](https://www.infobip.com/docs/cpaas-x/subscriptions-management/create-manage-subscriptions#create-and-manage-certificates).\n", "x-type":"product", "x-displayName":"Subscriptions Management" }, { "name":"subscription", "description":"", "x-type":"section", "x-displayName":"Subscription" }, { "name":"profile", "description":"", "x-type":"section", "x-displayName":"Profile" }, { "name":"security", "description":"", "x-type":"section", "x-displayName":"Security" }, { "name":"certificate", "description":"", "x-type":"section", "x-displayName":"Certificate" } ], "paths":{ "/subscriptions/1/subscription/{channel}":{ "get":{ "tags":[ "platform", "subscriptions-api", "subscription" ], "summary":"Get subscriptions", "description":"Returns a list of all subscriptions for the specified channel with pagination. By default, the result is sorted by creation date in descending order.
The search can be used with various criteria passed via query parameters (all criteria combinations have AND semantic).
Note.To avoid validation errors and inconsistent results query parameters need to be encoded (see RFC 3986, section 2.1).
Example. Find subscriptions having applications 'app1' and 'app2', and the resource '100200300400'.
/subscriptions/1/subscription/SMS?applicationId=app1&applicationId=app2&resource=100200300400
", "operationId":"get-subscriptions", "parameters":[ { "name":"channel", "in":"path", "description":"Channel name. A separate subscription is needed for each channel.", "required":true, "style":"simple", "explode":false, "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionChannel" } }, { "name":"page", "in":"query", "description":"Results page to retrieve (0..N).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":0, "minimum":0 } }, { "name":"size", "in":"query", "description":"Number of records per page.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":20, "maximum":100, "minimum":1 } }, { "name":"applicationId", "in":"query", "description":"CPaaS-X application identifier.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "maxLength":255, "minLength":1 } }, { "name":"entityId", "in":"query", "description":"CPaaS-X entity identifier.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "maxLength":255, "minLength":1 } }, { "name":"callsConfigurationId", "in":"query", "description":"Calls configuration identifier.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "maxLength":128, "minLength":1 } }, { "name":"resource", "in":"query", "description":"Resource.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "maxLength":255, "minLength":1 } }, { "name":"user", "in":"query", "description":"User.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "maxLength":255, "minLength":1 } } ], "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionPage" } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "description":"Too many requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ] }, "post":{ "tags":[ "platform", "subscriptions-api", "subscription" ], "summary":"Create subscription", "description":"This method will create a new subscription. You can provide an ID of an existing profile, or submit a full definition of a profile and security settings if you want to create new ones.", "operationId":"create-subscription", "parameters":[ { "name":"channel", "in":"path", "description":"Channel name. A separate subscription is needed for each channel.", "required":true, "style":"simple", "explode":false, "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionChannel" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "subscriptionId":"ABC-123-DEF", "name":"Default group", "events":[ "DELIVERY" ], "criteria":[ { "applicationId":"production", "entityId":"entity1" }, { "applicationId":"production", "entityId":"entity2" }, { "applicationId":"test", "entityId":"entity1" } ], "resources":[ "1234" ], "users":[ "user1", "user2" ], "profile":{ "profileId":"NOTIF-32395", "webhook":{ "notifyUrl":"https://www.example.com/pushme" }, "security":{ "authId":"NEWAUTH-9291", "type":"BASIC", "credentials":{ "username":"user1", "password":"password1" } } } } } } } }, "required":true }, "responses":{ "201":{ "description":"Created.", "headers":{ "Location":{ "description":"Resource location.", "style":"simple", "explode":false, "schema":{ "type":"string" } } }, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySubscriptionResponse" } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "description":"Too many requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ] } }, "/subscriptions/1/subscription/{channel}/{subscriptionId}":{ "get":{ "tags":[ "platform", "subscriptions-api", "subscription" ], "summary":"Get single subscription", "description":"Returns a specific subscription by ID.", "operationId":"get-subscription", "parameters":[ { "name":"subscriptionId", "in":"path", "description":"ID of the subscription you want to get.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"channel", "in":"path", "description":"Channel name. A separate subscription is needed for each channel.", "required":true, "style":"simple", "explode":false, "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionChannel" } } ], "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "subscriptionId":"ABC-123-DEF", "name":"Default group", "profile":{ "profileId":"NOTIF-32395", "security":{ "authId":"NEWAUTH-9291" } }, "events":[ "DELIVERY" ], "criteria":[ { "applicationId":"production", "entityId":"entity1" }, { "applicationId":"production", "entityId":"entity2" }, { "applicationId":"test", "entityId":"entity1" } ], "resources":[ "1234" ], "users":[ "user1", "user2" ] } }, "Set new profile for group response example":{ "summary":"Set new profile for group response example", "value":{ "subscriptionId":"ABC-123-DEF", "name":"Default group", "profile":{ "profileId":"NOTIF-12345", "security":{ "authId":"NEWAUTH-9291" } }, "events":[ "DELIVERY" ], "criteria":[ { "applicationId":"production", "entityId":"entity1" }, { "applicationId":"production", "entityId":"entity2" }, { "applicationId":"test", "entityId":"entity1" } ], "resources":[ "1234" ], "users":[ "user1", "user2" ] } }, "Edit group and switch profile response example":{ "summary":"Edit group and switch profile response example", "value":{ "subscriptionId":"ABC-123-DEF", "name":"Updated group", "profile":{ "profileId":"NOTIF-98765", "security":{ "authId":"NEWAUTH-9999" } }, "events":[ "DELIVERY" ], "criteria":[ { "applicationId":"production", "entityId":"entity1" }, { "applicationId":"production", "entityId":"entity2" }, { "applicationId":"test", "entityId":"entity1" } ], "resources":[ "1234" ], "users":[ "user1", "user2" ] } } } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "description":"Too many requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ] }, "put":{ "tags":[ "platform", "subscriptions-api", "subscription" ], "summary":"Update subscription", "description":"This method allows you to update the subscription. You can change its properties and provide an ID of a profile if you wish to change it.", "operationId":"update-subscription", "parameters":[ { "name":"subscriptionId", "in":"path", "description":"ID of the subscription you want to modify.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"channel", "in":"path", "description":"Channel name. A separate subscription is needed for each channel.", "required":true, "style":"simple", "explode":false, "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionChannel" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NoIdSubscriptionRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "name":"Updated group", "profile":{ "profileId":"NOTIF-98765" }, "events":[ "DELIVERY" ], "criteria":[ { "applicationId":"production", "entityId":"entity1" }, { "applicationId":"production", "entityId":"entity2" }, { "applicationId":"test", "entityId":"entity1" } ], "resources":[ "1234" ], "users":[ "user1", "user2" ] } } } } }, "required":true }, "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySubscriptionResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "subscriptionId":"ABC-123-DEF", "profile":{ "profileId":"NOTIF-32395", "security":{ "authId":"NEWAUTH-9291" } } } } } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "description":"Too many requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ] }, "delete":{ "tags":[ "platform", "subscriptions-api", "subscription" ], "summary":"Delete subscription", "description":"This method will delete the subscription specified by ID.", "operationId":"delete-subscription", "parameters":[ { "name":"subscriptionId", "in":"path", "description":"ID of the subscription you want to delete.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"channel", "in":"path", "description":"Channel name. A separate subscription is needed for each channel.", "required":true, "style":"simple", "explode":false, "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionChannel" } } ], "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySubscriptionResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "subscriptionId":"ABC-123-DEF", "profile":{ "profileId":"NOTIF-32395", "security":{ "authId":"NEWAUTH-9291" } } } } } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "description":"Too many requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ] } }, "/subscriptions/1/profiles":{ "get":{ "tags":[ "platform", "subscriptions-api", "profile" ], "summary":"Get notification profiles", "description":"Returns a list of all notification profiles for your account with pagination.", "operationId":"get-profiles", "parameters":[ { "name":"page", "in":"query", "description":"Results page to retrieve (0..N).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":0, "minimum":0 } }, { "name":"size", "in":"query", "description":"Number of records per page.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":20, "maximum":100, "minimum":1 } } ], "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfilePage" } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "description":"Too many requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ] }, "post":{ "tags":[ "platform", "subscriptions-api", "profile" ], "summary":"Create notification profile", "description":"This method will create a new notification profile. You can provide an ID of existing security settings if you wish to reuse them or submit full definition, if you want to create a new one.", "operationId":"create-profile", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "profileId":"NOTIF-32395", "webhook":{ "notifyUrl":"https://www.example.com/pushme" }, "security":{ "authId":"NEWAUTH-9291", "type":"BASIC", "credentials":{ "username":"user1", "password":"password1" } }, "clientCertificateId":"MYCERT-1337", "maxBucketSize":1, "windowSize":20, "connectTimeout":10000, "readTimeout":10000, "enabledSSLProtocols":[ "TLSv1.3", "TLSv1.2" ], "headers":{ "X-Important-Header":"Important Value" }, "responseRegex":"[1-9][0-9]", "responseBodyRegex":"[1-9][0-9]", "rateLimit":5000 } } } } }, "required":true }, "responses":{ "201":{ "description":"Created.", "headers":{ "Location":{ "description":"Resource location.", "style":"simple", "explode":false, "schema":{ "type":"string" } } }, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileResponse" } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "description":"Too many requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ] } }, "/subscriptions/1/profiles/{profileId}":{ "get":{ "tags":[ "platform", "subscriptions-api", "profile" ], "summary":"Get single notification profile", "description":"Returns a specific notification profile by ID.", "operationId":"get-profile", "parameters":[ { "name":"profileId", "in":"path", "description":"Notification profile ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "profileId":"NOTIF-32395", "webhook":{ "contentType":"application/json", "notifyUrl":"https://www.example.com/pushme" }, "security":{ "authId":"NEWAUTH-9291" }, "maxBucketSize":1, "windowSize":20, "connectTimeout":10000, "readTimeout":10000, "enabledSSLProtocols":[ "TLSv1.3", "TLSv1.2" ], "headers":{ "X-Important-Header":"Important Value" }, "responseRegex":"[1-9][0-9]", "responseBodyRegex":"[1-9][0-9]", "rateLimit":5000 } } } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "description":"Too many requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ] }, "put":{ "tags":[ "platform", "subscriptions-api", "profile" ], "summary":"Update notification profile", "description":"This method allows you to update a notification profile. You can change its properties and provide an ID of security settings if you wish to change them.", "operationId":"update-profile", "parameters":[ { "name":"profileId", "in":"path", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NoIdProfileRequest" }, "examples":{ "Set new security for an existing profile request example":{ "summary":"Set new security for an existing profile request example", "value":{ "webhook":{ "notifyUrl":"https://www.example.com/pushme" }, "security":{ "authId":"AUTH-123" }, "maxBucketSize":1, "windowSize":20, "connectTimeout":10000, "readTimeout":10000, "enabledSSLProtocols":[ "TLSv1.3", "TLSv1.2" ], "headers":{ "X-Important-Header":"Important Value" }, "responseRegex":"[1-9][0-9]", "responseBodyRegex":"[1-9][0-9]", "rateLimit":5000 } } } } }, "required":true }, "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "profileId":"NOTIF-32395", "security":{ "authId":"NEWAUTH-9291" } } } } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "description":"Too many requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ] }, "delete":{ "tags":[ "platform", "subscriptions-api", "profile" ], "summary":"Delete notification profile", "description":"This method will delete a notification profile specified by ID.", "operationId":"delete-profile", "parameters":[ { "name":"profileId", "in":"path", "description":"Notification profile ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "profileId":"NOTIF-32395", "security":{ "authId":"NEWAUTH-9291" } } } } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "description":"Too many requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ] } }, "/subscriptions/1/security":{ "get":{ "tags":[ "platform", "subscriptions-api", "security" ], "summary":"Get security settings", "description":"Returns a list of security settings for your account with pagination.", "operationId":"get-security-settings", "parameters":[ { "name":"page", "in":"query", "description":"Results page to retrieve (0..N).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":0, "minimum":0 } }, { "name":"size", "in":"query", "description":"Number of records per page.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":20, "maximum":100, "minimum":1 } } ], "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityPage" } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "description":"Too many requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ] }, "post":{ "tags":[ "platform", "subscriptions-api", "security" ], "summary":"Create security settings", "description":"This method will create new security settings.", "operationId":"create-security-settings", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "authId":"NEWAUTH-9291", "type":"BASIC", "credentials":{ "username":"user1", "password":"password1" } } } } } }, "required":true }, "responses":{ "201":{ "description":"Created.", "headers":{ "Location":{ "description":"Resource location.", "style":"simple", "explode":false, "schema":{ "type":"string" } } }, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityResponse" } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "description":"Too many requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ] } }, "/subscriptions/1/security/{authId}":{ "get":{ "tags":[ "platform", "subscriptions-api", "security" ], "summary":"Get single security settings", "description":"Returns specific security settings item by ID.", "operationId":"get-security-setting", "parameters":[ { "name":"authId", "in":"path", "description":"Security settings ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "authId":"NEWAUTH-9291", "type":"BASIC", "credentials":{ "username":"user1", "password":"password1" } } } } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "description":"Too many requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ] }, "put":{ "tags":[ "platform", "subscriptions-api", "security" ], "summary":"Update security settings", "description":"This method allows you to update the security settings.", "operationId":"update-security-settings", "parameters":[ { "name":"authId", "in":"path", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NoIdSecurityRequest" }, "examples":{ "Update request example":{ "summary":"Update request example", "value":{ "type":"BASIC", "credentials":{ "username":"user1", "password":"password1" } } } } } }, "required":true }, "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "authId":"NEWAUTH-9291" } } } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "description":"Too many requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ] }, "delete":{ "tags":[ "platform", "subscriptions-api", "security" ], "summary":"Delete security settings", "description":"This method will delete the security settings item by ID.", "operationId":"delete-security-settings", "parameters":[ { "name":"authId", "in":"path", "description":"Security settings ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "authId":"NEWAUTH-9291" } } } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "description":"Too many requests.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ] } }, "/subscriptions/1/certificates":{ "get":{ "tags":[ "platform", "subscriptions-api", "certificate" ], "summary":"Get filtered certificate details page", "description":"Returns a page containing certificates details by filtering condition.", "operationId":"get-certificates-details-page", "parameters":[ { "name":"search", "in":"query", "description":"Search filter. Limits returned results.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"page", "in":"query", "description":"Results page to retrieve (0..N).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":0, "minimum":0 } }, { "name":"size", "in":"query", "description":"Number of records per page.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":20, "maximum":100, "minimum":1 } }, { "name":"sortBy", "in":"query", "description":"Sorting parameter.", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificatesSortType" } }, { "name":"direction", "in":"query", "description":"Sorting direction.", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SortDirection" } } ], "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateDetailsPage" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "results":[ { "certificateId":"my-certificate-1", "issuedBy":"CN=Issuer LTD.,DC=abc,DC=issuer,DC=com", "issuedTo":"CN=subject.domain.com,O=Subject LTD.,L=Vodnjan,ST=Istria,C=HR", "validFrom":1655683200000, "validUntil":1687219200000, "certificateStatus":"READY", "serialNumber":"1605653657727226303992554724456686612151129941" } ], "paging":{ "page":0, "size":1, "totalPages":1, "totalResults":1 } } } } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"m" } ] }, "post":{ "tags":[ "platform", "subscriptions-api", "certificate" ], "summary":"Upload certificate", "description":"Upload the certificate Infobip will present for your webhook to verify Infobip when sending notification events.", "operationId":"upload-certificate", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateUploadRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "certificateId":"my-certificate-1", "certificateContent":"IyBQcml2YXRlIGtleSBvZiB0aGUgU1NMIGNlcnRpZmljYXRlCi0tLS0tQkVHSU4gUFJJVkFURSBLRVktLS0tLQpNSUlFdmdJQkFEQU5CZ2txaGtpRzl3MEJBUUVGQUFTQ0JLZ3dnZ1NrQWdFQUFvSUJBUURCajA4c3A1Kys0YW5HCmNtUXhKakFrQmdOVkJBb1RIVkJ5YjJkeVpYTnpJRk52Wm5SM1lYSmxJRU52Y25CdmNtRjBhVzl1TVNBd0hnWUQKVlFRRERCY3FMbUYzY3kxMFpYTjBMbkJ5YjJkeVpYTnpMbU52YlRDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRAouLi4KYm1sNllYUnBiMjUyWVd4emFHRXlaekl1WTNKc01JR2dCZ2dyQmdFRkJRY0JBUVNCa3pDQmtEQk5CZ2dyQmdFRgpCUWN3QW9aQmFIUjBjRG92TDNObFkzVnlaUzVuYkc5aVlXeHphV2R1TG1OdmJTOWpZV05sY25RdlozTnZjbWRoCnozUDY2OFlmaFViS2RSRjZTNDJDZzZ6bgotLS0tLUVORCBQUklWQVRFIEtFWS0tLS0tCgojIFB1YmxpYyBrZXkgb2YgdGhlIFNTTCBjZXJ0aWZpY2F0ZSAodGhlIHNlcnZlciBjZXJ0aWZpY2F0ZSkKLS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUZhRENDQkZDZ0F3SUJBZ0lTRVNIa3ZaRndLOVF6MEtzWEQzeDhwNDRhTUEwR0NTcUdTSWIzRFFFQkN3VUEKVlFRRERCY3FMbUYzY3kxMFpYTjBMbkJ5YjJkeVpYTnpMbU52YlRDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRApnZ0VQQURDQ0FRb0NnZ0VCQU1HUFR5eW5uNzdocWNZbmpXc013T1pEemRoVkZZOTNzMk9KbnRNYnVLVEhuMzlCCi4uLgpibWw2WVhScGIyNTJZV3h6YUdFeVp6SXVZM0pzTUlHZ0JnZ3JCZ0VGQlFjQkFRU0JrekNCa0RCTkJnZ3JCZ0VGCkJRY3dBb1pCYUhSMGNEb3ZMM05sWTNWeVpTNW5iRzlpWVd4emFXZHVMbU52YlM5allXTmxjblF2WjNOdmNtZGgKYm1sNllYUnBiMjUyWVd4emFHRXlaekp5TVM1amNuUXdQd1lJS3dZQkJRVUhNQUdHTTJoMGRIQTZMeTl2WTNOdwpsZmZ5Z0Q1SXltQ1N1dURpbTRxQi85Ymg3b2kzN2hlSjRPYnBCSXpyb1BVT3RoYkc0Z3YvNWJsVzNEYz0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQoKIyBUcnVzdCBjaGFpbiBpbnRlcm1lZGlhdGUgY2VydGlmaWNhdGUKLS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVhVENDQTFHZ0F3SUJBZ0lMQkFBQUFBQUJSRTd3UWtjd0RRWUpLb1pJaHZjTkFRRUxCUUF3VnpFTE1Ba0cKQzMzSmlKMVBpL0Q0bkd5TVZUWGJ2L0t6NnZ2alZ1ZEtSdGtUSXNvMjFadkJxT09XUTVQeURMem0rZWJvbWNoagpTSGgvVnpacEdoa2RXdEhVZmNLYzFIL2hnQkt1ZXVxSTZsZll5Z29LT2hKSm9tSVplZzBrOXpmcnRIT1Nld1VqCi4uLgpkSEJ6T2k4dmQzZDNMbWRzYjJKaGJITnBaMjR1WTI5dEwzSmxjRzl6YVhSdmNua3ZNRE1HQTFVZEh3UXNNQ293CktLQW1vQ1NHSW1oMGRIQTZMeTlqY213dVoyeHZZbUZzYzJsbmJpNXVaWFF2Y205dmRDNWpjbXd3UFFZSUt3WUIKSzFwcDc0UDFTOFNxdENyNGZLR3hoWlNNOUF5SERQU3NRUGhaU1pnPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCgojIFRydXN0IGNoYWluIHJvb3QgY2VydGlmaWNhdGUKLS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURkVENDQWwyZ0F3SUJBZ0lMQkFBQUFBQUJGVXRhdzVRd0RRWUpLb1pJaHZjTkFRRUZCUUF3VnpFTE1Ba0cKWVd4VGFXZHVJRzUyTFhOaE1SQXdEZ1lEVlFRTEV3ZFNiMjkwSUVOQk1Sc3dHUVlEVlFRREV4SkhiRzlpWVd4VAphV2R1SUZKdmIzUWdRMEV3Z2dFaU1BMEdDU3FHU0liM0RRRUJBUVVBQTRJQkR3QXdnZ0VLQW9JQkFRRGFEdWFaCi4uLgpqYzZqNDArS2Z2dnhpNE1sYStwSUgvRXFzTG1WRVFTOThHUFI0bWRtenh6ZHp4dElLKzZOaVk2YXJ5bUFaYXZwCjM4TmZsTlVWeVJSQm5NUmRkV1FWRGY5Vk1PeUdqLzhON3l5NVkwYjJxdnpmdkduOUxoSklaSnJnbGZDbTd5bVAKSE1VZnBJQnZGU0RKM2d5SUNoM1dabFhpL0VqSktTWnA0QT09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0=", "passphrase":"TXk1dHJvbmdAUGE1NXBocmE1MyE=" } } } } }, "required":true }, "responses":{ "201":{ "description":"Created.", "headers":{ "Location":{ "description":"Resource location.", "style":"simple", "explode":false, "schema":{ "type":"string", "format":"uri" } } }, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatusResponse" } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"m" } ] } }, "/subscriptions/1/certificates/{certificateId}":{ "get":{ "tags":[ "platform", "subscriptions-api", "certificate" ], "summary":"Get certificate details by identifier", "description":"Returns a certificate details.", "operationId":"get-certificate-details", "parameters":[ { "name":"certificateId", "in":"path", "description":"Certificate identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "maxLength":255, "minLength":1 } } ], "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateDetailsResponse" } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"m" } ] }, "delete":{ "tags":[ "platform", "subscriptions-api", "certificate" ], "summary":"Delete certificate", "description":"Deletes an existing certificate by a given identifier. Note, certificates cannot be deleted if linked to a Notification Profile.", "operationId":"delete-certificate", "parameters":[ { "name":"certificateId", "in":"path", "description":"Certificate identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "maxLength":255, "minLength":1 } } ], "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyCertificateResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "certificateId":"my-certificate-1" } } } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"m" } ] } }, "/subscriptions/1/certificates/status":{ "get":{ "tags":[ "platform", "subscriptions-api", "certificate" ], "summary":"Get filtered certificates statuses page", "description":"Returns a page containing certificates statuses by filtering condition.", "operationId":"get-certificates-statuses-page", "parameters":[ { "name":"search", "in":"query", "description":"Search filter. Limits returned results.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"page", "in":"query", "description":"Results page to retrieve (0..N).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":0, "minimum":0 } }, { "name":"size", "in":"query", "description":"Number of records per page.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":20, "maximum":100, "minimum":1 } }, { "name":"sortBy", "in":"query", "description":"Sorting parameter.", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificatesSortType" } }, { "name":"direction", "in":"query", "description":"Sorting direction.", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SortDirection" } } ], "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatusPage" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "results":[ { "certificateId":"my-certificate-1", "status":"READY" }, { "certificateId":"my-certificate-2", "status":"PROCESSING" }, { "certificateId":"my-certificate-3", "status":"EXPIRED" } ], "paging":{ "page":0, "size":3, "totalPages":1, "totalResults":3 } } } } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"m" } ] } }, "/subscriptions/1/certificates/status/{certificateId}":{ "get":{ "tags":[ "platform", "subscriptions-api", "certificate" ], "summary":"Get certificate status by identifier", "description":"Returns a certificate status.", "operationId":"get-certificate-status", "parameters":[ { "name":"certificateId", "in":"path", "description":"Certificate identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "maxLength":255, "minLength":1 } } ], "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatusResponse" } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"m" } ] } }, "/subscriptions/1/certificates/test/webhook":{ "post":{ "tags":[ "platform", "subscriptions-api", "certificate" ], "summary":"Test connection to a webhook", "description":"Performs connectivity check to provided webhook with the given certificate. Note, it does not send a notification event.", "operationId":"test-connection-to-webhook", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateConnectionTestRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "certificateId":"my-certificate-1", "webhookUrl":"https://example.com/webhook-url" } } } } }, "required":true }, "responses":{ "200":{ "description":"Success.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateConnectionTestResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "certificateId":"my-certificate-1", "webhookUrl":"https://example.com/my-webhook", "result":"SUCCESS" } } } } } }, "400":{ "description":"Bad request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request", "validationErrors":{ "field":[ "field must not be null" ] } } } } }, "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException" }, "examples":{ "Error responses":{ "summary":"Error responses", "description":"Error responses", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "subscriptions:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"m" } ] } } }, "components":{ "schemas":{ "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AgentOsNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAgentOsEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"AgentOS" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AgentOsSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAgentOsEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"AgentOS" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AppleMessagesForBusinessNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "oneOf":[ { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAppleMessagesForBusinessEvents" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareAppleMessagesForBusinessEvents" } ] }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Apple Messages For Business" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AppleMessagesForBusinessSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "oneOf":[ { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAppleMessagesForBusinessEvents" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareAppleMessagesForBusinessEvents" } ] }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Apple Messages For Business" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair":{ "type":"object", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "properties":{ "applicationId":{ "type":"string", "description":"CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic.", "maxLength":255, "minLength":0 }, "entityId":{ "type":"string", "description":"CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic.", "maxLength":255, "minLength":0 }, "callsConfigurationId":{ "type":"string", "description":"CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic.", "maxLength":255, "minLength":0 } }, "title":"ApplicationEntityPair" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BasicCredentialsPayload":{ "type":"object", "description":"Basic credentials.", "properties":{ "username":{ "type":"string", "description":"Username.", "maxLength":255, "minLength":1 }, "password":{ "type":"string", "description":"Password.", "maxLength":255, "minLength":1 } }, "required":[ "password", "username" ], "title":"BasicCredentials" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BlocklistNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "oneOf":[ { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleBlocklistEvents" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareBlocklistEvents" } ] }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Blocklist" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BlocklistSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "oneOf":[ { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleBlocklistEvents" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareBlocklistEvents" } ] }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Blocklist" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateConnectionTestRequest":{ "type":"object", "properties":{ "certificateId":{ "type":"string", "description":"Existing certificate identifier.", "maxLength":255, "minLength":1 }, "webhookUrl":{ "type":"string", "description":"A webhook URL over which a connectivity test will be performed." } }, "required":[ "certificateId", "webhookUrl" ], "title":"CertificateConnectionTestRequest" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateConnectionTestResponse":{ "type":"object", "properties":{ "certificateId":{ "type":"string", "description":"Existing certificate identifier." }, "webhookUrl":{ "type":"string", "description":"A webhook URL over which a connectivity test will be performed." }, "result":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ConnectionTestResult" }, "failReasons":{ "type":"array", "description":"Contains reasons why the connection test was failed.", "items":{ "type":"string", "description":"Contains reasons why the connection test was failed." } }, "hint":{ "type":"string", "description":"Contains a hint how the client can fix the errors." } }, "title":"CertificateConnectionTestResponse" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateDetailsPage":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"The list of the results for this page.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateDetailsResponse" } }, "paging":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.PageInfo" } }, "title":"CertificateDetailsPage" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateDetailsResponse":{ "type":"object", "properties":{ "certificateId":{ "type":"string", "description":"Certificate's identifier." }, "issuedBy":{ "type":"string", "description":"Certificate's Issuer information." }, "issuedTo":{ "type":"string", "description":"Certificate's Subject information." }, "validFrom":{ "type":"integer", "format":"int64", "description":"Date and time from which the certificate is valid (milliseconds since the UNIX epoch)." }, "validUntil":{ "type":"integer", "format":"int64", "description":"Date and time until which the certificate is valid (milliseconds since the UNIX epoch)." }, "certificateStatus":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatus" }, "serialNumber":{ "type":"string", "description":"A certificate's serial number." } }, "title":"CertificateDetailsResponse" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatus":{ "type":"string", "description":"Certificate status. Represents a certificate state and indicates whether the certificate can be used.\nPROCESSING means certificate is being synced on Infobip Platform and cannot be use for notification events.\nREADY means certificate is synced and notification events can be sent to webhook using the certificate.\nEXPIRED means certificate cannot be used because validity date is in the past.", "enum":[ "PROCESSING", "READY", "EXPIRED" ], "title":"CertificateStatus" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatusPage":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"The list of the results for this page.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatusResponse" } }, "paging":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.PageInfo" } }, "title":"CertificateStatusPage" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatusResponse":{ "type":"object", "properties":{ "certificateId":{ "type":"string", "description":"Certificate identifier." }, "status":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatus" } }, "title":"CertificateStatusResponse" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateUploadRequest":{ "type":"object", "properties":{ "certificateId":{ "type":"string", "description":"Certificate's identifier. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created.", "maxLength":255, "minLength":1 }, "certificateContent":{ "type":"string", "format":"base64", "description":"Content of a .pem file encoded in Base64 format." }, "passphrase":{ "type":"string", "format":"base64", "description":"Certificate's passphrase encoded in Base64 format." } }, "required":[ "certificateContent", "certificateId" ], "title":"CertificateUploadRequest" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificatesSortType":{ "type":"string", "enum":[ "CERTIFICATE_ID" ], "title":"CertificatesSortType" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ConnectionTestResult":{ "type":"string", "description":"Connection test result. Indicates whether the test to connection passed.", "enum":[ "SUCCESS", "FAIL" ], "title":"ConnectionTestResult" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsPayload":{ "type":"object", "description":"Webhook security credentials.", "oneOf":[ { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BasicCredentialsPayload" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.HmacCredentialsPayload" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OauthCredentialsPayload" } ], "title":"Credentials" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsType":{ "type":"string", "description":"Credentials type.", "enum":[ "BASIC", "HMAC", "OAUTH", "CUSTOM" ], "title":"CredentialsType" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CustomerEngagementNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleCustomerEngagementEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Customer Engagement" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CustomerEngagementSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleCustomerEngagementEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Customer Engagement" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.EmailNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleEmailEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Email" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.EmailSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleEmailEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Email" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FacebookNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "oneOf":[ { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleFacebookEvents" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareFacebookEvents" } ] }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Facebook" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FacebookSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "oneOf":[ { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleFacebookEvents" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareFacebookEvents" } ] }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Facebook" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareAppleMessagesForBusinessEvents":{ "type":"object", "properties":{ "event":{ "type":"string", "enum":[ "DELIVERY", "INBOUND_MESSAGE" ] }, "format":{ "type":"string", "description":"Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page." } }, "required":[ "event", "format" ], "title":"Event with format" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareBlocklistEvents":{ "type":"object", "properties":{ "event":{ "type":"string", "enum":[ "BLOCK", "UNBLOCK" ] }, "format":{ "type":"string", "description":"Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page." } }, "required":[ "event", "format" ], "title":"Event with format" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareEvent":{ "type":"object", "properties":{ "format":{ "type":"string" }, "event":{ "type":"string" } }, "required":[ "event", "format" ], "title":"Event with format" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareFacebookEvents":{ "type":"object", "properties":{ "event":{ "type":"string", "enum":[ "CLICK", "CONSENT_UPDATE", "DELIVERY", "INBOUND_MESSAGE", "SEEN" ] }, "format":{ "type":"string", "description":"Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page." } }, "required":[ "event", "format" ], "title":"Event with format" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMmsEvents":{ "type":"object", "properties":{ "event":{ "type":"string", "enum":[ "CLICK", "DELIVERY", "INBOUND_MESSAGE" ] }, "format":{ "type":"string", "description":"Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page." } }, "required":[ "event", "format" ], "title":"Event with format" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMobileIdentityEvents":{ "type":"object", "properties":{ "event":{ "type":"string", "enum":[ "SILENT_VERIFICATION" ] }, "format":{ "type":"string", "description":"Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page." } }, "required":[ "event", "format" ], "title":"Event with format" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareOpenChannelEvents":{ "type":"object", "properties":{ "event":{ "type":"string", "enum":[ "DELIVERY" ] }, "format":{ "type":"string", "description":"Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page." } }, "required":[ "event", "format" ], "title":"Event with format" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareSmsEvents":{ "type":"object", "properties":{ "event":{ "type":"string", "enum":[ "CLICK", "DELIVERY", "INBOUND_MESSAGE" ] }, "format":{ "type":"string", "description":"Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page." } }, "required":[ "event", "format" ], "title":"Event with format" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.HmacAlgorithm":{ "type":"string", "description":"HMAC algorithm.", "enum":[ "HMAC_MD5", "HMAC_SHA_1", "HMAC_SHA_224", "HMAC_SHA_256", "HMAC_SHA_384", "HMAC_SHA_512" ], "title":"HmacAlgorithm" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.HmacCredentialsPayload":{ "type":"object", "description":"HMAC credentials.", "properties":{ "secretKey":{ "type":"string", "description":"Secret key.", "maxLength":255, "minLength":1 }, "algorithm":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.HmacAlgorithm" } }, "required":[ "algorithm", "secretKey" ], "title":"HmacCredentials" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyCertificateResponse":{ "type":"object", "properties":{ "certificateId":{ "type":"string", "description":"Certificate identifier." } }, "title":"IdOnlyCertificateResponse" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest":{ "type":"object", "description":"Notification profile object holding settings for your webhook URL and a reference to security settings.", "properties":{ "profileId":{ "type":"string", "description":"ID of a notification profile. You can provide this ID if you want to associate your subscription with a different notification profile.", "maxLength":255, "minLength":1 } }, "required":[ "profileId" ], "title":"Profile" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileResponse":{ "type":"object", "description":"Notification profile.", "properties":{ "profileId":{ "type":"string", "description":"Unique profile ID." }, "security":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityResponse" } }, "title":"Profile" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityRequest":{ "type":"object", "description":"Security settings object holding authentication settings necessary to access your webhook.", "properties":{ "authId":{ "type":"string", "description":"Unique security setting ID. You can provide this ID if you want to associate your subscription with a different notification profile.", "maxLength":255, "minLength":1 } }, "required":[ "authId" ], "title":"Security" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityResponse":{ "type":"object", "description":"Security configuration.", "properties":{ "authId":{ "type":"string", "description":"Unique authorization ID." } }, "title":"Security" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySubscriptionResponse":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID." }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileResponse" } }, "title":"Subscription" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoAlimNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoAlimEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Kakao Alim" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoAlimSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoAlimEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Kakao Alim" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoBrandMessageNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoBrandMessageEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Kakao Brand Message" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoBrandMessageSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoBrandMessageEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Kakao Brand Message" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.LineNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleLineEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Line" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.LineSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleLineEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Line" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MmsNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "oneOf":[ { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMmsEvents" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMmsEvents" } ] }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"MMS" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MmsSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "oneOf":[ { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMmsEvents" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMmsEvents" } ] }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"MMS" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobileIdentityNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "oneOf":[ { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobileIdentityEvents" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMobileIdentityEvents" } ] }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Mobile Identity" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobileIdentitySubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "oneOf":[ { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobileIdentityEvents" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMobileIdentityEvents" } ] }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Mobile Identity" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobilePushNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobilePushEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Mobile Push" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobilePushSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobilePushEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Mobile Push" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NoIdProfileRequest":{ "type":"object", "description":"Notification profile.", "properties":{ "webhook":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.Webhook" }, "security":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityRequest" }, "clientCertificateId":{ "type":"string", "description":"Client certificate ID.", "maxLength":255, "minLength":0 }, "maxBucketSize":{ "type":"integer", "format":"int32", "description":"Specifies a maximum number of messages to be sent within a single request.", "maximum":2000, "minimum":1 }, "windowSize":{ "type":"integer", "format":"int32", "description":"A maximum number of concurrent connections (active requests) per client.", "maximum":10000, "minimum":20 }, "connectTimeout":{ "type":"integer", "format":"int32", "description":"Time in milliseconds sender system waits for connection acknowledgement until the connection is closed.", "maximum":30000, "minimum":300 }, "readTimeout":{ "type":"integer", "format":"int32", "description":"A maximum period of inactivity in milliseconds between two consecutive data packets.", "maximum":90000, "minimum":1000 }, "enabledSSLProtocols":{ "type":"array", "description":"Specifies which security protocols should be used to send a HTTP request. Multiple options can be used.", "enum":[ "TLSv1.2", "TLSv1.3" ], "items":{ "type":"string", "description":"Specifies which security protocols should be used to send a HTTP request. Multiple options can be used.", "enum":[ "TLSv1.2", "TLSv1.3" ] }, "uniqueItems":true }, "headers":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config." }, "responseRegex":{ "type":"string", "description":"Response regex." }, "responseBodyRegex":{ "type":"string", "description":"Response body regex." }, "rateLimit":{ "type":"integer", "format":"int32", "description":"Limits the number of requests per second.", "maximum":5000, "minimum":1 } }, "title":"Profile" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NoIdSecurityRequest":{ "type":"object", "description":"Security configuration.", "properties":{ "type":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsType" }, "credentials":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsPayload" } }, "title":"Security" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NoIdSubscriptionRequest":{ "oneOf":[ { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AgentOsNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AppleMessagesForBusinessNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BlocklistNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CustomerEngagementNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.EmailNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FacebookNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoAlimNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoBrandMessageNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.LineNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MmsNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobileIdentityNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobilePushNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NumberLookupNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OpenChannelNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RcsNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RegistrationNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SmsNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ViberNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.VoiceVideoNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WebPushNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WhatsappNoIdSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ZaloNoIdSubscriptionRequest" } ], "title":"NoIdSubscriptionRequest" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NumberLookupNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleNumberLookupEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Number Lookup" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NumberLookupSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleNumberLookupEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Number Lookup" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OauthCredentialsPayload":{ "type":"object", "description":"OAuth credentials.", "properties":{ "tokenUrl":{ "type":"string", "description":"Token URL.", "maxLength":255, "minLength":1 }, "clientId":{ "type":"string", "description":"Client ID.", "maxLength":255, "minLength":0 }, "clientSecret":{ "type":"string", "description":"Client secret.", "maxLength":255, "minLength":0 }, "grantType":{ "type":"string", "description":"Grant type.", "maxLength":255, "minLength":1 }, "scope":{ "type":"string", "description":"Scope.", "maxLength":255, "minLength":0 }, "username":{ "type":"string", "description":"Username.", "maxLength":255, "minLength":0 }, "password":{ "type":"string", "description":"Password.", "maxLength":255, "minLength":0 }, "resource":{ "type":"string", "description":"Resource.", "maxLength":255, "minLength":0 }, "refreshToken":{ "type":"string", "description":"Refresh token.", "maxLength":255, "minLength":0 }, "headers":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Set of key:value pairs that will be sent in a HTTP request as headers." } }, "required":[ "grantType", "tokenUrl" ], "title":"OauthCredentials" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OpenChannelNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "oneOf":[ { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleOpenChannelEvents" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareOpenChannelEvents" } ] }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Open Channel" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OpenChannelSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "oneOf":[ { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleOpenChannelEvents" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareOpenChannelEvents" } ] }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Open Channel" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.PageInfo":{ "type":"object", "description":"Contains information about the page.", "properties":{ "page":{ "type":"integer", "format":"int32" }, "size":{ "type":"integer", "format":"int32" }, "totalPages":{ "type":"integer", "format":"int32" }, "totalResults":{ "type":"integer", "format":"int64" } }, "title":"PageInfo" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfilePage":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"The list of the results for this page.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileResponse" } }, "paging":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.PageInfo" } }, "title":"ProfilePage" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest":{ "type":"object", "description":"Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties.", "properties":{ "profileId":{ "type":"string", "description":"ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created.", "maxLength":255, "minLength":1 }, "webhook":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.Webhook" }, "security":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityRequest" }, "clientCertificateId":{ "type":"string", "description":"Client certificate ID.", "maxLength":255, "minLength":0 }, "maxBucketSize":{ "type":"integer", "format":"int32", "description":"Specifies a maximum number of messages to be sent within a single request.", "maximum":2000, "minimum":1 }, "windowSize":{ "type":"integer", "format":"int32", "description":"A maximum number of concurrent connections (active requests) per client.", "maximum":10000, "minimum":20 }, "connectTimeout":{ "type":"integer", "format":"int32", "description":"Time in milliseconds sender system waits for connection acknowledgement until the connection is closed.", "maximum":30000, "minimum":300 }, "readTimeout":{ "type":"integer", "format":"int32", "description":"A maximum period of inactivity in milliseconds between two consecutive data packets.", "maximum":90000, "minimum":1000 }, "enabledSSLProtocols":{ "type":"array", "description":"Specifies which security protocols should be used to send a HTTP request. Multiple options can be used.", "enum":[ "TLSv1.2", "TLSv1.3" ], "items":{ "type":"string", "description":"Specifies which security protocols should be used to send a HTTP request. Multiple options can be used.", "enum":[ "TLSv1.2", "TLSv1.3" ] }, "uniqueItems":true }, "headers":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config." }, "responseRegex":{ "type":"string", "description":"Response regex." }, "responseBodyRegex":{ "type":"string", "description":"Response body regex." }, "rateLimit":{ "type":"integer", "format":"int32", "description":"Limits the number of requests per second.", "maximum":5000, "minimum":1 } }, "required":[ "profileId" ], "title":"Profile" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileResponse":{ "type":"object", "description":"Notification profile.", "properties":{ "profileId":{ "type":"string", "description":"Unique profile ID." }, "webhook":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.Webhook" }, "security":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityResponse" }, "clientCertificateId":{ "type":"string", "description":"Client certificate ID." }, "maxBucketSize":{ "type":"integer", "format":"int32", "description":"Specifies a maximum number of messages to be sent within a single request." }, "windowSize":{ "type":"integer", "format":"int32", "description":"A maximum number of concurrent connections (active requests) per client." }, "connectTimeout":{ "type":"integer", "format":"int32", "description":"Time in milliseconds sender system waits for connection acknowledgement until the connection is closed." }, "readTimeout":{ "type":"integer", "format":"int32", "description":"A maximum period of inactivity in milliseconds between two consecutive data packets." }, "enabledSSLProtocols":{ "type":"array", "description":"Specifies which security protocols should be used to send a HTTP request. Multiple options can be used.", "enum":[ "TLSv1.2", "TLSv1.3" ], "items":{ "type":"string", "description":"Specifies which security protocols should be used to send a HTTP request. Multiple options can be used.", "enum":[ "TLSv1.2", "TLSv1.3" ] }, "uniqueItems":true }, "headers":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Set of key:value pairs that will be sent in a HTTP request as headers." }, "responseRegex":{ "type":"string", "description":"Response regex." }, "responseBodyRegex":{ "type":"string", "description":"Response body regex." }, "rateLimit":{ "type":"integer", "format":"int32", "description":"Limits the number of requests per second." } }, "title":"Profile" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RcsNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRcsEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"RCS" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RcsSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRcsEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"RCS" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RegistrationNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRegistrationEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Registration" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RegistrationSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRegistrationEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Registration" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityPage":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"The list of the results for this page.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityResponse" } }, "paging":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.PageInfo" } }, "title":"SecurityPage" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityRequest":{ "type":"object", "description":"Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored.", "properties":{ "authId":{ "type":"string", "description":"Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created.", "maxLength":255, "minLength":1 }, "type":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsType" }, "credentials":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsPayload" } }, "required":[ "authId" ], "title":"Security" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityResponse":{ "type":"object", "description":"Security configuration.", "properties":{ "authId":{ "type":"string", "description":"Unique authorization ID." }, "type":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsType" }, "credentials":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsPayload" } }, "title":"Security" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAgentOsEvents":{ "type":"string", "enum":[ "CONVERSATION_ASSIGNMENT_UPDATED", "CONVERSATION_CREATED", "CONVERSATION_MESSAGE_DELETED", "CONVERSATION_MESSAGE_RECEIVED", "CONVERSATION_MESSAGE_UPDATED", "CONVERSATION_STATUS_UPDATED" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAppleMessagesForBusinessEvents":{ "type":"string", "enum":[ "DELIVERY", "INBOUND_MESSAGE" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleBlocklistEvents":{ "type":"string", "enum":[ "BLOCK", "UNBLOCK" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleCustomerEngagementEvents":{ "type":"string", "enum":[ "CONVERSATION_ASSIGNMENT_UPDATED", "CONVERSATION_CREATED", "CONVERSATION_MESSAGE_DELETED", "CONVERSATION_MESSAGE_RECEIVED", "CONVERSATION_MESSAGE_UPDATED", "CONVERSATION_STATUS_UPDATED" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleEmailEvents":{ "type":"string", "enum":[ "CLICK", "COMPLAINT", "DELIVERY", "HIGH_BOUNCE_RATE_BLOCKED", "HIGH_BOUNCE_RATE_WARNING", "LATE_BOUNCE", "OPEN", "UNSUBSCRIBE" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleFacebookEvents":{ "type":"string", "enum":[ "CLICK", "CONSENT_UPDATE", "DELIVERY", "INBOUND_MESSAGE", "SEEN" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoAlimEvents":{ "type":"string", "enum":[ "DELIVERY" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoBrandMessageEvents":{ "type":"string", "enum":[ "CLICK", "DELIVERY" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleLineEvents":{ "type":"string", "enum":[ "DELIVERY", "INBOUND_MESSAGE" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMmsEvents":{ "type":"string", "enum":[ "CLICK", "DELIVERY", "INBOUND_MESSAGE" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobileIdentityEvents":{ "type":"string", "enum":[ "SILENT_VERIFICATION" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobilePushEvents":{ "type":"string", "enum":[ "DELIVERY", "SEEN", "SENT" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleNumberLookupEvents":{ "type":"string", "enum":[ "NUMBER_LOOKUP" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleOpenChannelEvents":{ "type":"string", "enum":[ "DELIVERY" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRcsEvents":{ "type":"string", "enum":[ "CAP_CHECK", "CLICK", "CONVERSATION_STARTED", "DELIVERY", "INBOUND_MESSAGE", "SEEN", "SENDER_LAUNCH_UPDATE", "SENDER_UPDATE", "SUGGESTION", "TEMPLATE_UPDATE", "TEST_NUMBER_UPDATE", "TYPING_INDICATOR" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRegistrationEvents":{ "type":"string", "enum":[ "AI_CAMPAIGN_BUILDER", "AI_CAMPAIGN_FEEDBACK", "BRAND_AUTH_UPDATE", "BRAND_STATUS_UPDATE", "BRAND_VET_UPDATE", "CAMPAIGN_NETWORK_STATUS_UPDATE", "CAMPAIGN_STATUS_UPDATE", "RESOURCE_REQUEST_FOC_DATE_CHANGE", "RESOURCE_REQUEST_REMINDER", "RESOURCE_REQUEST_STATUS_UPDATE" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleSmsEvents":{ "type":"string", "enum":[ "CLICK", "DELIVERY", "INBOUND_MESSAGE" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleViberEvents":{ "type":"string", "enum":[ "CLICK", "CONSENT_UPDATE", "DELIVERY", "INBOUND_MESSAGE", "SEEN", "TEMPLATE_UPDATE" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleVoiceVideoEvents":{ "type":"string", "enum":[ "APPLICATION_TRANSFER_FAILED", "APPLICATION_TRANSFER_FINISHED", "APPLICATION_TRANSFER_REQUESTED", "BULK_CALL_STATUS", "CALL_DISCONNECTED", "CALL_ESTABLISHED", "CALL_FAILED", "CALL_FINISHED", "CALL_MEDIA_CHANGED", "CALL_PRE_ESTABLISHED", "CALL_RECEIVED", "CALL_RECONNECTED", "CALL_RECORDING_DELETED", "CALL_RECORDING_FAILED", "CALL_RECORDING_READY", "CALL_RECORDING_STARTED", "CALL_RECORDING_STOPPED", "CALL_RINGING", "CALL_STARTED", "CONFERENCE_COMPOSITION_FAILED", "CONFERENCE_COMPOSITION_FINISHED", "CONFERENCE_CREATED", "CONFERENCE_FINISHED", "CONFERENCE_RECORDING_DELETED", "CONFERENCE_RECORDING_FAILED", "CONFERENCE_RECORDING_READY", "CONFERENCE_RECORDING_STARTED", "CONFERENCE_RECORDING_STOPPED", "DELIVERY", "DIALOG_COMPOSITION_FAILED", "DIALOG_COMPOSITION_FINISHED", "DIALOG_CREATED", "DIALOG_ESTABLISHED", "DIALOG_FAILED", "DIALOG_FINISHED", "DIALOG_RECORDING_DELETED", "DIALOG_RECORDING_FAILED", "DIALOG_RECORDING_READY", "DIALOG_RECORDING_STARTED", "DIALOG_RECORDING_STOPPED", "DIALOG_TRANSFER_FAILED", "DIALOG_TRANSFER_FINISHED", "DIALOG_TRANSFER_REQUESTED", "DTMF_CAPTURED", "ERROR", "MACHINE_DETECTION_FAILED", "MACHINE_DETECTION_FINISHED", "MACHINE_MESSAGE_DETECTION_FAILED", "MACHINE_MESSAGE_DETECTION_FINISHED", "MEDIA_STREAM_FAILED", "MEDIA_STREAM_FINISHED", "MEDIA_STREAM_STARTED", "MISSED_CALL", "NUMBER_MASKING", "PARTICIPANT_JOINED", "PARTICIPANT_JOINING", "PARTICIPANT_JOIN_FAILED", "PARTICIPANT_MEDIA_CHANGED", "PARTICIPANT_RECORDING_FAILED", "PARTICIPANT_REMOVED", "PARTICIPANT_ROLE_CHANGED", "PARTICIPANT_ROLE_CHANGE_FAILED", "PARTICIPANT_STARTED_TALKING", "PARTICIPANT_STOPPED_TALKING", "PLAY_FINISHED", "SAY_FINISHED", "SILENT_VERIFICATION_DELIVERY", "SPEECH_CAPTURED", "TRANSCRIPTION" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWebPushEvents":{ "type":"string", "enum":[ "DELIVERY" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWhatsappEvents":{ "type":"string", "enum":[ "ACCOUNT_REGISTRATION", "ACCOUNT_UPDATE_NOTIFICATION", "BILLING", "BUSINESS_APP_CONTACT_SYNC", "BUSINESS_APP_MESSAGE_ECHO", "BUSINESS_APP_MESSAGE_HISTORY", "CLICK", "DELIVERY", "IDENTITY_CHANGE", "INBOUND_MESSAGE", "MARKETING_SUBSCRIPTION_UPDATE", "PAYMENT_STATUS", "SEEN", "TEMPLATE_UPDATE" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleZaloEvents":{ "type":"string", "enum":[ "CLICK", "DELIVERY", "INBOUND_MESSAGE", "TEMPLATE_UPDATE" ], "title":"Event" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SmsNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "oneOf":[ { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleSmsEvents" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareSmsEvents" } ] }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"SMS" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SmsSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "oneOf":[ { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleSmsEvents" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareSmsEvents" } ] }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"SMS" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SortDirection":{ "type":"string", "enum":[ "ASC", "DESC" ], "title":"SortDirection" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionChannel":{ "type":"string", "enum":[ "AGENT_OS", "APPLE_MESSAGES_FOR_BUSINESS", "BLOCKLIST", "CUSTOMER_ENGAGEMENT", "EMAIL", "FACEBOOK", "KAKAO_ALIM", "KAKAO_BRAND_MESSAGE", "LINE", "MMS", "MOBILE_IDENTITY", "MOBILE_PUSH", "NUMBER_LOOKUP", "OPEN_CHANNEL", "RCS", "REGISTRATION", "SMS", "VIBER", "VOICE_VIDEO", "WEB_PUSH", "WHATSAPP", "ZALO" ], "title":"SubscriptionChannel" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionEvent":{ "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "oneOf":[ { "type":"string", "title":"Event name" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareEvent" } ], "title":"SubscriptionEvent" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionPage":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"The list of the results for this page.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionResponse" } }, "paging":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.PageInfo" } }, "title":"SubscriptionPage" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionRequest":{ "oneOf":[ { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AgentOsSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AppleMessagesForBusinessSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BlocklistSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CustomerEngagementSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.EmailSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FacebookSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoAlimSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoBrandMessageSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.LineSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MmsSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobileIdentitySubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobilePushSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NumberLookupSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OpenChannelSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RcsSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RegistrationSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SmsSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ViberSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.VoiceVideoSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WebPushSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WhatsappSubscriptionRequest" }, { "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ZaloSubscriptionRequest" } ], "title":"SubscriptionRequest" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionResponse":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID." }, "name":{ "type":"string", "description":"Subscription group name." }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileResponse" }, "events":{ "type":"array", "description":"List of events to subscribe.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionEvent" } }, "criteria":{ "type":"array", "description":"List of applicationId/entityId pairs.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" } }, "resources":{ "type":"array", "description":"List of resources.", "items":{ "type":"string", "description":"List of resources." } }, "users":{ "type":"array", "description":"List of users.", "items":{ "type":"string", "description":"List of users." } } }, "title":"Subscription" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ViberNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleViberEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Viber" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ViberSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleViberEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Viber" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.VoiceVideoNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleVoiceVideoEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Voice and Video" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.VoiceVideoSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleVoiceVideoEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Voice and Video" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WebPushNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWebPushEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Web Push" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WebPushSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWebPushEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Web Push" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.Webhook":{ "type":"object", "description":"Webhook configuration.", "properties":{ "contentType":{ "type":"string", "maxLength":255, "minLength":0 }, "notifyUrl":{ "type":"string", "description":"Your webhook URL, where the notifications will be sent to.", "maxLength":512, "minLength":0 } }, "required":[ "notifyUrl" ], "title":"Webhook" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WhatsappNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWhatsappEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Whatsapp" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WhatsappSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWhatsappEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Whatsapp" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ZaloNoIdSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "name":{ "type":"string", "description":"Subscription group name.", "maxLength":255, "minLength":1 }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest" }, "events":{ "type":"array", "description":"List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleZaloEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" } }, "required":[ "events", "profile" ], "title":"Zalo" }, "6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ZaloSubscriptionRequest":{ "type":"object", "description":"Subscription group.", "properties":{ "subscriptionId":{ "type":"string", "description":"Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.", "maxLength":255, "minLength":1 }, "name":{ "type":"string", "description":"A human-readable description for your subscription, can be changed at a later point.", "maxLength":255, "minLength":1 }, "events":{ "type":"array", "description":"List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleZaloEvents" }, "maxItems":255, "minItems":0 }, "criteria":{ "type":"array", "description":"Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.", "items":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair" }, "maxItems":255, "minItems":0 }, "resources":{ "type":"array", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "items":{ "type":"string", "description":"List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "users":{ "type":"array", "description":"List of users to match. You can provide usernames from your account.", "items":{ "type":"string", "description":"List of users to match. You can provide usernames from your account.", "maxLength":255, "minLength":0, "x-is-early-access":"true" }, "maxItems":255, "minItems":0, "x-is-early-access":"true" }, "profile":{ "$ref":"#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest" } }, "required":[ "events", "profile", "subscriptionId" ], "title":"Zalo" }, "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", "items":{ "type":"string", "description":"Validation errors." } }, "description":"Validation errors." } }, "title":"ApiRequestErrorDetails" }, "d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException":{ "type":"object", "properties":{ "requestError":{ "$ref":"#/components/schemas/ApiRequestError" } }, "title":"ApiException" } }, "responses":{ "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" } } }, "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":{} } }