Endpoint

GET /numbers/{id}/relationships/{callback_type}

Request Parameters

Path Parameters

  • id
    integer required

    The phone number to be associated with the messaging callback URL.

  • callback_type
    string required

    Callback type to be associated with the specified phone number. Allowed values are:

    • sms_callback

      Called for inbound SMS messages (see Receive an SMS).

    • mms_callback

      Called for inbound MMS messages (see Receive an MMS).

    • sms_dlr_callback

      Called for SMS Delivery Receipts (see Receive a DLR).

    • mms_dlr_callback

      Called for inbound MMS Delivery Receipts (see Receive a DLR).

Response Format

On success, the HTTP status code in the response header is 200 OK and the response body contains a detailed callback object for your specified callback_type. On error, the header status code is an error code and the response body contains an array of error objects.
  • data
    object

    Callback object composed of the following:

    • attributes
      object

      Different attributes of a callback object:

      • callback_url string- The callback URL associated with your specified callback_type.

      • product string- Indicates the product associated with your specified callback_type. For example, "dlr" is the product associated with your sms_dlr_callback.

    • type
      string

      This will always be callback.