{ "openapi":"3.1.0", "info":{ "title":"Infobip OpenAPI Specification", "description":"OpenAPI Specification that contains all public endpoints and webhooks.", "contact":{ "name":"Infobip support", "email":"support@infobip.com" }, "version":"3.210.0", "x-generatedAt":"2026-07-23T15:24:04.003346249Z" }, "tags":[ { "name":"channels", "description":"Create a perfect customer experience by using the channels your customer already use and love.\n", "x-type":"category", "x-displayName":"Channels" }, { "name":"messenger", "description":"Grow your business with conversations on Messenger.\n\nTo utilize Messenger in combination with other channels, check out [Messages API](https://www.infobip.com/docs/api/platform/messages-api).\n", "x-type":"product", "x-displayName":"Messenger" }, { "name":"send-messenger", "description":"", "x-type":"section", "x-displayName":"Outbound Message" }, { "name":"logs-and-status-reports-messenger", "description":"", "x-type":"section", "x-displayName":"Logs and Status Reports" }, { "name":"incoming-messenger-message", "description":"", "x-type":"section", "x-displayName":"Receive messenger message" }, { "name":"incoming-messenger-event", "description":"", "x-type":"section", "x-displayName":"Receive messenger event" }, { "name":"marketing-subscriptions-messenger", "description":"", "x-type":"section", "x-displayName":"Marketing subscriptions" }, { "name":"campaigns-messenger", "description":"", "x-type":"section", "x-displayName":"Manage campaigns" }, { "name":"marketing-ad-accounts-messenger", "description":"", "x-type":"section", "x-displayName":"Manage ad accounts" }, { "name":"audiences-messenger", "description":"", "x-type":"section", "x-displayName":"Manage audiences" } ], "paths":{ "/messenger/1/messages":{ "post":{ "tags":[ "channels", "messenger", "send-messenger" ], "summary":"Send a Messenger message", "description":"Send one or more messages to multiple recipients.
Marketing messages on Messenger are no longer available for new users. For existing users, this feature will be deprecated on January 12, 2026. After this date, marketing messages will fail with an error.", "externalDocs":{ "description":"Learn more about Messenger channel and use cases", "url":"https://www.infobip.com/docs/facebook-messenger" }, "operationId":"send-messenger-message", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookRequest" }, "examples":{ "Send a Messenger message":{ "summary":"Send a Messenger message", "value":{ "messages":[ { "sender":"OFFICIAL-ACCOUNT-ID-123", "destinations":[ { "to":"66855538125" } ], "content":{ "text":"Hello!", "type":"TEXT" } } ] } }, "Send a Messenger marketing message":{ "summary":"Send a Messenger marketing message", "value":{ "messages":[ { "sender":"OFFICIAL-ACCOUNT-ID-123", "destinations":[ { "to":"66855538125" } ], "content":{ "campaignId":"120213234151570", "content":{ "payload":{ "text":"Hello! Check out our latest offers." }, "type":"TEXT" }, "type":"MARKETING_MESSAGE" } } ] } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ResponseEnvelopeMessageResponseMessageResponseDetails" }, "examples":{ "Messenger message response":{ "summary":"Messenger message response", "value":{ "bulkId":"2034072219640523072", "messages":[ { "messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message sent to next instance" }, "destination":"66855538125" } ] } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message." } ], "resources":[] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "messenger:message:send", "messenger:manage" ], "x-is-early-access":true } }, "/messenger/1/reports":{ "get":{ "tags":[ "channels", "messenger", "logs-and-status-reports-messenger" ], "summary":"Get Messenger delivery reports", "description":"If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once.", "externalDocs":{ "description":"Learn more about Messenger channel and use cases", "url":"https://www.infobip.com/docs/facebook-messenger" }, "operationId":"get-outbound-messenger-message-delivery-reports", "parameters":[ { "name":"bulkId", "in":"query", "description":"The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"messageId", "in":"query", "description":"The ID that uniquely identifies the message sent.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"limit", "in":"query", "description":"Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":50, "maximum":1000 }, "example":1 }, { "name":"entityId", "in":"query", "description":"Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"promotional-traffic-entity" }, { "name":"applicationId", "in":"query", "description":"Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"marketing-automation-application" }, { "name":"campaignReferenceId", "in":"query", "description":"ID of a campaign that was sent in the message.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"summersale" } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryReports" }, "examples":{ "Delivery reports":{ "summary":"Delivery reports", "value":{ "results":[ { "bulkId":"1688025180464000013", "price":{ "pricePerMessage":0.15, "currency":"EUR" }, "status":{ "groupId":3, "groupName":"DELIVERED", "id":5, "name":"DELIVERED_TO_HANDSET", "description":"Message delivered to handset" }, "error":{ "groupId":0, "groupName":"OK", "id":0, "name":"NO_ERROR", "description":"No Error", "permanent":false }, "messageId":"1688025180464000014", "to":"66855538125", "sender":"44113496000", "sentAt":"2023-09-26T10:52:15.457+0000", "doneAt":"2023-09-26T10:52:15.799+0000", "messageCount":1, "mccMnc":"22801", "platform":{ "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" } } ] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "messenger:message:send", "messenger:manage" ], "x-is-early-access":true } }, "/messenger/1/logs":{ "get":{ "tags":[ "channels", "messenger", "logs-and-status-reports-messenger" ], "summary":"Get outbound Messenger message logs", "description":"Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.", "operationId":"get-outbound-messenger-message-logs", "parameters":[ { "name":"sender", "in":"query", "description":"The sender ID which can be alphanumeric or numeric.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"destination", "in":"query", "description":"Message destination address.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bulkId", "in":"query", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } }, "example":"BULK-ID-123-xyz" }, { "name":"messageId", "in":"query", "description":"Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } }, "example":"MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz" }, { "name":"generalStatus", "in":"query", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageGeneralStatus" } }, { "name":"sentSince", "in":"query", "description":"The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time" }, "example":"2020-02-22T17:42:05.390+01:00" }, { "name":"sentUntil", "in":"query", "description":"The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time", "description":"The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.", "example":"2020-02-23T17:42:05.39+01:00" }, "example":"2020-02-23T17:42:05.390+01:00" }, { "name":"limit", "in":"query", "description":"Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":50, "maximum":1000 } }, { "name":"entityId", "in":"query", "description":"Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"promotional-traffic-entity" }, { "name":"applicationId", "in":"query", "description":"Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"marketing-automation-application" }, { "name":"campaignReferenceId", "in":"query", "description":"ID of a campaign that was sent in the message. May contain multiple comma-separated values.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } }, "example":"summersale" }, { "name":"useCursor", "in":"query", "description":"Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" } }, { "name":"cursor", "in":"query", "description":"Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.LogResponseLogFacebookOutboundContent" }, "examples":{ "Log result":{ "summary":"Log result", "value":{ "results":[ { "sender":"44113496000", "destination":"66855538125", "bulkId":"1688025180464000013", "messageId":"1688025180464000014", "sentAt":"2023-02-01T23:15:03.379+0000", "doneAt":"2023-02-01T23:16:34.582+0000", "messageCount":1, "price":{ "pricePerMessage":0.15, "currency":"EUR" }, "status":{ "groupId":3, "groupName":"DELIVERED", "id":5, "name":"DELIVERED_TO_HANDSET", "description":"Message delivered to handset" }, "error":{ "groupId":0, "groupName":"OK", "id":0, "name":"NO_ERROR", "description":"No Error", "permanent":false }, "platform":{ "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" }, "content":{ "text":"Sent text", "type":"TEXT" } } ] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "messenger:logs:read", "messenger:manage" ], "x-is-early-access":true, "x-throttling-info":[ { "type":"time", "numberOfRequests":120, "numberOfTimeUnits":0, "timeUnit":"m" } ] } }, "/messenger/1/pages/{pageId}/subscriptions":{ "get":{ "tags":[ "channels", "messenger", "marketing-subscriptions-messenger" ], "summary":"Get marketing subscriptions", "description":"Get all messenger marketing subscriptions for single page.
Collecting subscription tokens still works on the Messenger platform. However, marketing messages on Messenger are no longer available for new users. For existing users, this feature will be deprecated on January 12, 2026. After this date, marketing messages will no longer be supported.", "externalDocs":{ "description":"Learn more about Messenger channel and use cases", "url":"https://www.infobip.com/docs/facebook-messenger" }, "operationId":"get-messenger-marketing-subscriptions", "parameters":[ { "name":"pageId", "in":"path", "description":"Page ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":263213833541399 } ], "responses":{ "200":{ "description":"List Of Marketing Subscriptions For Page", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.PageMarketingSubscriptionResponse" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message." } ], "resources":[] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "description":"Page Does Not Exist" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "messenger:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/messenger/1/campaigns":{ "get":{ "tags":[ "channels", "messenger", "campaigns-messenger" ], "summary":"Get campaigns", "description":"Returns all Facebook Messenger marketing campaigns for the authenticated account.", "externalDocs":{ "description":"Learn more about Messenger channel and use cases", "url":"https://www.infobip.com/docs/facebook-messenger" }, "operationId":"get-messenger-campaigns", "responses":{ "200":{ "description":"List of campaigns.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetCampaignsResponse" }, "examples":{ "Get campaigns":{ "summary":"Get campaigns", "value":{ "campaigns":[ { "id":"6938008105758", "name":"Summer Sale Campaign", "dailyBudget":0, "lifetimeBudget":3000, "adAccountId":"3339405976215927", "pageId":"975663645629834", "startTime":"2026-04-20T01:08:10-0700", "endTime":"2026-05-20T01:08:09-0700" } ] } } } } } }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message." } ], "resources":[] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "messenger:manage" ], "x-is-early-access":true, "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "post":{ "tags":[ "channels", "messenger", "campaigns-messenger" ], "summary":"Create campaign", "description":"Create a new Facebook Messenger marketing campaign to send marketing messages to opted-in users. The campaign is associated with your ad account and Facebook page.", "externalDocs":{ "description":"Learn more about Messenger channel and use cases", "url":"https://www.infobip.com/docs/facebook-messenger" }, "operationId":"create-messenger-campaign", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CampaignRequest" }, "examples":{ "Create campaign":{ "summary":"Create campaign", "value":{ "name":"Summer Sale Campaign", "dailyBudget":10000, "adAccountId":"ACT_123456789", "pageId":"111111111111111" } } } } }, "required":true }, "responses":{ "201":{ "description":"Campaign created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CampaignResponse" } } } }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message." } ], "resources":[] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "messenger:manage" ], "x-is-early-access":true, "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/messenger/1/campaigns/{campaignId}":{ "delete":{ "tags":[ "channels", "messenger", "campaigns-messenger" ], "summary":"Delete campaign", "description":"Delete an existing Facebook Messenger marketing campaign.", "externalDocs":{ "description":"Learn more about Messenger channel and use cases", "url":"https://www.infobip.com/docs/facebook-messenger" }, "operationId":"delete-messenger-campaign", "parameters":[ { "name":"campaignId", "in":"path", "description":"Campaign ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":120213234151570 } ], "responses":{ "204":{ "description":"Campaign deleted successfully." }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message." } ], "resources":[] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "description":"Campaign not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":"E404", "description":"Campaign not found.", "action":"Please contact support", "violations":[], "resources":[] } } } } } }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "messenger:manage" ], "x-is-early-access":true, "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/messenger/1/ad-accounts":{ "get":{ "tags":[ "channels", "messenger", "marketing-ad-accounts-messenger" ], "summary":"Get ad accounts", "description":"Returns all Facebook ad accounts associated with the authenticated marketing account.", "externalDocs":{ "description":"Learn more about Messenger channel and use cases", "url":"https://www.infobip.com/docs/facebook-messenger" }, "operationId":"get-messenger-ad-accounts", "responses":{ "200":{ "description":"List of ad accounts.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetAdAccountsResponse" }, "examples":{ "Get ad accounts":{ "summary":"Get ad accounts", "value":{ "adAccounts":[ { "id":"act_3339405976215927", "status":"ACTIVE", "currency":"USD", "totalSpent":186 }, { "id":"act_24785101717804792", "status":"ACTIVE", "currency":"INR", "totalSpent":38295 } ] } } } } } }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message." } ], "resources":[] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "messenger:manage" ], "x-is-early-access":true, "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/messenger/1/audiences":{ "get":{ "tags":[ "channels", "messenger", "audiences-messenger" ], "summary":"Get audiences", "description":"Retrieve all custom audiences for the given ad account.", "externalDocs":{ "description":"Learn more about Messenger channel and use cases", "url":"https://www.infobip.com/docs/facebook-messenger" }, "operationId":"get-messenger-audiences", "parameters":[ { "name":"adAccountId", "in":"query", "description":"Facebook ad account ID.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Audiences retrieved successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetAudiencesResponse" } } } }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message." } ], "resources":[] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "messenger:manage" ], "x-is-early-access":true, "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "post":{ "tags":[ "channels", "messenger", "audiences-messenger" ], "summary":"Create custom audience", "description":"Create a new custom audience for marketing messages. Users can be uploaded to this audience to grow the marketing messages subscriber base.", "externalDocs":{ "description":"Learn more about Messenger channel and use cases", "url":"https://www.infobip.com/docs/facebook-messenger" }, "operationId":"create-messenger-audience", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CreateAudienceRequest" } } }, "required":true }, "responses":{ "201":{ "description":"Audience created successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CreateAudienceResponse" } } } }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message." } ], "resources":[] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "messenger:manage" ], "x-is-early-access":true, "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/messenger/1/audiences/{audienceId}":{ "delete":{ "tags":[ "channels", "messenger", "audiences-messenger" ], "summary":"Delete audience", "description":"Delete a custom audience. This permanently removes the audience from Meta and stops any campaigns using it.", "externalDocs":{ "description":"Learn more about Messenger channel and use cases", "url":"https://www.infobip.com/docs/facebook-messenger" }, "operationId":"delete-messenger-audience", "parameters":[ { "name":"audienceId", "in":"path", "description":"Meta custom audience ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"Audience deleted successfully." }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message." } ], "resources":[] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "description":"Audience not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":"E404", "description":"Audience not found.", "action":"Please contact support", "violations":[], "resources":[] } } } } } }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "messenger:manage" ], "x-is-early-access":true, "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/messenger/1/audiences/{audienceId}/users":{ "post":{ "tags":[ "channels", "messenger", "audiences-messenger" ], "summary":"Upload users to audience", "description":"Upload hashed user data (SHA-256) to a custom audience. Meta matches this data against its user database to grow your marketing messages subscriber base. Maximum 10,000 users per request.", "externalDocs":{ "description":"Learn more about Messenger channel and use cases", "url":"https://www.infobip.com/docs/facebook-messenger" }, "operationId":"upload-messenger-audience-users", "parameters":[ { "name":"audienceId", "in":"path", "description":"Meta custom audience ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AudienceUsersRequest" } } }, "required":true }, "responses":{ "200":{ "description":"Users uploaded successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AudienceUsersResponse" } } } }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message." } ], "resources":[] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "description":"Audience not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":"E404", "description":"Audience not found.", "action":"Please contact support", "violations":[], "resources":[] } } } } } }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "messenger:manage" ], "x-is-early-access":true, "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/messenger/1/audiences/{audienceId}/users/{hashedPhoneNumber}":{ "delete":{ "tags":[ "channels", "messenger", "audiences-messenger" ], "summary":"Remove user from audience", "description":"Remove a single hashed phone number from a custom audience.", "externalDocs":{ "description":"Learn more about Messenger channel and use cases", "url":"https://www.infobip.com/docs/facebook-messenger" }, "operationId":"remove-messenger-audience-user", "parameters":[ { "name":"audienceId", "in":"path", "description":"Meta custom audience ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"hashedPhoneNumber", "in":"path", "description":"SHA-256 hashed phone number to remove.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"User removed successfully." }, "400":{ "description":"Bad Request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message." } ], "resources":[] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "description":"Audience not found.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":"E404", "description":"Audience not found.", "action":"Please contact support", "violations":[], "resources":[] } } } } } }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "messenger:manage" ], "x-is-early-access":true, "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } } }, "components":{ "schemas":{ "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.AdvancedMessageDeliveryReporting":{ "type":"object", "description":"Provides options for configuring the delivery report behavior.", "properties":{ "url":{ "type":"string", "description":"The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`." }, "intermediateReport":{ "type":"boolean", "description":"The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`." }, "notify":{ "type":"boolean", "description":"Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to 'true' or not defined, your Subscription settings will apply." }, "receiveTriggeredFailoverReports":{ "type":"boolean", "description":"Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`." } }, "title":"AdvancedMessageDeliveryReporting" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.AdvancedWebhooksWithSeen":{ "type":"object", "description":"Provides options for configuring message webhooks.", "properties":{ "delivery":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.AdvancedMessageDeliveryReporting" }, "contentType":{ "type":"string", "description":"Preferred delivery report content type, `application/json` or `application/xml`." }, "callbackData":{ "type":"string", "description":"Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.", "maxLength":4000, "minLength":0 }, "seen":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SeenStatusReporting" } }, "title":"AdvancedWebhooksWithSeen" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.Button":{ "type":"object", "discriminator":{ "propertyName":"type", "mapping":{ "URL":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.UrlButton", "POSTBACK":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.PostbackButton", "CALL":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.CallButton" } }, "properties":{ "type":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ButtonType" } }, "title":"Button" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ButtonFacebookTemplatePayload":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookTemplatePayload" }, { "type":"object", "properties":{ "text":{ "type":"string" }, "buttons":{ "type":"array", "items":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.Button" }, "maxItems":2147483647, "minItems":1 } } } ], "required":[ "buttons", "text" ], "title":"ButtonFacebookTemplatePayload" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ButtonType":{ "type":"string", "enum":[ "URL", "POSTBACK", "CALL" ], "title":"ButtonType" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.CallButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.Button" }, { "type":"object", "properties":{ "title":{ "type":"string", "maxLength":20, "minLength":0 }, "payload":{ "type":"string" } } } ], "required":[ "payload", "title" ], "title":"CallButton" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.CursorPageInfo":{ "type":"object", "description":"Cursor information.", "properties":{ "limit":{ "type":"integer", "format":"int32", "description":"Requested limit." }, "nextCursor":{ "type":"string", "description":"The `cursor` value you will use in your next request to fetch the subsequent set of results." } }, "readOnly":true, "title":"CursorPageInfo" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DefaultAction":{ "type":"object", "properties":{ "url":{ "type":"string" } }, "required":[ "url" ], "title":"DefaultAction" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryDay":{ "type":"string", "description":"Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.", "enum":[ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "title":"DeliveryDay" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryReport":{ "type":"object", "description":"Collection of reports, one per every message.", "properties":{ "bulkId":{ "type":"string", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request." }, "price":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessagePrice" }, "status":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageStatus" }, "error":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageError" }, "messageId":{ "type":"string", "description":"Unique message ID." }, "to":{ "type":"string", "description":"Message destination address." }, "sender":{ "type":"string", "description":"The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`)." }, "sentAt":{ "type":"string", "format":"date-time", "description":"Date and time when the message was sent. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, "doneAt":{ "type":"string", "format":"date-time", "description":"Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, "messageCount":{ "type":"integer", "format":"int32", "description":"The number of sent messages." }, "mccMnc":{ "type":"string", "description":"Mobile country and network codes." }, "callbackData":{ "type":"string", "description":"Callback data sent through ‛callbackData‛ field when sending message." }, "platform":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.Platform" }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." } }, "title":"DeliveryReport" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryReports":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of reports, one per every message.", "items":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryReport" } } }, "title":"DeliveryReports" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryTime":{ "type":"object", "description":"The exact time of the day. The time is expressed in the UTC time zone.", "properties":{ "hour":{ "type":"integer", "format":"int32", "description":"Hour when the time window opens when used in the `from` property or closes when used in the `to` property.", "maximum":23, "minimum":0 }, "minute":{ "type":"integer", "format":"int32", "description":"Minute when the time window opens when used in the `from` property or closes when used in the `to` property.", "maximum":59, "minimum":0 } }, "required":[ "hour", "minute" ], "title":"DeliveryTime" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryTimeWindow":{ "type":"object", "description":"Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.", "properties":{ "days":{ "type":"array", "description":"Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.", "items":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryDay" } }, "from":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryTime" }, "to":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryTime" } }, "required":[ "days" ], "title":"DeliveryTimeWindow" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyAudioContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyContent" }, { "type":"object", "properties":{ "url":{ "type":"string", "maxLength":800, "minLength":0 } } } ], "required":[ "type", "url" ], "title":"FacebookBodyAudioContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyContent":{ "type":"object", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyTextContent", "IMAGE":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyImageContent", "LOCATION":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyLocationContent", "VIDEO":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyVideoContent", "AUDIO":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyAudioContent", "DOCUMENT":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyDocumentContent", "SENDER_ACTION":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodySenderActionContent", "TEMPLATE":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyTemplateContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyContentType" } }, "required":[ "type" ], "title":"FacebookBodyContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyContentType":{ "type":"string", "enum":[ "TEXT", "IMAGE", "LOCATION", "VIDEO", "AUDIO", "DOCUMENT", "SENDER_ACTION", "TEMPLATE" ], "title":"FacebookBodyContentType" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyDocumentContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyContent" }, { "type":"object", "properties":{ "url":{ "type":"string", "maxLength":800, "minLength":0 } } } ], "required":[ "type", "url" ], "title":"FacebookBodyDocumentContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyImageContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyContent" }, { "type":"object", "properties":{ "url":{ "type":"string", "maxLength":1000, "minLength":0 } } } ], "required":[ "type", "url" ], "title":"FacebookBodyImageContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyLocationContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyContent" }, { "type":"object", "properties":{ "latitude":{ "type":"number", "format":"double", "maximum":90, "minimum":-90 }, "longitude":{ "type":"number", "format":"double", "maximum":180, "minimum":-180 }, "name":{ "type":"string" }, "address":{ "type":"string" } } } ], "required":[ "latitude", "longitude", "type" ], "title":"FacebookBodyLocationContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodySenderActionContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyContent" }, { "type":"object", "properties":{ "senderAction":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SenderAction" } } } ], "required":[ "senderAction", "type" ], "title":"FacebookBodySenderActionContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyTemplateContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyContent" }, { "type":"object", "properties":{ "payload":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookTemplatePayload" } } } ], "required":[ "payload", "type" ], "title":"FacebookBodyTemplateContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyTextContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "maxLength":2000, "minLength":0 } } } ], "required":[ "text", "type" ], "title":"FacebookBodyTextContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyVideoContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyContent" }, { "type":"object", "properties":{ "url":{ "type":"string", "maxLength":800, "minLength":0 } } } ], "required":[ "type", "url" ], "title":"FacebookBodyVideoContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundAudioContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContent" }, { "type":"object", "properties":{ "url":{ "type":"string" } } } ], "title":"FacebookInboundAudioContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContent":{ "type":"object", "description":"Message content.", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundTextContent", "URL":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundUrlContent", "AUDIO":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundAudioContent", "VIDEO":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundVideoContent", "FILE":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundFileContent", "IMAGE":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundImageContent", "FALLBACK":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundFallbackContent", "LOCATION":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundLocationCoordinatesContent", "LOCATION_URL":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundLocationUrlContent", "POSTBACK":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundPostbackContent", "UNKNOWN":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundUnknownContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContentType" } }, "title":"FacebookInboundContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContentType":{ "type":"string", "enum":[ "TEXT", "URL", "AUDIO", "VIDEO", "FILE", "IMAGE", "FALLBACK", "LOCATION", "LOCATION_URL", "POSTBACK", "UNKNOWN" ], "title":"FacebookInboundContentType" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundFallbackContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContent" }, { "type":"object", "properties":{ "url":{ "type":"string" }, "title":{ "type":"string" } } } ], "required":[ "title" ], "title":"FacebookInboundFallbackContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundFileContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContent" }, { "type":"object", "properties":{ "url":{ "type":"string" } } } ], "title":"FacebookInboundFileContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundImageContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContent" }, { "type":"object", "properties":{ "url":{ "type":"string" }, "stickerId":{ "type":"string" } } } ], "required":[ "stickerId" ], "title":"FacebookInboundImageContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundLocationCoordinatesContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContent" }, { "type":"object", "properties":{ "latitude":{ "type":"number", "format":"double" }, "longitude":{ "type":"number", "format":"double" } } } ], "title":"FacebookInboundLocationCoordinatesContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundLocationUrlContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContent" }, { "type":"object", "properties":{ "url":{ "type":"string" } } } ], "title":"FacebookInboundLocationUrlContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundPostbackContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContent" }, { "type":"object", "properties":{ "payload":{ "type":"string" }, "title":{ "type":"string" } } } ], "title":"FacebookInboundPostbackContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundRequest":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of mobile originated messages.", "items":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.InboundMessageFacebookInboundContent" } }, "messageCount":{ "type":"integer", "format":"int32", "description":"The number of messages returned in the results array." }, "pendingMessageCount":{ "type":"integer", "format":"int32", "description":"The number of messages that have not been pulled in." } }, "title":"FacebookInboundRequest" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundTextContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContent" }, { "type":"object", "properties":{ "mid":{ "type":"string" }, "text":{ "type":"string" }, "quickReply":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMoQuickReply" }, "replyTo":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ReplyTo" } } } ], "required":[ "quickReply", "replyTo" ], "title":"FacebookInboundTextContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundUnknownContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContent" }, { "type":"object", "properties":{ "raw":{ "type":"object", "additionalProperties":{ "type":"object" } } } } ], "title":"FacebookInboundUnknownContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundUrlContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContent" }, { "type":"object", "properties":{ "url":{ "type":"string" } } } ], "title":"FacebookInboundUrlContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundVideoContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContent" }, { "type":"object", "properties":{ "url":{ "type":"string" } } } ], "title":"FacebookInboundVideoContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMessage":{ "type":"object", "description":"An array of message objects of a single message or multiple messages sent under one bulk ID.", "properties":{ "sender":{ "type":"string", "description":"The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names)." }, "destinations":{ "type":"array", "description":"An array of destination objects for where messages are being sent. A valid destination is required.", "items":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ToDestination" } }, "content":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent" }, "options":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.NonMsisdnMessageFailoverOptions" }, "webhooks":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.AdvancedWebhooksWithSeen" }, "quickReplies":{ "type":"array", "items":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMtQuickReply" } } }, "required":[ "content", "destinations", "sender" ], "title":"FacebookMessage" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMessageRequestOptions":{ "type":"object", "description":"Options applicable to all messages in the request.", "properties":{ "schedule":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.RequestSchedulingSettings" } }, "title":"FacebookMessageRequestOptions" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMoQuickReply":{ "type":"object", "properties":{ "payload":{ "type":"string" } }, "title":"FacebookMoQuickReply" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMtEmailQuickReply":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMtQuickReply" } ], "title":"FacebookMtEmailQuickReply" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMtQuickReply":{ "type":"object", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.TextFacebookMtQuickReply", "PHONE_NUMBER":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.PhoneNumberFacebookMtQuickReply", "EMAIL":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMtEmailQuickReply" } }, "properties":{ "type":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMtQuickReplyContentType" } }, "title":"FacebookMtQuickReply" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMtQuickReplyContentType":{ "type":"string", "enum":[ "TEXT", "PHONE_NUMBER", "EMAIL" ], "title":"FacebookMtQuickReplyContentType" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundAudioContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent" }, { "type":"object", "properties":{ "url":{ "type":"string", "maxLength":800, "minLength":0 } } } ], "required":[ "type", "url" ], "title":"FacebookOutboundAudioContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundCommentContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent" }, { "type":"object", "properties":{ "content":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyContent" } } } ], "required":[ "content", "type" ], "title":"FacebookOutboundCommentContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent":{ "type":"object", "description":"Message content.", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundTextContent", "IMAGE":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundImageContent", "LOCATION":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundLocationContent", "VIDEO":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundVideoContent", "AUDIO":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundAudioContent", "DOCUMENT":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundDocumentContent", "SENDER_ACTION":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundSenderActionContent", "TEMPLATE":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundTemplateContent", "COMMENT":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundCommentContent", "POST":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundPostContent", "OPT_IN_FOLLOWUP":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundOptInFollowupContent", "MARKETING_MESSAGE":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundMarketingMessageContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContentType" } }, "required":[ "type" ], "title":"FacebookOutboundContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContentType":{ "type":"string", "enum":[ "TEXT", "IMAGE", "LOCATION", "VIDEO", "AUDIO", "DOCUMENT", "SENDER_ACTION", "TEMPLATE", "COMMENT", "POST", "OPT_IN_FOLLOWUP", "MARKETING_MESSAGE" ], "title":"FacebookOutboundContentType" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundDocumentContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent" }, { "type":"object", "properties":{ "url":{ "type":"string", "maxLength":800, "minLength":0 } } } ], "required":[ "type", "url" ], "title":"FacebookOutboundDocumentContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundImageContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent" }, { "type":"object", "properties":{ "url":{ "type":"string", "maxLength":1000, "minLength":0 } } } ], "required":[ "type", "url" ], "title":"FacebookOutboundImageContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundLocationContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent" }, { "type":"object", "properties":{ "latitude":{ "type":"number", "format":"double", "maximum":90, "minimum":-90 }, "longitude":{ "type":"number", "format":"double", "maximum":180, "minimum":-180 }, "name":{ "type":"string" }, "address":{ "type":"string" } } } ], "required":[ "latitude", "longitude", "type" ], "title":"FacebookOutboundLocationContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundMarketingMessageAllowedContent":{ "type":"object", "discriminator":{ "propertyName":"type", "mapping":{ "TEMPLATE":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundMarketingTemplateContent", "TEXT":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundMarketingTextContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundMarketingMessageAllowedContentType" } }, "required":[ "type" ], "title":"FacebookOutboundMarketingMessageAllowedContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundMarketingMessageAllowedContentType":{ "type":"string", "enum":[ "TEMPLATE", "TEXT" ], "title":"FacebookOutboundMarketingMessageAllowedContentType" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundMarketingMessageContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent" }, { "type":"object", "properties":{ "campaignId":{ "type":"string" }, "content":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundMarketingMessageAllowedContent" } } } ], "required":[ "campaignId", "content", "type" ], "title":"FacebookOutboundMarketingMessageContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundMarketingTemplateContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundMarketingMessageAllowedContent" }, { "type":"object", "properties":{ "payload":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookTemplatePayload" } } } ], "required":[ "payload", "type" ], "title":"FacebookOutboundMarketingTemplateContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundMarketingTextContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundMarketingMessageAllowedContent" }, { "type":"object", "properties":{ "payload":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundMarketingTextPayload" } } } ], "required":[ "payload", "type" ], "title":"FacebookOutboundMarketingTextContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundMarketingTextPayload":{ "type":"object", "properties":{ "text":{ "type":"string", "maxLength":2000, "minLength":0 } }, "required":[ "text" ], "title":"FacebookOutboundMarketingTextPayload" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundOptInFollowupContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent" }, { "type":"object", "properties":{ "text":{ "type":"string" } } } ], "required":[ "text", "type" ], "title":"FacebookOutboundOptInFollowupContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundPostContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent" }, { "type":"object", "properties":{ "content":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookBodyContent" } } } ], "required":[ "content", "type" ], "title":"FacebookOutboundPostContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundSenderActionContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent" }, { "type":"object", "properties":{ "senderAction":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SenderAction" } } } ], "required":[ "senderAction", "type" ], "title":"FacebookOutboundSenderActionContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundTemplateContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent" }, { "type":"object", "properties":{ "payload":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookTemplatePayload" } } } ], "required":[ "payload", "type" ], "title":"FacebookOutboundTemplateContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundTextContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "maxLength":2000, "minLength":0 } } } ], "required":[ "text", "type" ], "title":"FacebookOutboundTextContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundVideoContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent" }, { "type":"object", "properties":{ "url":{ "type":"string", "maxLength":800, "minLength":0 } } } ], "required":[ "type", "url" ], "title":"FacebookOutboundVideoContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookRequest":{ "type":"object", "properties":{ "messages":{ "type":"array", "description":"An array of message objects of a single message or multiple messages sent under one bulk ID.", "items":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMessage" } }, "options":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMessageRequestOptions" } }, "required":[ "messages" ], "title":"FacebookRequest" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookTemplatePayload":{ "type":"object", "discriminator":{ "propertyName":"type", "mapping":{ "BUTTON":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ButtonFacebookTemplatePayload", "GENERIC":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.GenericFacebookTemplatePayload", "OPT_IN":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.OptInFacebookTemplatePayload", "OPT_IN_CAROUSEL":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.OptInCarouselFacebookTemplatePayload", "MARKETING_MESSAGE":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MarketingMessageFacebookTemplatePayload" } }, "properties":{ "type":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookTemplatePayloadType" } }, "title":"FacebookTemplatePayload" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookTemplatePayloadType":{ "type":"string", "enum":[ "BUTTON", "GENERIC", "OPT_IN", "OPT_IN_CAROUSEL", "MARKETING_MESSAGE" ], "title":"FacebookTemplatePayloadType" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FailoverDestinationPair":{ "type":"object", "description":"The SMS failover destination matching.", "properties":{ "initial":{ "type":"string", "description":"The initial destination address specified in the request." }, "failover":{ "type":"string", "description":"The failover destination address to be used instead of the original destination address. Addresses must be in international format (Example: `41793026727`)" } }, "required":[ "failover", "initial" ], "title":"FailoverDestinationPair" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.GenericFacebookTemplatePayload":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookTemplatePayload" }, { "type":"object", "properties":{ "elements":{ "type":"array", "items":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.GenericTemplateElement" }, "maxItems":10, "minItems":1 } } } ], "required":[ "elements" ], "title":"GenericFacebookTemplatePayload" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.GenericTemplateElement":{ "type":"object", "properties":{ "title":{ "type":"string", "maxLength":80, "minLength":0 }, "subtitle":{ "type":"string", "maxLength":80, "minLength":0 }, "imageUrl":{ "type":"string" }, "defaultAction":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DefaultAction" }, "buttons":{ "type":"array", "items":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.Button" }, "maxItems":3, "minItems":0 } }, "required":[ "title" ], "title":"GenericTemplateElement" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ImageAspectRatio":{ "type":"string", "enum":[ "SQUARE", "HORIZONTAL" ], "title":"ImageAspectRatio" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.InboundMessageFacebookInboundContent":{ "type":"object", "description":"Collection of mobile originated messages.", "properties":{ "entityId":{ "type":"string", "description":"Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "maxLength":255, "minLength":0 }, "applicationId":{ "type":"string", "description":"Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "maxLength":255, "minLength":0 }, "sender":{ "type":"string", "description":"Number which sent the message." }, "to":{ "type":"string", "description":"Sender provided during the activation process." }, "integrationType":{ "type":"string", "description":"Integration type." }, "receivedAt":{ "type":"string", "format":"date-time", "description":"Date and time when Infobip received the message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, "keyword":{ "type":"string", "description":"Keyword extracted from the message text." }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the received message." }, "pairedMessageId":{ "type":"string", "description":"Message ID of paired outgoing message if matched by Infobip platform." }, "callbackData":{ "type":"string", "description":"Callback data sent through ‛callbackData‛ field when sending message." }, "message":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContent" }, "price":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessagePrice" } }, "required":[ "integrationType", "message", "messageId", "price", "receivedAt", "sender", "to" ], "title":"InboundMessageFacebookInboundContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.IndiaDltOptions":{ "type":"object", "description":"Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.", "properties":{ "contentTemplateId":{ "type":"string", "description":"Registered DLT content template ID which matches message you are sending." }, "principalEntityId":{ "type":"string", "description":"Your assigned DLT principal entity ID." }, "telemarketerId":{ "type":"string", "description":"Your assigned Telemarketer ID. (required for Aggregators)" } }, "required":[ "principalEntityId" ], "title":"IndiaDltOptions" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.LogFacebookOutboundContent":{ "type":"object", "description":"An array of message log results, one object per each message log entry.", "properties":{ "sender":{ "type":"string", "description":"The sender ID which can be alphanumeric or numeric." }, "destination":{ "type":"string", "description":"Message destination address." }, "bulkId":{ "type":"string", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.", "example":"BULK-ID-123-xyz" }, "messageId":{ "type":"string", "description":"Unique message ID for which a log is requested." }, "sentAt":{ "type":"string", "format":"date-time", "description":"Date and time when the message was sent. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, "doneAt":{ "type":"string", "format":"date-time", "description":"Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, "messageCount":{ "type":"integer", "format":"int32", "description":"The number of messages content was split to." }, "price":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessagePrice" }, "status":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageStatus" }, "error":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageError" }, "platform":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.Platform" }, "content":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent" }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." } }, "title":"LogFacebookOutboundContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.LogResponseLogFacebookOutboundContent":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"An array of message log results, one object per each message log entry.", "items":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.LogFacebookOutboundContent" } }, "cursor":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.CursorPageInfo" } }, "title":"LogResponseLogFacebookOutboundContent" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MarketingMessageFacebookTemplatePayload":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookTemplatePayload" }, { "type":"object", "properties":{ "elements":{ "type":"array", "items":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.GenericTemplateElement" }, "maxItems":10, "minItems":1 } } } ], "required":[ "elements" ], "title":"MarketingMessageFacebookTemplatePayload" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageError":{ "type":"object", "description":"Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) occurred during the query execution.", "properties":{ "groupId":{ "type":"integer", "format":"int32", "description":"Error group ID." }, "groupName":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageErrorGroup" }, "id":{ "type":"integer", "format":"int32", "description":"Error ID." }, "name":{ "type":"string", "description":"[Error name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes)." }, "description":{ "type":"string", "description":"Human-readable description of the error." }, "permanent":{ "type":"boolean", "description":"Indicates whether the error is recoverable or not." } }, "title":"MessageError" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageErrorGroup":{ "type":"string", "description":"Error group name that describes which category the error code belongs to.", "enum":[ "OK", "HANDSET_ERRORS", "USER_ERRORS", "OPERATOR_ERRORS" ], "title":"MessageErrorGroup" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageGeneralStatus":{ "type":"string", "description":"Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).", "enum":[ "ACCEPTED", "PENDING", "UNDELIVERABLE", "DELIVERED", "EXPIRED", "REJECTED" ], "title":"MessageGeneralStatus" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessagePrice":{ "type":"object", "description":"Sent message price.", "properties":{ "pricePerMessage":{ "type":"number", "description":"Price per one message." }, "currency":{ "type":"string", "description":"The currency in which the price is expressed." } }, "title":"MessagePrice" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageResponseDetails":{ "type":"object", "description":"Other details of the message.", "title":"MessageResponseDetails" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageResponseMessageResponseDetails":{ "type":"object", "description":"An array of message objects of a single message or multiple messages sent under one bulk ID.", "properties":{ "messageId":{ "type":"string", "description":"Unique message ID. If not provided, it will be auto-generated and returned in the API response." }, "status":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageStatus" }, "destination":{ "type":"string", "description":"The destination address of the message, i.e., its recipient." }, "details":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageResponseDetails" } }, "title":"MessageResponseMessageResponseDetails" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageStatus":{ "type":"object", "description":"Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.", "properties":{ "groupId":{ "type":"integer", "format":"int32", "description":"Status group ID." }, "groupName":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageGeneralStatus" }, "id":{ "type":"integer", "format":"int32", "description":"Status code ID." }, "name":{ "type":"string", "description":"[Status code](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) name." }, "description":{ "type":"string", "description":"Human-readable description of the status." }, "action":{ "type":"string", "description":"Action to take to recover from the error." } }, "title":"MessageStatus" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.NonMsisdnMessageFailoverOptions":{ "type":"object", "description":"Message options.", "properties":{ "platform":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.Platform" }, "validityPeriod":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ValidityPeriod" }, "deliveryTimeWindow":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryTimeWindow" }, "campaignReferenceId":{ "type":"string", "description":"ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.", "maxLength":255, "minLength":0 }, "smsFailover":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.NonMsisdnSmsFailover" } }, "title":"NonMsisdnMessageFailoverOptions" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.NonMsisdnSmsFailover":{ "type":"object", "description":"Failover SMS message to be sent if the original message could not be delivered.", "properties":{ "sender":{ "type":"string", "description":"The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names)." }, "text":{ "type":"string", "description":"Content of the message being sent." }, "validityPeriod":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ValidityPeriod" }, "regional":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.RegionalOptions" }, "destinationMatching":{ "type":"array", "description":"The SMS failover destination matching.", "items":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FailoverDestinationPair" } } }, "required":[ "text" ], "title":"NonMsisdnSmsFailover" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.NotificationMessagesCtaText":{ "type":"string", "enum":[ "ALLOW", "GET", "GET_UPDATES", "OPT_IN", "SIGN_UP" ], "title":"NotificationMessagesCtaText" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.OptInCarouselFacebookTemplatePayload":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookTemplatePayload" }, { "type":"object", "properties":{ "elements":{ "type":"array", "items":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.OptInCarouselTemplateElement" }, "maxItems":5, "minItems":1 }, "imageAspectRatio":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ImageAspectRatio" }, "notificationMessagesTimezone":{ "type":"string" } } } ], "required":[ "elements" ], "title":"OptInCarouselFacebookTemplatePayload" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.OptInCarouselTemplateElement":{ "type":"object", "properties":{ "payload":{ "type":"string" }, "title":{ "type":"string", "maxLength":65, "minLength":0 }, "imageUrl":{ "type":"string" }, "notificationMessagesCtaText":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.NotificationMessagesCtaText" } }, "required":[ "payload", "title" ], "title":"OptInCarouselTemplateElement" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.OptInFacebookTemplatePayload":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookTemplatePayload" }, { "type":"object", "properties":{ "payload":{ "type":"string" }, "title":{ "type":"string", "maxLength":65, "minLength":0 }, "imageUrl":{ "type":"string" }, "imageAspectRatio":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ImageAspectRatio" }, "notificationMessagesTimezone":{ "type":"string" }, "notificationMessagesCtaText":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.NotificationMessagesCtaText" } } } ], "required":[ "payload" ], "title":"OptInFacebookTemplatePayload" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.PhoneNumberFacebookMtQuickReply":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMtQuickReply" } ], "title":"PhoneNumberFacebookMtQuickReply" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.Platform":{ "type":"object", "description":"Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "properties":{ "entityId":{ "type":"string", "description":"Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "maxLength":255, "minLength":0 }, "applicationId":{ "type":"string", "description":"Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "maxLength":255, "minLength":0 } }, "title":"Platform" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.PostbackButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.Button" }, { "type":"object", "properties":{ "title":{ "type":"string" }, "payload":{ "type":"string" } } } ], "required":[ "payload", "title" ], "title":"PostbackButton" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.RecipientType":{ "type":"string", "description":"Recipient Type must be `TACIR` or `BIREYSEL`.", "enum":[ "BIREYSEL", "TACIR" ], "title":"RecipientType" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.RegionalOptions":{ "type":"object", "description":"Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.", "properties":{ "indiaDlt":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.IndiaDltOptions" }, "turkeyIys":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.TurkeyIysOptions" }, "southKorea":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SouthKoreaOptions" } }, "title":"RegionalOptions" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ReplyTo":{ "type":"object", "properties":{ "mid":{ "type":"string" } }, "title":"ReplyTo" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.RequestSchedulingSettings":{ "type":"object", "description":"Options for scheduling a message.", "properties":{ "bulkId":{ "type":"string", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response.", "maxLength":100, "minLength":0 }, "sendAt":{ "type":"string", "format":"date-time", "description":"Date and time when the message is to be sent. Used for scheduled messages. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, and can only be scheduled for no later than 180 days in advance." }, "sendingSpeedLimit":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SendingSpeedLimit" } }, "title":"RequestSchedulingSettings" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ResponseEnvelopeMessageResponseMessageResponseDetails":{ "type":"object", "properties":{ "bulkId":{ "type":"string", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response. Typically used for fetching delivery reports and message logs." }, "messages":{ "type":"array", "description":"An array of message objects of a single message or multiple messages sent under one bulk ID.", "items":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageResponseMessageResponseDetails" } } }, "required":[ "messages" ], "title":"ResponseEnvelopeMessageResponseMessageResponseDetails" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SeenReport":{ "type":"object", "description":"Collection of reports, one per every message.", "properties":{ "messageId":{ "type":"string", "description":"The ID of the sent message." }, "from":{ "type":"string", "description":"Number which sent the message." }, "to":{ "type":"string", "description":"Sender provided during the activation process." }, "sentAt":{ "type":"string", "format":"date-time", "description":"Tells when the message was sent." }, "seenAt":{ "type":"string", "format":"date-time", "description":"Tells when the message was seen." }, "applicationId":{ "type":"string", "description":"Application id that the message is linked to." }, "entityId":{ "type":"string", "description":"Entity id that the message is linked to." }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." } }, "title":"SeenReport" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SeenReports":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of reports, one per every message.", "items":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SeenReport" } } }, "title":"SeenReports" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SeenStatusReporting":{ "type":"object", "description":"Provides options for configuring the seen report behavior.", "properties":{ "url":{ "type":"string", "description":"The URL on your call back server where a seen report will be sent." } }, "title":"SeenStatusReporting" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SenderAction":{ "type":"string", "enum":[ "MARK_SEEN", "TYPING_ON", "TYPING_OFF" ], "title":"SenderAction" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SendingSpeedLimit":{ "type":"object", "description":"Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.", "properties":{ "amount":{ "type":"integer", "format":"int32", "description":"The number of messages to be sent per timeUnit. By default, the system sends messages as fast as the infrastructure allows. Use this parameter to adapt sending capacity to your needs. The system is only able to work against its maximum capacity for ambitious message batches." }, "timeUnit":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SpeedLimitTimeUnit" } }, "required":[ "amount" ], "title":"SendingSpeedLimit" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SouthKoreaOptions":{ "type":"object", "description":"Use case dependent parameters for sending SMS to phone numbers registered in South Korea.", "properties":{ "title":{ "type":"string", "description":"Title of the message.", "maxLength":66, "minLength":0 }, "resellerCode":{ "type":"integer", "format":"int32", "description":"Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending." } }, "title":"SouthKoreaOptions" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SpeedLimitTimeUnit":{ "type":"string", "default":"MINUTE", "description":"The time unit to define when setting a messaging speed limit. Defaults to `MINUTE`.", "enum":[ "MINUTE", "HOUR", "DAY" ], "title":"SpeedLimitTimeUnit" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.TextFacebookMtQuickReply":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMtQuickReply" }, { "type":"object", "properties":{ "title":{ "type":"string", "maxLength":20, "minLength":0 }, "payload":{ "type":"string", "maxLength":1000, "minLength":0 }, "imageUrl":{ "type":"string" } } } ], "required":[ "payload", "title" ], "title":"TextFacebookMtQuickReply" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ToDestination":{ "type":"object", "description":"An array of destination objects for where messages are being sent. A valid destination is required.", "properties":{ "to":{ "type":"string", "description":"The destination address of the message." }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the message sent.", "maxLength":200, "minLength":0 } }, "required":[ "to" ], "title":"Destination" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.TurkeyIysOptions":{ "type":"object", "description":"IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.", "properties":{ "brandCode":{ "type":"integer", "format":"int32", "description":"Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account." }, "recipientType":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.RecipientType" } }, "required":[ "recipientType" ], "title":"TurkeyIysOptions" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.UrlButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.Button" }, { "type":"object", "properties":{ "title":{ "type":"string" }, "url":{ "type":"string" } } } ], "required":[ "title", "url" ], "title":"UrlButton" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ValidityPeriod":{ "type":"object", "description":"Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.", "properties":{ "amount":{ "type":"integer", "format":"int32", "description":"Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`." }, "timeUnit":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ValidityPeriodTimeUnit" } }, "required":[ "amount" ], "title":"ValidityPeriod" }, "747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ValidityPeriodTimeUnit":{ "type":"string", "default":"MINUTES", "description":"Message validity period time unit.", "enum":[ "SECONDS", "MINUTES", "HOURS" ], "title":"ValidityPeriodTimeUnit" }, "ApiError":{ "type":"object", "properties":{ "errorCode":{ "type":"string", "description":"An error code uniquely identifying the error case." }, "description":{ "type":"string", "description":"A detailed description of an error." }, "action":{ "type":"string", "description":"An action that should be taken to recover from the error." }, "violations":{ "type":"array", "description":"List of violations that caused the error.", "items":{ "$ref":"#/components/schemas/ApiErrorViolation" } }, "resources":{ "type":"array", "description":"List of available resources to recover from the error.", "items":{ "$ref":"#/components/schemas/ApiErrorResource" } } }, "required":[ "action", "description", "errorCode", "resources", "violations" ], "title":"ApiError" }, "ApiErrorResource":{ "type":"object", "description":"List of available resources to recover from the error.", "properties":{ "name":{ "type":"string", "description":"Resource name." }, "url":{ "type":"string", "description":"Resource URL." } }, "title":"ApiErrorResource" }, "ApiErrorViolation":{ "type":"object", "description":"List of violations that caused the error.", "properties":{ "property":{ "type":"string", "description":"Request property that caused the error." }, "violation":{ "type":"string", "description":"Detailed violation description." } }, "title":"ApiErrorViolation" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AdAccountResponse":{ "type":"object", "description":"List of ad accounts.", "properties":{ "id":{ "type":"string", "description":"Ad account ID.", "example":"act_3339405976215927" }, "status":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AdAccountStatus" }, "currency":{ "type":"string", "description":"Currency used by the ad account.", "example":"USD" }, "totalSpent":{ "type":"integer", "format":"int64", "description":"Total amount spent.", "example":186 } }, "title":"AdAccountResponse" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AdAccountStatus":{ "type":"string", "description":"Ad account status.", "enum":[ "ACTIVE", "DISABLED", "UNSETTLED", "PENDING_RISK_REVIEW", "PENDING_SETTLEMENT", "IN_GRACE_PERIOD", "PENDING_CLOSURE", "CLOSED", "ANY_ACTIVE", "ANY_CLOSED", "UNKNOWN" ], "example":"ACTIVE", "title":"AdAccountStatus" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AudienceUsersRequest":{ "type":"object", "properties":{ "data":{ "type":"array", "description":"Array of SHA-256 hashed phone numbers. Phone values must be normalized before hashing: remove symbols, letters, and any leading zeroes, keeping only the country code and digits (e.g. \"(+84) 091-2345678\" becomes \"84912345678\" before hashing). Each hashed value must be a 64-character lowercase hexadecimal string.", "example":[ "d6736136ea896c1bfdc553e0e86e702c70d060d805696ca3e4e9e0961353860a" ], "items":{ "type":"string", "description":"Array of SHA-256 hashed phone numbers. Phone values must be normalized before hashing: remove symbols, letters, and any leading zeroes, keeping only the country code and digits (e.g. \"(+84) 091-2345678\" becomes \"84912345678\" before hashing). Each hashed value must be a 64-character lowercase hexadecimal string.", "example":"[\"d6736136ea896c1bfdc553e0e86e702c70d060d805696ca3e4e9e0961353860a\"]" }, "maxItems":10000, "minItems":1 } }, "required":[ "data" ], "title":"AudienceUsersRequest" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AudienceUsersResponse":{ "type":"object", "properties":{ "audienceId":{ "type":"string", "description":"Meta custom audience ID.", "example":"52512562968362" }, "numReceived":{ "type":"integer", "format":"int32", "description":"Number of entries received.", "example":1 }, "numInvalidEntries":{ "type":"integer", "format":"int32", "description":"Number of invalid entries.", "example":0 }, "subscriptionInfo":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.SubscriptionInfo" } }, "title":"AudienceUsersResponse" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CampaignRequest":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Campaign name.", "example":"Summer Sale Campaign" }, "dailyBudget":{ "type":"integer", "format":"int64", "description":"Daily budget for the campaign in cents. At least one of `dailyBudget` or `lifetimeBudget` must be provided.", "example":10000 }, "lifetimeBudget":{ "type":"integer", "format":"int64", "description":"Lifetime budget for the campaign in cents. At least one of `dailyBudget` or `lifetimeBudget` must be provided.", "example":100000 }, "adAccountId":{ "type":"string", "description":"Facebook ad account ID associated with the campaign.", "example":"ACT_123456789", "maxLength":100, "minLength":1 }, "pageId":{ "type":"string", "description":"Facebook page ID associated with the campaign.", "example":"111111111111111", "maxLength":100, "minLength":1 } }, "required":[ "adAccountId", "name", "pageId" ], "title":"CampaignRequest" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CampaignResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Unique campaign ID.", "example":"120213234151570" }, "name":{ "type":"string", "description":"Campaign name.", "example":"Summer Sale Campaign" }, "adAccountId":{ "type":"string", "description":"Facebook ad account ID associated with the campaign.", "example":"ACT_123456789" }, "pageId":{ "type":"string", "description":"Facebook page ID associated with the campaign.", "example":"111111111111111" } }, "title":"CampaignResponse" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.ConsentEvent":{ "type":"string", "description":"Subscription event type.", "enum":[ "SUBSCRIBE", "UNSUBSCRIBE" ], "title":"ConsentEvent" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CreateAudienceRequest":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Custom audience name.", "example":"My CRM Audience", "maxLength":255, "minLength":1 }, "description":{ "type":"string", "description":"Custom audience description.", "example":"Q3 campaign target users", "maxLength":1024, "minLength":0 }, "adAccountId":{ "type":"string", "description":"Facebook ad account ID.", "example":"act_3339405976215927", "maxLength":100, "minLength":1 }, "pageId":{ "type":"string", "description":"Facebook page ID linked to marketing messages.", "example":"108968269613427", "maxLength":100, "minLength":1 } }, "required":[ "adAccountId", "name", "pageId" ], "title":"CreateAudienceRequest" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CreateAudienceResponse":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Meta custom audience ID.", "example":"52512562968362" }, "name":{ "type":"string", "description":"Custom audience name.", "example":"My CRM Audience" }, "description":{ "type":"string", "description":"Custom audience description.", "example":"Q3 campaign target users" }, "adAccountId":{ "type":"string", "description":"Facebook ad account ID.", "example":"act_3339405976215927" }, "pageId":{ "type":"string", "description":"Facebook page ID.", "example":"108968269613427" } }, "title":"CreateAudienceResponse" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetAdAccountsResponse":{ "type":"object", "properties":{ "adAccounts":{ "type":"array", "description":"List of ad accounts.", "items":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AdAccountResponse" } } }, "title":"GetAdAccountsResponse" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetAudienceResponse":{ "type":"object", "description":"List of custom audiences.", "properties":{ "id":{ "type":"string", "description":"Meta custom audience ID.", "example":"52512562968362" }, "name":{ "type":"string", "description":"Custom audience name.", "example":"My CRM Audience" }, "description":{ "type":"string", "description":"Custom audience description.", "example":"Q3 campaign target users" }, "adAccountId":{ "type":"string", "description":"Facebook ad account ID.", "example":"act_3339405976215927" }, "pageId":{ "type":"string", "description":"Facebook page ID.", "example":"108968269613427" } }, "title":"GetAudienceResponse" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetAudiencesResponse":{ "type":"object", "properties":{ "audiences":{ "type":"array", "description":"List of custom audiences.", "items":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetAudienceResponse" } } }, "title":"GetAudiencesResponse" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetCampaignResponse":{ "type":"object", "description":"List of campaigns.", "properties":{ "id":{ "type":"string", "description":"Campaign ID.", "example":"6938008105758" }, "name":{ "type":"string", "description":"Campaign name.", "example":"Campaign Name" }, "dailyBudget":{ "type":"integer", "format":"int64", "description":"Daily budget in cents. Zero if a lifetime budget is set.", "example":0 }, "lifetimeBudget":{ "type":"integer", "format":"int64", "description":"Lifetime budget in cents.", "example":3000 }, "adAccountId":{ "type":"string", "description":"Ad account ID.", "example":"3339405976215927" }, "pageId":{ "type":"string", "description":"Facebook Page ID.", "example":"975663645629834" }, "startTime":{ "type":"string", "description":"Campaign start time.", "example":"2026-04-20T01:08:10-0700" }, "endTime":{ "type":"string", "description":"Campaign end time.", "example":"2026-05-20T01:08:09-0700" } }, "title":"GetCampaignResponse" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetCampaignsResponse":{ "type":"object", "properties":{ "campaigns":{ "type":"array", "description":"List of campaigns.", "items":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetCampaignResponse" } } }, "title":"GetCampaignsResponse" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MarketingMessageClick":{ "type":"object", "properties":{ "notificationType":{ "type":"string", "description":"Tells the type of user event that took place. Possible events: MARKETING_CLICK." }, "from":{ "type":"string", "description":"Token that represents the recipient. It is used to send Marketing Messages." }, "to":{ "type":"string", "description":"Page ID." }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the message sent to the recipient." }, "campaignId":{ "type":"string", "description":"Campaign Id." }, "clickedAt":{ "type":"string", "format":"date-time", "description":"Date and time when the marketing message was clicked. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." } }, "required":[ "campaignId", "clickedAt", "from", "messageId", "notificationType", "to" ], "title":"MarketingMessageClick" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MessengerConsentChannelData":{ "type":"object", "description":"Messenger-specific subscription data.", "properties":{ "notificationMessagesToken":{ "type":"string", "description":"Token required to send future marketing messages.", "example":"5049615565024480819" }, "tokenExpiry":{ "type":"string", "description":"Date when the notification message token expires.", "example":"2030-01-01T00:00:00.000+0000" }, "userTokenStatus":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.UserTokenStatus" }, "notificationMessagesTimezone":{ "type":"string", "description":"Timezone for the person receiving the message.", "example":"Europe/Warsaw" }, "subscriptionPayload":{ "type":"string", "description":"Payload string from the subscription opt-in button.", "example":"promo_campaign_v2" }, "subscriptionTitle":{ "type":"string", "description":"Title of the subscription opt-in.", "example":"Get weekly deals" } }, "required":[ "notificationMessagesToken" ], "title":"MessengerConsentChannelData" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MessengerConsentUpdate":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"List of consent update results.", "items":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MessengerConsentUpdateResult" } } }, "required":[ "results" ], "title":"MessengerConsentUpdate" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MessengerConsentUpdateResult":{ "type":"object", "description":"List of consent update results.", "properties":{ "channel":{ "type":"string", "description":"Channel identifier.", "example":"MESSENGER" }, "event":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.ConsentEvent" }, "sender":{ "type":"string", "description":"Business identifier (Facebook page ID).", "example":"112345678901234" }, "from":{ "type":"string", "description":"End-user identifier (page-scoped user ID).", "example":"6662136340512053" }, "createdAt":{ "type":"string", "description":"ISO 8601 timestamp of the event.", "example":"2024-01-14T12:00:00.000+0000" }, "channelData":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MessengerConsentChannelData" } }, "required":[ "channel", "channelData", "createdAt", "event", "from", "sender" ], "title":"MessengerConsentUpdateResult" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.NotificationMessageReoptin":{ "type":"string", "description":"Is Reoptin ENABLED or DISABLED.", "enum":[ "ENABLED", "DISABLED", "UNKNOWN" ], "example":"ENABLED", "title":"NotificationMessageReoptin" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.PageMarketingSubscriptionResponse":{ "type":"object", "properties":{ "notificationMessagesToken":{ "type":"string", "description":"Token that represents the person. It is used to send Marketing Messages.", "example":"1111111111111111111" }, "recipientId":{ "type":"string", "description":"Page ID.", "example":"1111111111111111" }, "notificationMessagesReoptin":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.NotificationMessageReoptin" }, "creationDatetime":{ "type":"string", "format":"date-time", "description":"Creation Datetime." }, "tokenExpiry":{ "type":"string", "format":"date-time", "description":"Date when the the notification message token expires." }, "userTokenStatus":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.UserTokenRefreshStatus" }, "title":{ "type":"string", "description":"Title.", "example":"title" }, "notificationMessagesTimezone":{ "type":"string", "description":"Timezone for the person receiving the message.", "example":"Europe\\/Zagreb" }, "nextEligibleDatetime":{ "type":"string", "format":"date-time", "description":"The date on which it will be possible to send the next message." } }, "required":[ "creationDatetime", "nextEligibleDatetime", "notificationMessagesReoptin", "notificationMessagesTimezone", "notificationMessagesToken", "recipientId", "title", "tokenExpiry", "userTokenStatus" ], "title":"PageMarketingSubscriptionResponse" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.SubscriptionInfo":{ "type":"object", "description":"Messenger subscription info.", "properties":{ "numSubscribersReceived":{ "type":"integer", "format":"int32", "description":"Number of subscribers matched.", "example":1 }, "numSubscribersInvalidEntries":{ "type":"integer", "format":"int32", "description":"Number of invalid subscriber entries.", "example":0 } }, "title":"SubscriptionInfo" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.UserTokenRefreshStatus":{ "type":"string", "description":"Status of notification. This field is present only when the user stops or resumes Marketing Messages.", "enum":[ "REFRESHED", "NOT_REFRESHED", "UNKNOWN" ], "example":"REFRESHED", "title":"UserTokenRefreshStatus" }, "cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.UserTokenStatus":{ "type":"string", "description":"Status of user token.", "enum":[ "REFRESHED", "NOT_REFRESHED", "UNKNOWN" ], "example":"REFRESHED", "title":"UserTokenStatus" } }, "responses":{ "ApiError401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E401", "description":"The request lacks valid authentication credentials for the requested resource.", "action":"Check the resources and adjust authentication credentials.", "violations":[], "resources":[ { "name":"API Authentication", "url":"https://www.infobip.com/docs/essentials/api-authentication" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E401\n The request lacks valid authentication credentials for the requested resource.\n Check the resources and adjust authentication credentials.\n \n \n \n API Authentication\n https://www.infobip.com/docs/essentials/api-authentication\n \n \n\n" } } }, "ApiError403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E403", "description":"Insufficient permissions to access the requested resource.", "action":"Repeat the request with new or different credentials.", "violations":[], "resources":[ { "name":"API Scopes", "url":"https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E403\n Insufficient permissions to access the requested resource.\n Repeat the request with new or different credentials.\n \n \n \n API Scopes\n https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes\n \n \n\n" } } }, "ApiError429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E429", "description":"Too many requests sent.", "action":"Check request rate limit specified in the API endpoint documentation resource.", "violations":[], "resources":[ { "name":"Throttling handling errors", "url":"https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E429\n Too many requests sent.\n Check request rate limit specified in the API endpoint documentation resource.\n \n \n \n Throttling handling errors\n https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors\n \n \n\n" } } }, "ApiError500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E500", "description":"Something went wrong.", "action":"Contact the support.", "violations":[], "resources":[] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E500\n Something went wrong.\n Contact the support.\n \n \n\n" } } } }, "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":{} }, "webhooks":{ "receive-outbound-messenger-message-delivery-reports":{ "post":{ "tags":[ "channels", "messenger", "logs-and-status-reports-messenger" ], "summary":"Receive Messenger delivery reports", "description":"For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’s URL to Customer support and they will set it up for you. Contact support@infobip.com if you require help.", "externalDocs":{ "description":"Learn more about Messenger channel and use cases", "url":"https://www.infobip.com/docs/facebook-messenger" }, "operationId":"receive-outbound-messenger-message-delivery-reports", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryReports" }, "examples":{ "Delivery reports":{ "summary":"Delivery reports", "value":{ "results":[ { "bulkId":"1688025180464000013", "price":{ "pricePerMessage":0.15, "currency":"EUR" }, "status":{ "groupId":3, "groupName":"DELIVERED", "id":5, "name":"DELIVERED_TO_HANDSET", "description":"Message delivered to handset" }, "error":{ "groupId":0, "groupName":"OK", "id":0, "name":"NO_ERROR", "description":"No Error", "permanent":false }, "messageId":"1688025180464000014", "to":"66855538125", "sender":"44113496000", "sentAt":"2023-09-26T10:52:15.457+0000", "doneAt":"2023-09-26T10:52:15.799+0000", "messageCount":1, "mccMnc":"22801", "platform":{ "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" } } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryReports" }, "examples":{ "Delivery reports":{ "summary":"Delivery reports", "value":"\n \n \n 1688025180464000013\n \n 0.15\n EUR\n \n \n 3\n DELIVERED\n 5\n DELIVERED_TO_HANDSET\n Message delivered to handset\n \n \n 0\n OK\n 0\n NO_ERROR\n No Error\n false\n \n 1688025180464000014\n 66855538125\n 44113496000\n 2023-09-26T10:52:15.457+0000\n 2023-09-26T10:52:15.799+0000\n 1\n 22801\n \n promotional-traffic-entity\n marketing-automation-application\n \n \n \n\n" } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } }, "x-is-early-access":true } }, "receive-messenger-seen-reports":{ "post":{ "tags":[ "channels", "messenger", "logs-and-status-reports-messenger" ], "summary":"Receive seen reports", "description":"For each message that you send out, we can send you a seen report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to Customer support and they will set it up for you. Alternatively, you can specify the endpoint per each message via the `webhooks > seen > url` parameter. Contact support@infobip.com if you require help.", "operationId":"receive-messenger-seen-reports", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SeenReports" }, "examples":{ "Seen report":{ "summary":"Seen report", "value":{ "results":[ { "messageId":"1215f543ab19-345f-adbd-12ad31451ed25f35", "from":"6662136340512053", "to":"17841447570021717", "sentAt":"2026-06-07T11:21:57.793+0000", "seenAt":"2026-06-07T11:22:10.251+0000", "applicationId":"example-application-id", "entityId":"example-entity-id", "campaignReferenceId":"campaignRefId" } ] } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } }, "x-is-early-access":true } }, "receive-messenger-marketing-click":{ "post":{ "tags":[ "channels", "messenger", "logs-and-status-reports-messenger" ], "summary":"Receive Messenger Marketing Click event", "description":"Event is sent when a person clicks a Marketing Message. For this to work you need to configure subscriptions. Refer to [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management) for additional info.", "externalDocs":{ "description":"Learn more about Messenger channel and use cases", "url":"https://www.infobip.com/docs/messenger" }, "operationId":"receive-messenger-marketing-click", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MarketingMessageClick" }, "examples":{ "Clicked event":{ "summary":"Clicked event", "value":{ "notificationType":"MARKETING_CLICK", "from":"1111111111111111111", "to":"111222333444555", "messageId":"222222222222", "campaignId":"123456789", "clickedAt":"2026-07-18T00:00:00.000+0000" } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } }, "x-is-early-access":true } }, "receive-messenger-api-incoming-messages":{ "post":{ "tags":[ "channels", "messenger", "incoming-messenger-message" ], "summary":"Receive incoming message", "description":"Incoming messages will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > delivery > url` parameter. Contact support@infobip.com if you require help.", "externalDocs":{ "description":"Learn more about Messenger channel and use cases", "url":"https://www.infobip.com/docs/facebook-messenger" }, "operationId":"receive-messenger-api-incoming-messages", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundRequest" }, "examples":{ "Received Messenger message":{ "summary":"Received Messenger message", "value":{ "results":[ { "sender":"6662136340512053", "to":"17841447570021717", "receivedAt":"2023-01-01T00:00:00.000+0000", "message":{ "mid":"aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEOjE3ODQxNDQ3NTcwMDIxODE4OjM0MDI4MjM2Njg0MTcxMDMwMTI0NDI3NjAxOTkzMzk2MzExNTc2NjozMTE3ODY3NTY2NDU5MzAzNzQ2NzUxNzQ2NTAzODY4NDE2MAZfdf", "text":"Hello", "type":"TEXT" } } ], "messageCount":1, "pendingMessageCount":0 } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } }, "x-is-early-access":true } }, "receive-messenger-consent-update":{ "post":{ "tags":[ "channels", "messenger", "incoming-messenger-event" ], "summary":"Receive Messenger consent update event", "description":"Event is sent when the person opts in or opts out of Marketing Messages. The `event` field indicates the type: `SUBSCRIBE` for opt-in, `UNSUBSCRIBE` for opt-out. For this to work you need to configure subscriptions. Refer to [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management) for additional info.
Collecting subscription tokens still works on the Messenger platform. However, marketing messages on Messenger are no longer available for new users. For existing users, this feature will be deprecated on January 12, 2026. After this date, marketing messages will no longer be supported.", "externalDocs":{ "description":"Learn more about Messenger channel and use cases", "url":"https://www.infobip.com/docs/messenger" }, "operationId":"receive-messenger-consent-update", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MessengerConsentUpdate" }, "examples":{ "Opt-in (SUBSCRIBE)":{ "summary":"Opt-in (SUBSCRIBE)", "value":{ "results":[ { "channel":"MESSENGER", "event":"SUBSCRIBE", "sender":"112345678901234", "from":"6662136340512053", "createdAt":"2024-01-14T12:00:00.000+0000", "channelData":{ "notificationMessagesToken":"5049615565024480819", "tokenExpiry":"2030-01-01T00:00:00.000+0000", "userTokenStatus":"REFRESHED", "notificationMessagesTimezone":"Europe/Warsaw", "subscriptionPayload":"promo_campaign_v2", "subscriptionTitle":"Get weekly deals" } } ] } }, "Opt-out (UNSUBSCRIBE)":{ "summary":"Opt-out (UNSUBSCRIBE)", "value":{ "results":[ { "channel":"MESSENGER", "event":"UNSUBSCRIBE", "sender":"112345678901234", "from":"6662136340512053", "createdAt":"2024-02-01T09:00:00.000+0000", "channelData":{ "notificationMessagesToken":"5049615565024480819", "tokenExpiry":"2030-01-01T00:00:00.000+0000", "userTokenStatus":"NOT_REFRESHED", "subscriptionPayload":"promo_campaign_v2", "subscriptionTitle":"Get weekly deals" } } ] } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } }, "x-is-early-access":true } } } }