Create SMS Callback Profiles using Dynamic Variables

You can create an SMS callback profile for the SMS status update in the K.io interface. While creating a callback profile for the SMS channel, the interface also provides a list of SMS related dynamic variables to select for which you want to receive information through the callback. The dynamic variables’ list serves as a ‘ready reckoner’ to add the callback variables without having to know the variable names. For each of the variables selected from the list, the callback will fetch the latest value for the given SMS into your system.

For information on how to use a callback profile in an SMS API request, see: Callback Request using callback profile.

📘

Note:

• If you have multiple callback profiles created for different purposes, make sure you add the appropriate callback profile Id while calling the SMS API requests.
• A callback profile created for the SMS channel cannot be used for other channels.
• Once a callback profile is created for SMS, you can only edit the dynamic variables or delete the profile, but you cannot change the profile to a different channel.

To create an callback profile for receiving updates about SMS status :

1. Navigate to the profile settings drop-down list and select the Callback Profiles option.

   

   The Callback Profiles page appears.

   

2. On the Callback Profiles page, click Add New.
   The Add Callback Profile window appears.

3. Perform the following steps to add all the relevant information in the ‘Add callback profile’ page.
   1. In the Title field, enter a title for the callback profile. This is a mandatory field.
   2. From the Select Channel API list, select the option ‘SMS - callback dynamic variables and types from SMS’ to create a callback profile to be used to receive back updated information about the SMS status.
   3. Once you select the option ‘SMS - callback dynamic variables and types form SMS’ in the previous step, the Events for the selected channel field is automatically set to the option ‘SMS Send’.
   4. In the HTTP Method field, select a method for which the callback is created.
      The options are: POST, GET, PUT, and DELETE. Only POST and GET methods are supported for the SMS channel.
   5. In the Enter Endpoint field, enter the URL at which the callback information should be received.
   6. In the Dynamic Variables field, click View to view and select the dynamic variables for the selected channel. The dynamic variables represent all the possible information that you can retrieve about the SMS as part of the callback that kaleyra.io will send to your system. You may select all of them, or only the fields you are interested in.
      The List Dynamic Variables window appears.

In the List Dynamic Variables window,

• To select all the dynamic variables, click Select All or manually select the dynamic variables check-boxes that you want to receive in the callback sent from Kaleyra to your system.
• After selecting the variables, click Copy to Clipboard.
• Click ‘X’ (CLOSE) on the window to close the window.
• Using the mouse, right click and paste the dynamic variables either in the Request Body field (POST method) or at the end of the Endpoint URL as query parameters (GET method).

4. In the Headers field, enter the key-value pair values to add additional information to be added to the HTTPS request generated from Kaleyra to your system, for example, authentication details.
   Use the +Add more button to add multiple Header fields.

5. Use the Enable Encryption toggle button to enable encryption of the callback information.

6. When you enable this toggle button, the Algorithm, Key, and the Initialization Vector, and Parameters fields appear.

7. Enter values in these fields. To know more about these fields, see: https://developers.kaleyra.io/docs/callback-profiles-in-accountssettings

8. Use the Enable Callback Required Options toggle button to enable the Response Message field and enter a text as the callback response message.

9. To check if the callback profile that you have created is ok, click Test.

10. After filling in all the details, click Save to save the callback profile for the selected channel with the specified dynamic variables.
    Once you save the callback profile on the UI, you can see the callback profile ID that can be used in the SMS API requests to receive updates about the SMS status.

    The following table shows the field descriptions on the Add Callback profile window.

The following table shows the dynamic variables' descriptions with examples.