Infobip
Infobip Apple Messages for Business API

Use Apple Messages for Business to contact customers in real time. Through the Messages app on iOS, macOS, watchOS, and iPadOS, Apple Messages for Business makes it easy for customers to communicate with businesses. — 4 operation path(s) and 2 webhook(s) in Infobip's published OpenAPI.
Documentation GitHub OpenAPI
OpenAPI Specification

{
 "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:00.141761715Z"
 },
 "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":"apple-mfb",
   "description":"Use Apple Messages for Business to contact customers in real time.\n\nThrough the Messages app on iOS, macOS, watchOS, and iPadOS, Apple Messages for Business makes it easy for customers to communicate with businesses. Customers can use the Messages app to communicate with brands for a number of reasons, including asking inquiries, getting help, scheduling appointments, and making payments using Apple Pay.\n\nPeople can use apps, features, and services like Maps and Spotlight (iPhone search) to discover businesses and seamlessly initiate conversations with them. The familiar Messages app interface on iPhone, iPad, Mac, and Apple Watch ensures that customer interaction is intuitive and efficient, and the informality of chat produces a customer service experience that feels personal and meaningful.\n\nMore than 2 billion active Apple devices worldwide can interact with brands through Apple Messages for Business.  \n\nTo utilize Apple Messages for Business in combination with other channels, check out [Messages API](https://www.infobip.com/docs/api/platform/messages-api).\n",
   "x-type":"product",
   "x-displayName":"Apple Messages for Business"
  },
  {
   "name":"sending-apple-mfb-message",
   "description":"Sends one or more messages to multiple recipients.\n",
   "x-type":"module",
   "x-displayName":"Outbound Message"
  },
  {
   "name":"logs-and-status-reports-apple-mfb",
   "description":"Status Reports tell you what happened to the message you sent, whether it was successfully delivered or failed to be delivered. Logs provide similar information to Status Reports but are available to query for 48hrs.\n",
   "x-type":"module",
   "x-displayName":"Logs and Status Reports"
  },
  {
   "name":"incoming-apple-mfb-message",
   "description":"Incoming messages will be forwarded in real time to the end-point client provided during the setup. This way, 2-way communication will be established, and the enterprise is enabled to create a certain logic for processing incoming messages.\n",
   "x-type":"module",
   "x-displayName":"Receive incoming message"
  }
 ],
 "paths":{
  "/apple-mfb/1/messages":{
   "post":{
    "tags":[
     "channels",
     "apple-mfb",
     "sending-apple-mfb-message"
    ],
    "summary":"Send Apple Messages for Business",
    "description":"Send one or more messages to multiple recipients.",
    "externalDocs":{
     "description":"Learn more about Apple Messages for Business channel and use cases",
     "url":"https://www.infobip.com/docs/apple-messages-for-business"
    },
    "operationId":"send-apple-mfb-message",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbRequest"
       },
       "examples":{
        "Text message example":{
         "summary":"Text message example",
         "value":{
          "messages":[
           {
            "sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
            "destinations":[
             {
              "to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
             }
            ],
            "content":{
             "text":"Some text",
             "type":"TEXT"
            }
           }
          ]
         }
        },
        "Image message example":{
         "summary":"Image message example",
         "value":{
          "messages":[
           {
            "sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
            "destinations":[
             {
              "to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
             }
            ],
            "content":{
             "url":"https://api.infobip.com/ott/1/media/testImage",
             "type":"IMAGE"
            }
           }
          ]
         }
        },
        "Image message with header and caption example":{
         "summary":"Image message with header and caption example",
         "value":{
          "messages":[
           {
            "sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
            "destinations":[
             {
              "to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
             }
            ],
            "content":{
             "url":"https://api.infobip.com/ott/1/media/testImage",
             "header":"Header",
             "caption":"Caption",
             "type":"IMAGE"
            }
           }
          ]
         }
        },
        "Video message example":{
         "summary":"Video message example",
         "value":{
          "messages":[
           {
            "sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
            "destinations":[
             {
              "to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
             }
            ],
            "content":{
             "url":"http://my.domain/video.mp4",
             "type":"VIDEO"
            }
           }
          ]
         }
        },
        "Video message with header and caption example":{
         "summary":"Video message with header and caption example",
         "value":{
          "messages":[
           {
            "sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
            "destinations":[
             {
              "to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
             }
            ],
            "content":{
             "url":"http://my.domain/video.mp4",
             "header":"header",
             "caption":"caption",
             "type":"VIDEO"
            }
           }
          ]
         }
        },
        "Document message example":{
         "summary":"Document message example",
         "value":{
          "messages":[
           {
            "sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
            "destinations":[
             {
              "to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
             }
            ],
            "content":{
             "url":"https://api.infobip.com/ott/1/media/testPdf",
             "type":"DOCUMENT"
            }
           }
          ]
         }
        },
        "Media message example":{
         "summary":"Media message example",
         "value":{
          "messages":[
           {
            "sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
            "destinations":[
             {
              "to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
             }
            ],
            "content":{
             "urls":[
              "https://api.infobip.com/ott/1/media/testImage",
              "http://my.domain/video.mp4"
             ],
             "type":"MEDIA"
            }
           }
          ]
         }
        },
        "Document message with header and caption example":{
         "summary":"Document message with header and caption example",
         "value":{
          "messages":[
           {
            "sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
            "destinations":[
             {
              "to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
             }
            ],
            "content":{
             "url":"https://api.infobip.com/ott/1/media/testPdf",
             "header":"header",
             "caption":"caption",
             "type":"DOCUMENT"
            }
           }
          ]
         }
        },
        "Text message with SMS failover":{
         "summary":"Text message with SMS failover",
         "value":{
          "messages":[
           {
            "sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
            "destinations":[
             {
              "to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
             }
            ],
            "content":{
             "text":"Some text",
             "type":"TEXT"
            },
            "options":{
             "smsFailover":{
              "sender":"InfoSMS",
              "text":"This is a failover message.",
              "destinationMatching":[
               {
                "initial":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
                "failover":"41793026727"
               }
              ]
             }
            }
           }
          ]
         }
        },
        "Rich link message example":{
         "summary":"Rich link message example",
         "value":{
          "messages":[
           {
            "sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
            "destinations":[
             {
              "to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
             }
            ],
            "content":{
             "linkUrl":"http://my.domain/image.png",
             "linkTitle":"Sample Title",
             "imageUrl":"https://api.infobip.com/ott/1/media/testImage",
             "videoUrl":"http://my.domain/video.mp4",
             "type":"RICH_LINK"
            }
           }
          ]
         }
        },
        "App Clip message example":{
         "summary":"App Clip message example",
         "value":{
          "messages":[
           {
            "sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
            "destinations":[
             {
              "to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
             }
            ],
            "content":{
             "url":"https://appclip.apple.com/id?=com.example.Clip&promotion=WWDC23",
             "storeRegion":"US",
             "type":"APP_CLIP"
            }
           }
          ]
         }
        },
        "Quick reply message example":{
         "summary":"Quick reply message example",
         "value":{
          "messages":[
           {
            "sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
            "destinations":[
             {
              "to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
             }
            ],
            "content":{
             "summaryText":"Summary Text",
             "items":[
              {
               "identifier":"identifier_1",
               "title":"Title 1"
              },
              {
               "identifier":"identifier_2",
               "title":"Title 2"
              }
             ],
             "requestIdentifier":"1234-5678",
             "type":"QUICK_REPLY"
            }
           }
          ]
         }
        },
        "Form message example":{
         "summary":"Form message example",
         "value":{
          "messages":[
           {
            "sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
            "destinations":[
             {
              "to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
             }
            ],
            "content":{
             "data":{
              "pages":[
               {
                "items":[
                 {
                  "identifier":"id-a",
                  "title":"Apples",
                  "value":"apples"
                 },
                 {
                  "identifier":"id-o",
                  "title":"Oranges",
                  "value":"oranges"
                 }
                ],
                "pageIdentifier":"0",
                "subtitle":"Select what fruit you like",
                "nextPageIdentifier":"1",
                "title":"Food",
                "submitForm":false,
                "multipleSelection":true,
                "type":"SELECT"
               },
               {
                "pageIdentifier":"1",
                "subtitle":"When were you born?",
                "title":"Birthday",
                "submitForm":true,
                "options":{
                 "dateFormat":"MM/DD/YYYY",
                 "startDate":"2025-01-05",
                 "maximumDate":"2025-01-10",
                 "minimumDate":"2025-01-01",
                 "labelText":"Choose the date"
                },
                "type":"DATE_PICKER"
               }
              ],
              "startPageIdentifier":"0",
              "private":true,
              "showSummary":true
             },
             "images":[
              {
               "imageUrl":"https://api.infobip.com/ott/1/media/testImage",
               "identifier":"imgIdScreen"
              }
             ],
             "requestIdentifier":"requestId",
             "receivedMessage":{
              "style":"ICON",
              "title":"Please fill out this form",
              "subtitle":"We really need this data",
              "imageIdentifier":"imgIdScreen"
             },
             "replyMessage":{
              "style":"ICON",
              "title":"Thank you!",
              "subtitle":"This will help improve our services",
              "imageIdentifier":"imgIdScreen"
             },
             "type":"FORM"
            }
           }
          ]
         }
        },
        "Authentication request message example":{
         "summary":"Authentication request message example",
         "value":{
          "messages":[
           {
            "sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
            "destinations":[
             {
              "to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
             }
            ],
            "content":{
             "images":[
              {
               "imageUrl":"https://api.infobip.com/ott/1/media/testImage",
               "identifier":"img1"
              }
             ],
             "requestIdentifier":"1234-5678",
             "receivedMessage":{
              "style":"ICON",
              "title":"Please log in",
              "subtitle":"using LinkedIn",
              "imageIdentifier":"img1"
             },
             "replyMessage":{
              "style":"ICON",
              "title":"Successful login",
              "subtitle":"using LinkedIn",
              "imageIdentifier":"img1"
             },
             "scopes":[
              "r_liteprofile"
             ],
             "type":"AUTHENTICATION_REQUEST"
            }
           }
          ]
         }
        },
        "Invitation message example":{
         "summary":"Invitation message example",
         "value":{
          "messages":[
           {
            "sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
            "destinations":[
             {
              "to":"48123456789"
             }
            ],
            "content":{
             "requestIdentifier":"1234-5678",
             "templateId":"binaryChoice.engage.noImage",
             "locale":"en-us",
             "referenceId":"1009273616-A",
             "placeholders":{
              "brandName":"testBrand"
             },
             "type":"INVITATION"
            }
           }
          ]
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ResponseEnvelopeMessageResponseMessageResponseDetails"
        },
        "examples":{
         "Successful response":{
          "summary":"Successful response",
          "value":{
           "bulkId":"1688025180464000013",
           "messages":[
            {
             "messageId":"1688025180464000014",
             "status":{
              "groupId":1,
              "groupName":"PENDING",
              "id":26,
              "name":"PENDING_ACCEPTED",
              "description":"Message sent to next instance"
             },
             "destination":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
            }
           ]
          }
         }
        }
       }
      }
     },
     "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",
     "apple-mfb:message:send",
     "apple-mfb:manage"
    ]
   }
  },
  "/apple-mfb/1/events":{
   "post":{
    "tags":[
     "channels",
     "apple-mfb",
     "sending-apple-mfb-message"
    ],
    "summary":"Send Apple Events",
    "description":"Send one or more events to multiple recipients.",
    "externalDocs":{
     "description":"Learn more about Apple Messages for Business channel and use cases",
     "url":"https://www.infobip.com/docs/apple-messages-for-business"
    },
    "operationId":"send-apple-mfb-event",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbEventRequest"
       },
       "examples":{
        "Typing indicator event example":{
         "summary":"Typing indicator event example",
         "value":{
          "events":[
           {
            "content":{
             "typingIndicatorType":"TYPING_START",
             "type":"TYPING_INDICATOR"
            },
            "sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
            "destinations":[
             {
              "to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
             }
            ]
           }
          ]
         }
        }
       }
      }
     },
     "required":true
    },
    "responses":{
     "200":{
      "description":"OK",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ResponseEnvelopeMessageResponseMessageResponseDetails"
        },
        "examples":{
         "Successful response":{
          "summary":"Successful response",
          "value":{
           "bulkId":"1688025180464000013",
           "messages":[
            {
             "messageId":"1688025180464000014",
             "status":{
              "groupId":1,
              "groupName":"PENDING",
              "id":26,
              "name":"PENDING_ACCEPTED",
              "description":"Message sent to next instance"
             },
             "destination":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
            }
           ]
          }
         }
        }
       }
      }
     },
     "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",
     "apple-mfb:message:send",
     "apple-mfb:manage"
    ]
   }
  },
  "/apple-mfb/1/reports":{
   "get":{
    "tags":[
     "channels",
     "apple-mfb",
     "logs-and-status-reports-apple-mfb"
    ],
    "summary":"Get Apple Messages for Business 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 Apple Messages for Business channel and use cases",
     "url":"https://www.infobip.com/docs/apple-messages-for-business"
    },
    "operationId":"get-outbound-apple-mfb-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/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryReports"
        },
        "examples":{
         "Delivery report":{
          "summary":"Delivery report",
          "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":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
             "sender":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
             "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",
     "apple-mfb:message:send",
     "apple-mfb:manage"
    ]
   }
  },
  "/apple-mfb/1/logs":{
   "get":{
    "tags":[
     "channels",
     "apple-mfb",
     "logs-and-status-reports-apple-mfb"
    ],
    "summary":"Get 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-apple-mfb-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/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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-applic

# --- truncated at 32 KB (192 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infobip/refs/heads/main/openapi/infobip-apple-mfb-openapi.json
Infobip Apple Messages for Business API

Documentation

Specifications

Other Resources

OpenAPI Specification
