Receive Capability Check result Webhook Early access

Receive data response, requested by Check RCS capability (async). This callback will be invoked once per each phone number with POST method.

post
https://{yourDomain}/your/webhook/path
Request Body schema:
collapse all -
bulkId
required
string

The ID that uniquely identifies the request. This ID is automatically generated and will be included in the API response.

messageId
required
string

A unique message ID. This ID is automatically generated and will be included in the API response.

phoneNumber
required
string

The recipient's phone number that was checked for RCS capability.

code
required
string
Enum: "ENABLED" "UNREACHABLE" "AGENT_NOT_LAUNCHED" "REJECTED_NETWORK" "REJECTED_ROUTE_NOT_AVAILABLE" "REQUEST_FAILED" "INVALID_DESTINATION_ADDRESS" "UNKNOWN_CODE"

The result of the RCS capability check for the specified phone number.

options
object
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.

Responses

200

Your server returns this code if it accepts the callback.

Request samples

Content type
Copy
Collapse all
{
  • "bulkId": "d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8",
  • "messageId": "b5c3bdff-2d44-4f74-8a8e-3792fa57dfc3",
  • "phoneNumber": "441134960001",
  • "code": "ENABLED",
  • "options":
    {
    • "platform":
      {
      • "entityId": "Example entity id",
      • "applicationId": "Example application id"
      }
    }
}

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.