Set up Callback Profile ID
Kalera.io allows you to set up the callback profile ID for Failover.
To set up Callback Profile ID, perform the following steps:
- Follow steps 1 through 5 on how to Create a Callback Profile.
- Based on the selection (GET/POST) method used, you can use the following parameter in the mentioned format.
| HTTP Method | Steps |
|---|---|
| GET | <callback_url_endpoint>?kid=<kid>&failover_id=<failover_id>&config_id=<config_id>&delivered=<delivered>&channel_status_id=<channel_status_id>&channel=<channel>&mobile=<mobile>&email=<email>&status_trace=<status_trace>&channel_priority=<channel_priority>&ref=<ref>&ref1=<ref1>&ref2=<ref2> |
| POST | 1. Select the body type as JSON. 2. Enter the JSON body. {"kid":"<kid>","config_id":"<config_id>","delivered":"<delivered>","channel_status_id":"<channel_status_id>","failover_id":"<failover_id>","channel":"<channel>","mobile":"<mobile>","email":"<email>","channel_priority":"<channel_priority>","status_trace":"<status_trace>", "ref":"<ref>","ref1":"<ref1>","ref2":"<ref2>"} |
Parameters and Data Types
Following is the list of parameters and data types supported. The fields mentioned in the table will be sent in the callbacks.
Note:
Only the fields that are supported in Failover callback (mentioned in the table), value will be replaced and sent to client. If unsupported fields are provided, then the value will not be replaced.
| Parameter | Data Type | Description | Example |
|---|---|---|---|
| kid | String | Unique Kid for each request. It is similar to the ID. | 277a4889-a6be-405f-9e9c-24e21exxxc2e |
| failover_id | String | Unique failover ID for each recipient mentioned in the request. | 277a4889-a6be-405f-9e9c-24e21exxxc2e:0123 |
| config_id | String | Configuration ID used to trigger the request. | abcd4889-a6be-405f-9e9c-24e21exxxc2e |
| delivered | String | Specifies whether the message was delivered to the recipient. Supported values are 0,1, and 2. 0 → Undelivered, 1 → Delivered, and 2 → Sent. | 1 |
| channel_status_id | String | Unique ID of the individual channel under the failover logs. For more information, see logs page. | 1234xxx9-a6be-405f-9e9c-24e21exxxc2e |
| channel | String | The channel through which the message is sent. | SMS |
| mobile | String | The mobile number of the recipient. | +919178XXXXXX |
| String | The email of the recipient. | [email protected] | |
| status_trace | String | Status trace of the message. | SENT |
| channel_priority | String | The priority of the triggered channel. | 1 |
| ref | String | Custom value 1. | abc |
| ref1 | String | Custom value 2. | 123 |
| ref2 | String | Custom value 3. | 123 |
- Click Save. The saved profiles are listed on the Callback Profile page. You can filter the data on the listing page with Callback Profile Name, HTTP Method, and Created Date range for accurate results.
- Copy the Callback Profile ID and use it in the request for getting the callbacks.
Updated 6 months ago