All Collections
Integrations
Send SMS over our REST API
Send SMS over our REST API
Updated this week

Our platform offers flexible solutions for your SMS communication needs. Whether you're sending a single message or managing large-scale campaigns, we've got you covered. Here are the ways you can integrate SMS sending functionality into your operations:

Authentication

Authenticate with X-ApiKey in the header

1. Sending Individual SMS Messages

Ideal for personalized, one-off messages, this method allows you to specify the sender, recipient, and message content for each SMS. This approach is best suited for low-volume send-outs due to the manual nature of setting up each message.

Endpoint: https://api.wiraya.com/api/SendMessageFromAlpha/json

Request Body:

{
"sender": "YourSenderName",
"recipient": "RecipientPhoneNumber",
"message": "YourMessageContent"
}

2. Sending Bulk SMS Messages

For higher volume communications, consider creating an SMS project. This method streamlines the process of sending messages to large groups by allowing you to manage contacts in batches.

Step 1: Create an SMS Project

Set up your project with a unique name, sender, and default message content.

Endpoint: https://api.wiraya.com/api/CreateSMSProject/json

Request Body:

{
"sender": "YourSenderName",
"content": "DefaultMessageContent",
"projectname": "YourProjectName"
}

Step 2: Add Contacts to Your SMS Project

Submit contacts in batches (recommended size: ~500 contacts) to your SMS project. This step allows for the addition of internal IDs, facilitating easier tracking and management.

Endpoint: https://api.wiraya.com/api/AddSmsRecipients/json

Request Body:

{
"smsprojectid": "YourProjectID",
"smsrecipients": [
{
"phonenumber": "RecipientPhoneNumber",
"extra columns": ["CustomValue1", "CustomValue2"]
}
]
}

3. Flexible Sending Option

To further ease the process, we offer a pre-created SMS project option. This method provides maximum flexibility, allowing you to customize the SMS text for each contact and choose between individual or batch sends.

Endpoint: https://api.wiraya.com/api/AddSmsRecipients/json

Request Body:

{
"smsprojectid": "PreCreatedProjectID",
"smsrecipients": [
{
"phonenumber": "46737072337",
"extracolumns": ["CustomerID", "CampaignID", "CustomSMSContent"]
},
...
]
}

When responses are received, they will include the customer and campaign IDs, simplifying the task of matching responses with your internal records.

For detailed API documentation and more on communication callbacks, please visit:

Should you have any questions or need further assistance, our support team is here to help.

Did this answer your question?