Callback response format

Response body

Callback responses sent by your callback handler must include the following fields:

  • type (string)
    The identifier of the callback response.
    The response identifier must match one of the identifiers defined for this callback.
    Example: cti.a.p.acgw.response.v1.0~vendor.app.read_users_ok.v1.0.
  • request_id (string)
    The UUID of the request that corresponds to this response.
  • response_id (string)
    The UUID of the response.
  • payload (object)
    An object containing the data structure configured for the callback response.
    Optional if not specified.