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 To field, enter the number or numbers to which you want to send message.
- In the Sender ID field, enter the sender ID. Sender ID is required if you are using the base URL for India.
- In the Body field, enter the body of an SMS. If you are using the Template ID's content, then Body is not required.
- In the Type field, enter the route type for your SMS. The supported types are OTP, Transactional (TXN), Transactional DND (TXND), and Marketing (MKT).
- Enter the other required parameter details based on the API type you are using.
- 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.
Notes:
- For more information on how to view the logs from kaleyra.io, see SMS Logs.
- For more information on SMS error codes, see SMS Error Codes.
- For more information on SMS status and status trace codes, see SMS Status and Status Trace Codes.