Log inTry for free
Back to all APIs

Get Apple Messages for Business delivery reports Early access

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.

Learn more about Apple Messages for Business channel and use cases
Please log in to see full path URL. Learn why.
get
/apple-mfb/1/reports
Authorizations:
API Key Header
Basic
IBSSO Token Header
OAuth 2
Scopes:
apple-mfb:manage
apple-mfb:message:send
message:send
query Parameters
bulkId
string

The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.

messageId
string

The ID that uniquely identifies the message sent.

limit
integer <int32> <= 1000
Default: 50
Example: limit=1

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

entityId
string
Example: entityId=promotional-traffic-entity

Entity id used to send the message. For more details, see our documentation.

applicationId
string
Example: applicationId=marketing-automation-application

Application id used to send the message. For more details, see our documentation.

campaignReferenceId
string
Example: campaignReferenceId=summersale

ID of a campaign that was sent in the message.

Responses

200

OK

401

Unauthorized

403

Forbidden

500

Internal Server Error

Request samples

Example
cURL
Copy
curl -L -g 'https://{baseUrl}/apple-mfb/1/reports?limit=1&entityId=promotional-traffic-entity&applicationId=marketing-automation-application&campaignReferenceId=summersale' \
-H 'Authorization: {authorization}' \
-H 'Accept: application/json'

Response samples

Content type
application/json
Copy
 Collapse all
{
  • "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"
        }
      }
    ]
}

Need assistance

Explore Infobip Tutorials

Encountering issues

Contact our support

What's new? Check out

Release Notes

Unsure about a term? See

Glossary

Research panel

Help shape the future of our products
Learn more
Service status

Copyright @ 2006-2025 Infobip ltd.

Privacy documentsTerms of use