View Callback API
View CALLBACK API
On the top menu, click
to view the settings menu. Refer to the following screen.
Figure 1 Settings
2. On the Settings screen, click CALLBACK API to view the CALLBACK API details. Refer to the following screen
Figure 2 Callback API
3. The following CALLBACK API details are displayed on the screen.
Field | Description |
---|---|
Token | Indicates the field where a user can upload (JWT)token. |
Process Id | Indicates the specific and unique ID of the each Process. |
Process Name | Indicates the name of the process as we define it in the backend during process integration with callback and define customer tier id so that based on tier id show the process list to customers. |
Callback URI | Indicates the URI provided by customer. This is relative to the Callback domain. If non provided it should have the "Provide your URI" as a feed back. •maximum URL Length: Must not exceed 2,000 characters. (was 300 chars) •Path Segment Length: Each segment (between slashes /) must be no longer than 255 characters. (was 50 chars) •Scheme Requirement: Only https:// URLs are accepted. •Allowed characters: Only below mentioned special characters are allowed, except these characters, no other special characters are allowed in the URL as we have some security checks and regex validations in place. •dot . •hyphen - •underscore _ •forward slash / •colon : When colon character is used when port number is used in the URL. |
View | Click on View icon to see the sample api call matching the corresponding callback case. |
Configure | Click on Configure icon to edit the Callback URI. |
View of API CALL
To see the API CALL View of the selected, click on
to view icon the quick description of API CAll. Refer to the following screen
Figure 3 View of Callback API
Figure 4 View of URI
4. The following CALLBACK API details are displayed on the screen.
Field | Description |
---|---|
Process Name | Indicates the name of the process as we define it in the backend during process integration with callback and define customer tier id so that based on tier id show the process list to customers. |
Sample Post Request | Indicates the sample API call matching the corresponding callback case. |
Supporting CALLBACK APIs
The following CALLBACK APIs are displayed on the screen.
PROCESS ID | PROCESS NAME | Description |
10010 | P2A SMS | The Callback for sending P2A SMS callback. |
10011 | CallBackNotification | The Callback for sending CallBackNotification callback. |
10012 | Usage Events (Bulk) | The Callback for sending Usage events callback. |
10013 | Mobility Events (Bulk) | The Callback for sending Mobility events callback |
10015 | A2P-SMS Status | The Callback for sending A2P SMS callback. |
10018 | Account Events (Bulk) | The Callback for sending Account events callback |
10017 | Endpoint Events (Bulk) | The Callback for sending Endpoint events callback |