Kaleyra Reference APIs enable you to test the APIs in real time.
To test the API, perform the following steps:
- In the URL section (right pane), click the arrow next to Base URL and the list of base URLs appears.
- Select the base URL based on your region.
- In the SID field (left pane), enter the SID from your kaleyra.io account. For more information, see View API Key and SID.
- In the channel field, enter the channel name. Currently, only SMS is supported by the Kaleyra platform.
- In the sender_identifier field, enter the inbound sender ID. In case of SMS, it’s the short code for customers. The number to which end-users can send Opt-In/Opt-Out or is this the long/short code about which they want to Opt-In/Opt-Out?
- In the contact_identifier field, enter the contact identifier of the end-user or end-user's mobile number.
- In the source field, enter the source of the consent request or source of opt-in or opt-out. For example, API.
- In the consent_status field, enter the status of consent. For example, OPT_IN or OPT_OUT.
- In the api-key field, enter the API key from your kaleyra.io account. For more information, see View API Key and SID.
- On the Credentials section (top-right pane), in the api-key field, enter the API key from your kaleyra.io account. For more information, see View API Key and SID.
- In the Content-Type field, you can either enter the content type or you can select the default content-type. To select the default content type, click the field and then select the Use example value.
- Click Try It! (right pane). The response appears based on your API request and entered details.