Log inTry for free
Back to all APIs

Receive Apple Messages for Business delivery reports Webhook Early access

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.

Learn more about Apple Messages for Business channel and use cases
post
https://{yourDomain}/your/webhook/path
Request Body schema:
application/json
collapse all -
results
Array of objects

Collection of reports, one per every message.

Array
bulkId
string

Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.

price
object

Sent message price.

pricePerMessage
number

Price per one message.

currency
string

The currency in which the price is expressed.

status
object

Indicates the status of the message and how to recover from an error should there be any.

groupId
integer <int32>

Status group ID.

groupName
string
Enum: "ACCEPTED" "PENDING" "UNDELIVERABLE" "DELIVERED" "EXPIRED" "REJECTED"

Status group name that describes which category the status code belongs to, i.e., PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED.

id
integer <int32>

Status code ID.

name
string

Status code name.

description
string

Human-readable description of the status.

action
string

Action to take to recover from the error.

error
object

Indicates whether an error occurred during the query execution.

groupId
integer <int32>

Error group ID.

groupName
string
Enum: "OK" "HANDSET_ERRORS" "USER_ERRORS" "OPERATOR_ERRORS"

Error group name that describes which category the error code belongs to.

id
integer <int32>

Error ID.

name
string

Error name.

description
string

Human-readable description of the error.

permanent
boolean

Indicates whether the error is recoverable or not.

messageId
string

Unique message ID.

to
string

Message destination address.

sender
string

The sender ID which can be alphanumeric or numeric (e.g., CompanyName).

sentAt
string <date-time>

Date and time when the message was sent. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.

doneAt
string <date-time>

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
integer <int32>

The number of sent messages.

mccMnc
string

Mobile country and network codes.

callbackData
string

Callback data sent through ‛callbackData‛ field when sending message.

platform
object

Platform options. For more details, see documentation.

entityId
string [ 0 .. 255 ] characters

Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation.

applicationId
string [ 0 .. 255 ] characters

Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the documentation.

campaignReferenceId
string

ID of a campaign that was sent in the message.

Responses

200

Your server returns this code if it accepts the callback.

Request 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